@@ -185,6 +185,7 @@ |
||
185 | 185 | * @since 1.3 |
186 | 186 | * @uses current_user_can() to test if current user has edit_posts capability |
187 | 187 | * @var WP_Error $error WordPress error |
188 | + * @param VideoPress_Video $error |
|
188 | 189 | * @return string HTML string |
189 | 190 | */ |
190 | 191 | private function error_message( $error ) { |
@@ -271,7 +271,7 @@ |
||
271 | 271 | * |
272 | 272 | * @since 1.2 |
273 | 273 | * @param string $url absolute URL |
274 | - * @return bool|string host component of the URL, or false if none found |
|
274 | + * @return string|false host component of the URL, or false if none found |
|
275 | 275 | */ |
276 | 276 | public static function hostname( $url ) { |
277 | 277 | return parse_url( esc_url_raw( $url ), PHP_URL_HOST ); |
@@ -147,6 +147,7 @@ discard block |
||
147 | 147 | * Performs a remote XML-RPC query using Jetpack's IXR Client. And also |
148 | 148 | * appends some useful stuff about this setup to the query. |
149 | 149 | * |
150 | + * @param string $method |
|
150 | 151 | * @return the Jetpack_IXR_Client object after querying. |
151 | 152 | */ |
152 | 153 | function query( $method, $args = null ) { |
@@ -349,6 +350,7 @@ discard block |
||
349 | 350 | * |
350 | 351 | * Similar to current_user_can, but internal to VideoPress. Returns |
351 | 352 | * true if the given VideoPress capability is allowed by the given user. |
353 | + * @param string $cap |
|
352 | 354 | */ |
353 | 355 | function can( $cap, $user_id = false ) { |
354 | 356 | if ( ! $user_id ) |
@@ -252,6 +252,9 @@ |
||
252 | 252 | return ( FALSE !== strpos( $url, 'facebook.com' ) ) ? TRUE : FALSE; |
253 | 253 | } |
254 | 254 | |
255 | + /** |
|
256 | + * @param integer $value |
|
257 | + */ |
|
255 | 258 | function normalize_int_value( $value, $default = 0, $max = 0, $min = 0 ) { |
256 | 259 | $value = (int) $value; |
257 | 260 |
@@ -89,6 +89,9 @@ |
||
89 | 89 | do_action( 'jetpack_stats_extra', 'widget', 'goodreads' ); |
90 | 90 | } |
91 | 91 | |
92 | + /** |
|
93 | + * @param string $user_id |
|
94 | + */ |
|
92 | 95 | function goodreads_user_id_exists( $user_id ) { |
93 | 96 | $url = "http://www.goodreads.com/user/show/$user_id/"; |
94 | 97 | $response = wp_remote_head( $url, array( 'httpversion'=>'1.1', 'timeout'=>3, 'redirection'=> 2 ) ); |
@@ -28,6 +28,11 @@ discard block |
||
28 | 28 | |
29 | 29 | // /sites/%s/posts/new -> $blog_id |
30 | 30 | // /sites/%s/posts/%d -> $blog_id, $post_id |
31 | + |
|
32 | + /** |
|
33 | + * @param string $path |
|
34 | + * @param integer $post_id |
|
35 | + */ |
|
31 | 36 | function write_post( $path, $blog_id, $post_id ) { |
32 | 37 | $new = $this->api->ends_with( $path, '/new' ); |
33 | 38 | $args = $this->query_args(); |
@@ -621,6 +626,11 @@ discard block |
||
621 | 626 | } |
622 | 627 | |
623 | 628 | // /sites/%s/posts/%d/delete -> $blog_id, $post_id |
629 | + |
|
630 | + /** |
|
631 | + * @param string $path |
|
632 | + * @param integer $post_id |
|
633 | + */ |
|
624 | 634 | function delete_post( $path, $blog_id, $post_id ) { |
625 | 635 | $post = get_post( $post_id ); |
626 | 636 | if ( !$post || is_wp_error( $post ) ) { |
@@ -656,6 +666,11 @@ discard block |
||
656 | 666 | } |
657 | 667 | |
658 | 668 | // /sites/%s/posts/%d/restore -> $blog_id, $post_id |
669 | + |
|
670 | + /** |
|
671 | + * @param string $path |
|
672 | + * @param integer $post_id |
|
673 | + */ |
|
659 | 674 | function restore_post( $path, $blog_id, $post_id ) { |
660 | 675 | $args = $this->query_args(); |
661 | 676 | $post = get_post( $post_id ); |
@@ -676,6 +691,10 @@ discard block |
||
676 | 691 | return $this->get_post_by( 'ID', $post->ID, $args['context'] ); |
677 | 692 | } |
678 | 693 | |
694 | + /** |
|
695 | + * @param boolean $delete_featured_image |
|
696 | + * @param string $featured_image |
|
697 | + */ |
|
679 | 698 | protected function parse_and_set_featured_image( $post_id, $delete_featured_image, $featured_image ) { |
680 | 699 | if ( $delete_featured_image ) { |
681 | 700 | delete_post_thumbnail( $post_id ); |
@@ -616,6 +616,9 @@ |
||
616 | 616 | return strcasecmp( $a->name, $b->name ); |
617 | 617 | } |
618 | 618 | |
619 | + /** |
|
620 | + * @return string |
|
621 | + */ |
|
619 | 622 | public static function maybe_get_split_term( $old_term_id = '', $taxonomy = '' ) { |
620 | 623 | $term_id = $old_term_id; |
621 | 624 |
@@ -115,7 +115,7 @@ discard block |
||
115 | 115 | /** |
116 | 116 | * Iterates through expected items ( plugins or themes ) and compares them to actual results. |
117 | 117 | * |
118 | - * @param $items 'plugin' or 'theme' |
|
118 | + * @param string $items 'plugin' or 'theme' |
|
119 | 119 | */ |
120 | 120 | function log_items( $items ) { |
121 | 121 | $num_items_updated = 0; |
@@ -194,7 +194,7 @@ discard block |
||
194 | 194 | * @param $item Example: 'jetpack/jetpack.php' for type 'plugin' or 'twentyfifteen' for type 'theme' |
195 | 195 | * @param string $type 'plugin' or 'theme' |
196 | 196 | * |
197 | - * @return bool|string |
|
197 | + * @return false|string |
|
198 | 198 | */ |
199 | 199 | private function get_error_message( $item, $type = 'plugin' ) { |
200 | 200 | if ( ! isset( $this->autoupdate_results[ $type ] ) ) { |
@@ -64,7 +64,6 @@ discard block |
||
64 | 64 | |
65 | 65 | /** |
66 | 66 | * @param string $file __FILE__ |
67 | - * @param string $option, Option name to sync |
|
68 | 67 | * @param string $option ... |
69 | 68 | */ |
70 | 69 | static function sync_options( $file, $option /*, $option, ... */ ) { |
@@ -75,8 +74,6 @@ discard block |
||
75 | 74 | } |
76 | 75 | /** |
77 | 76 | * @param string $file __FILE__ |
78 | - * @param string $option, Option name to sync |
|
79 | - * @param string $option ... |
|
80 | 77 | */ |
81 | 78 | static function sync_constant( $file, $constant ) { |
82 | 79 | if ( is_network_admin() ) return; |
@@ -352,6 +349,9 @@ discard block |
||
352 | 349 | $this->transition_post_status_action( 'delete', $post->post_status, $post ); |
353 | 350 | } |
354 | 351 | |
352 | + /** |
|
353 | + * @param string $new_status |
|
354 | + */ |
|
355 | 355 | function transition_post_status_action( $new_status, $old_status, $post ) { |
356 | 356 | $sync = $this->get_post_sync_operation( $new_status, $old_status, $post, $this->sync_conditions['posts'] ); |
357 | 357 | if ( !$sync ) { |
@@ -736,6 +736,11 @@ discard block |
||
736 | 736 | /* Options Sync */ |
737 | 737 | |
738 | 738 | /* Ah... so much simpler than Posts and Comments :) */ |
739 | + |
|
740 | + /** |
|
741 | + * @param string $file |
|
742 | + * @param string $option |
|
743 | + */ |
|
739 | 744 | function options( $file, $option /*, $option, ... */ ) { |
740 | 745 | $options = func_get_args(); |
741 | 746 | $file = array_shift( $options ); |