@@ -166,6 +166,7 @@ discard block |
||
166 | 166 | /** |
167 | 167 | * Get attachment images for a specified post and return them. Also make sure |
168 | 168 | * their dimensions are at or above a required minimum. |
169 | + * @param integer $post_id |
|
169 | 170 | */ |
170 | 171 | static function from_attachment( $post_id, $width = 200, $height = 200 ) { |
171 | 172 | $images = array(); |
@@ -232,7 +233,7 @@ discard block |
||
232 | 233 | * format to the other images?_from_*() methods. |
233 | 234 | * |
234 | 235 | * @param int $post_id The post ID to check |
235 | - * @return Array containing details of the Featured Image, or empty array if none. |
|
236 | + * @return integer|null containing details of the Featured Image, or empty array if none. |
|
236 | 237 | */ |
237 | 238 | static function from_thumbnail( $post_id, $width = 200, $height = 200 ) { |
238 | 239 | $images = array(); |
@@ -687,7 +688,6 @@ discard block |
||
687 | 688 | * resized and cropped image. |
688 | 689 | * |
689 | 690 | * @param string $src |
690 | - * @param int $dimension |
|
691 | 691 | * @return string Transformed image URL |
692 | 692 | */ |
693 | 693 | static function fit_image_url( $src, $width, $height ) { |
@@ -1534,6 +1534,7 @@ discard block |
||
1534 | 1534 | * timezone set in the options table for the blog or the GMT offset. |
1535 | 1535 | * |
1536 | 1536 | * @param datetime string $date_string Date to parse. |
1537 | + * @param string $date_string |
|
1537 | 1538 | * |
1538 | 1539 | * @return array( $local_time_string, $gmt_time_string ) |
1539 | 1540 | */ |
@@ -1643,6 +1644,10 @@ discard block |
||
1643 | 1644 | do_action( 'restapi_theme_init' ); |
1644 | 1645 | } |
1645 | 1646 | |
1647 | + /** |
|
1648 | + * @param string $from_hook |
|
1649 | + * @param string $to_hook |
|
1650 | + */ |
|
1646 | 1651 | function copy_hooks( $from_hook, $to_hook, $base_paths ) { |
1647 | 1652 | global $wp_filter; |
1648 | 1653 | foreach ( $wp_filter as $hook => $actions ) { |
@@ -380,7 +380,7 @@ |
||
380 | 380 | * |
381 | 381 | * @param string $option Option value from the site. |
382 | 382 | * @param callable $url_function Function retrieving the URL to normalize. |
383 | - * @return mixed|string URL. |
|
383 | + * @return callable URL. |
|
384 | 384 | */ |
385 | 385 | public static function normalize_www_in_url( $option, $url_function ) { |
386 | 386 | $url = wp_parse_url( call_user_func( $url_function ) ); |
@@ -15,6 +15,9 @@ |
||
15 | 15 | public $line; |
16 | 16 | public $func_name; |
17 | 17 | |
18 | + /** |
|
19 | + * @param string $func_name |
|
20 | + */ |
|
18 | 21 | public function __construct( $path, $line, $func_name ) { |
19 | 22 | $this->path = $path; |
20 | 23 | $this->line = $line; |
@@ -11,6 +11,10 @@ |
||
11 | 11 | public $message; |
12 | 12 | public $old_declaration; |
13 | 13 | |
14 | + /** |
|
15 | + * @param string $type |
|
16 | + * @param string $message |
|
17 | + */ |
|
14 | 18 | function __construct( $type, $path, $line, $message, $old_declaration ) { |
15 | 19 | $this->type = $type; |
16 | 20 | $this->path = $path; |
@@ -149,6 +149,9 @@ discard block |
||
149 | 149 | |
150 | 150 | /** |
151 | 151 | * Helper function for Jetpack_Color::fromHsl() |
152 | + * @param double $p |
|
153 | + * @param double $q |
|
154 | + * @param integer $t |
|
152 | 155 | */ |
153 | 156 | private function hue2rgb( $p, $q, $t ) { |
154 | 157 | if ( $t < 0 ) $t += 1; |
@@ -498,7 +501,7 @@ discard block |
||
498 | 501 | * |
499 | 502 | * @param Jetpack_Color $color |
500 | 503 | * |
501 | - * @return int |
|
504 | + * @return double |
|
502 | 505 | */ |
503 | 506 | public function getDistanceRgbFrom(Jetpack_Color $color) |
504 | 507 | { |
@@ -687,6 +690,9 @@ discard block |
||
687 | 690 | return $this->incrementLightness( $amount ); |
688 | 691 | } |
689 | 692 | |
693 | + /** |
|
694 | + * @param integer $amount |
|
695 | + */ |
|
690 | 696 | public function incrementLightness( $amount ) { |
691 | 697 | $hsl = $this->toHsl(); |
692 | 698 | extract( $hsl ); |
@@ -704,6 +710,9 @@ discard block |
||
704 | 710 | return $this->incrementSaturation( - $amount ); |
705 | 711 | } |
706 | 712 | |
713 | + /** |
|
714 | + * @param integer $amount |
|
715 | + */ |
|
707 | 716 | public function incrementSaturation( $amount ) { |
708 | 717 | $hsl = $this->toHsl(); |
709 | 718 | extract( $hsl ); |
@@ -744,6 +753,9 @@ discard block |
||
744 | 753 | return $this->incrementHue( $incr ); |
745 | 754 | } |
746 | 755 | |
756 | + /** |
|
757 | + * @param integer $amount |
|
758 | + */ |
|
747 | 759 | public function incrementHue( $amount ) { |
748 | 760 | $hsl = $this->toHsl(); |
749 | 761 | extract( $hsl ); |
@@ -30,6 +30,7 @@ discard block |
||
30 | 30 | * Used to construct meta links in API responses |
31 | 31 | * |
32 | 32 | * @param mixed ...$args Optional arguments to be appended to URL |
33 | + * @param string $args |
|
33 | 34 | * @return string Endpoint URL |
34 | 35 | **/ |
35 | 36 | function get_link( ...$args ) { |
@@ -128,7 +129,7 @@ discard block |
||
128 | 129 | * This method is used in get_link() to construct meta links for API responses. |
129 | 130 | * |
130 | 131 | * @param $template_path string The generic endpoint path, e.g. /sites/%s |
131 | - * @param $path string The current endpoint path, relative to the version, e.g. /sites/12345 |
|
132 | + * @param string $path string The current endpoint path, relative to the version, e.g. /sites/12345 |
|
132 | 133 | * @param $request_method string Request method used to access the endpoint path |
133 | 134 | * @return string The current version, or otherwise the maximum version available |
134 | 135 | */ |
@@ -271,6 +271,9 @@ discard block |
||
271 | 271 | } |
272 | 272 | } |
273 | 273 | |
274 | + /** |
|
275 | + * @param string $type |
|
276 | + */ |
|
274 | 277 | static function get_video_poster( $type, $id ) { |
275 | 278 | if ( 'videopress' == $type ) { |
276 | 279 | if ( function_exists( 'video_get_highest_resolution_image_url' ) ) { |
@@ -356,6 +359,9 @@ discard block |
||
356 | 359 | return (int) count( self::split_content_in_words( self::clean_text( $post_content ) ) ); |
357 | 360 | } |
358 | 361 | |
362 | + /** |
|
363 | + * @param string $excerpt_content |
|
364 | + */ |
|
359 | 365 | static function get_word_remaining_count( $post_content, $excerpt_content ) { |
360 | 366 | $content_word_count = count( self::split_content_in_words( self::clean_text( $post_content ) ) ); |
361 | 367 | $excerpt_word_count = count( self::split_content_in_words( self::clean_text( $excerpt_content ) ) ); |
@@ -52,7 +52,7 @@ |
||
52 | 52 | /** |
53 | 53 | * Record an event. |
54 | 54 | * |
55 | - * @param mixed $event Event object to send to Tracks. An array will be cast to object. Required. |
|
55 | + * @param Jetpack_Tracks_Event $event Event object to send to Tracks. An array will be cast to object. Required. |
|
56 | 56 | * Properties are included directly in the pixel query string after light validation. |
57 | 57 | * @return mixed True on success, WP_Error on failure |
58 | 58 | */ |