@@ -9,6 +9,11 @@ discard block |
||
9 | 9 | public $link; |
10 | 10 | public $grayscale; |
11 | 11 | public $columns; |
12 | + |
|
13 | + /** |
|
14 | + * @param boolean $grayscale |
|
15 | + * @param integer $columns |
|
16 | + */ |
|
12 | 17 | public function __construct( $attachments, $link, $grayscale, $columns ) { |
13 | 18 | |
14 | 19 | $this->attachments = $attachments; |
@@ -33,6 +38,9 @@ discard block |
||
33 | 38 | return $html; |
34 | 39 | } |
35 | 40 | |
41 | + /** |
|
42 | + * @param string $name |
|
43 | + */ |
|
36 | 44 | private function template( $name, $context = null ) { |
37 | 45 | if ( ! in_array( $name, self::$templates ) ) { |
38 | 46 | return; |
@@ -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 |
@@ -393,7 +393,7 @@ discard block |
||
393 | 393 | * Our [portfolio] shortcode. |
394 | 394 | * Prints Portfolio data styled to look good on *any* theme. |
395 | 395 | * |
396 | - * @return portfolio_shortcode_html |
|
396 | + * @return string |
|
397 | 397 | */ |
398 | 398 | static function portfolio_shortcode( $atts ) { |
399 | 399 | // Default attributes |
@@ -526,7 +526,7 @@ discard block |
||
526 | 526 | * The Portfolio shortcode loop. |
527 | 527 | * |
528 | 528 | * @todo add theme color styles |
529 | - * @return html |
|
529 | + * @return string |
|
530 | 530 | */ |
531 | 531 | static function portfolio_shortcode_html( $atts ) { |
532 | 532 | |
@@ -618,6 +618,7 @@ discard block |
||
618 | 618 | /** |
619 | 619 | * Individual project class |
620 | 620 | * |
621 | + * @param integer $portfolio_index_number |
|
621 | 622 | * @return string |
622 | 623 | */ |
623 | 624 | static function get_project_class( $portfolio_index_number, $columns ) { |
@@ -725,7 +726,7 @@ discard block |
||
725 | 726 | /** |
726 | 727 | * Displays the author of the current portfolio project. |
727 | 728 | * |
728 | - * @return html |
|
729 | + * @return string |
|
729 | 730 | */ |
730 | 731 | static function get_project_author() { |
731 | 732 | $html = '<div class="project-author"><span>' . esc_html__( 'Author:', 'jetpack' ) . '</span> '; |
@@ -738,7 +739,7 @@ discard block |
||
738 | 739 | /** |
739 | 740 | * Display the featured image if it's available |
740 | 741 | * |
741 | - * @return html |
|
742 | + * @return string|null |
|
742 | 743 | */ |
743 | 744 | static function get_portfolio_thumbnail_link( $post_id ) { |
744 | 745 | if ( has_post_thumbnail( $post_id ) ) { |