@@ -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(); |
@@ -610,6 +615,11 @@ discard block |
||
610 | 615 | } |
611 | 616 | |
612 | 617 | // /sites/%s/posts/%d/delete -> $blog_id, $post_id |
618 | + |
|
619 | + /** |
|
620 | + * @param string $path |
|
621 | + * @param integer $post_id |
|
622 | + */ |
|
613 | 623 | function delete_post( $path, $blog_id, $post_id ) { |
614 | 624 | $post = get_post( $post_id ); |
615 | 625 | if ( !$post || is_wp_error( $post ) ) { |
@@ -645,6 +655,11 @@ discard block |
||
645 | 655 | } |
646 | 656 | |
647 | 657 | // /sites/%s/posts/%d/restore -> $blog_id, $post_id |
658 | + |
|
659 | + /** |
|
660 | + * @param string $path |
|
661 | + * @param integer $post_id |
|
662 | + */ |
|
648 | 663 | function restore_post( $path, $blog_id, $post_id ) { |
649 | 664 | $args = $this->query_args(); |
650 | 665 | $post = get_post( $post_id ); |
@@ -665,6 +680,10 @@ discard block |
||
665 | 680 | return $this->get_post_by( 'ID', $post->ID, $args['context'] ); |
666 | 681 | } |
667 | 682 | |
683 | + /** |
|
684 | + * @param boolean $delete_featured_image |
|
685 | + * @param string $featured_image |
|
686 | + */ |
|
668 | 687 | private function parse_and_set_featured_image( $post_id, $delete_featured_image, $featured_image ) { |
669 | 688 | if ( $delete_featured_image ) { |
670 | 689 | delete_post_thumbnail( $post_id ); |
@@ -283,6 +283,11 @@ discard block |
||
283 | 283 | ) ); |
284 | 284 | } |
285 | 285 | |
286 | + /** |
|
287 | + * @param string $path |
|
288 | + * @param string $classname |
|
289 | + * @param Jetpack_IXR_Client $constructor_arguments |
|
290 | + */ |
|
286 | 291 | public static function route( $path, $classname, $method, |
287 | 292 | $constructor_arguments = NULL, |
288 | 293 | $endpoint_arguments = NULL |
@@ -1980,7 +1985,7 @@ discard block |
||
1980 | 1985 | * |
1981 | 1986 | * @param string $route Regular expression for the endpoint with the module slug to return. |
1982 | 1987 | * |
1983 | - * @return array |
|
1988 | + * @return string |
|
1984 | 1989 | */ |
1985 | 1990 | public static function get_module_requested( $route = '/module/(?P<slug>[a-z\-]+)' ) { |
1986 | 1991 | |
@@ -2005,7 +2010,7 @@ discard block |
||
2005 | 2010 | * @param string $modules Can be a single module or a list of modules. |
2006 | 2011 | * @param null|string $slug Slug of the module in the first parameter. |
2007 | 2012 | * |
2008 | - * @return array |
|
2013 | + * @return string |
|
2009 | 2014 | */ |
2010 | 2015 | public static function prepare_modules_for_response( $modules = '', $slug = null ) { |
2011 | 2016 | if ( get_option( 'permalink_structure' ) ) { |
@@ -163,7 +163,7 @@ |
||
163 | 163 | /** |
164 | 164 | * Iterates through expected items ( plugins or themes ) and compares them to actual results. |
165 | 165 | * |
166 | - * @param $items 'plugin' or 'theme' |
|
166 | + * @param string $items 'plugin' or 'theme' |
|
167 | 167 | */ |
168 | 168 | private function log_items( $items ) { |
169 | 169 | if ( ! isset( $this->expected[ $items ] ) ) { |
@@ -64,6 +64,7 @@ |
||
64 | 64 | /** |
65 | 65 | * Updates user data |
66 | 66 | * |
67 | + * @param integer $user_id |
|
67 | 68 | * @return (array) |
68 | 69 | */ |
69 | 70 | public function update_user( $user_id, $blog_id ) { |
@@ -227,6 +227,9 @@ |
||
227 | 227 | ); |
228 | 228 | } |
229 | 229 | |
230 | + /** |
|
231 | + * @param Jetpack_Sync_Queue $queue |
|
232 | + */ |
|
230 | 233 | protected function get_buffer( $queue, $number_of_items ) { |
231 | 234 | $start = time(); |
232 | 235 | $max_duration = 5; // this will try to get the buffer |
@@ -1387,7 +1387,6 @@ discard block |
||
1387 | 1387 | * |
1388 | 1388 | * @see ::style() |
1389 | 1389 | * @internal |
1390 | - * @param bool $style |
|
1391 | 1390 | */ |
1392 | 1391 | static function _style_on() { |
1393 | 1392 | return self::style( true ); |
@@ -1526,6 +1525,7 @@ discard block |
||
1526 | 1525 | * |
1527 | 1526 | * @param int $feedback_id |
1528 | 1527 | * @param object Grunion_Contact_Form $form |
1528 | + * @param Grunion_Contact_Form $form |
|
1529 | 1529 | * |
1530 | 1530 | * @return string $message |
1531 | 1531 | */ |
@@ -1630,7 +1630,7 @@ discard block |
||
1630 | 1630 | * |
1631 | 1631 | * @param array $attributes Key => Value pairs as parsed by shortcode_parse_atts() |
1632 | 1632 | * @param string|null $content The shortcode's inner content: [contact-field]$content[/contact-field] |
1633 | - * @return HTML for the contact form field |
|
1633 | + * @return string for the contact form field |
|
1634 | 1634 | */ |
1635 | 1635 | static function parse_contact_field( $attributes, $content ) { |
1636 | 1636 | // Don't try to parse contact form fields if not inside a contact form |
@@ -488,7 +488,7 @@ discard block |
||
488 | 488 | * Our [portfolio] shortcode. |
489 | 489 | * Prints Portfolio data styled to look good on *any* theme. |
490 | 490 | * |
491 | - * @return portfolio_shortcode_html |
|
491 | + * @return string |
|
492 | 492 | */ |
493 | 493 | static function portfolio_shortcode( $atts ) { |
494 | 494 | // Default attributes |
@@ -621,7 +621,7 @@ discard block |
||
621 | 621 | * The Portfolio shortcode loop. |
622 | 622 | * |
623 | 623 | * @todo add theme color styles |
624 | - * @return html |
|
624 | + * @return string |
|
625 | 625 | */ |
626 | 626 | static function portfolio_shortcode_html( $atts ) { |
627 | 627 | |
@@ -713,6 +713,7 @@ discard block |
||
713 | 713 | /** |
714 | 714 | * Individual project class |
715 | 715 | * |
716 | + * @param integer $portfolio_index_number |
|
716 | 717 | * @return string |
717 | 718 | */ |
718 | 719 | static function get_project_class( $portfolio_index_number, $columns ) { |
@@ -820,7 +821,7 @@ discard block |
||
820 | 821 | /** |
821 | 822 | * Displays the author of the current portfolio project. |
822 | 823 | * |
823 | - * @return html |
|
824 | + * @return string |
|
824 | 825 | */ |
825 | 826 | static function get_project_author() { |
826 | 827 | $html = '<div class="project-author">'; |
@@ -837,7 +838,7 @@ discard block |
||
837 | 838 | /** |
838 | 839 | * Display the featured image if it's available |
839 | 840 | * |
840 | - * @return html |
|
841 | + * @return string|null |
|
841 | 842 | */ |
842 | 843 | static function get_portfolio_thumbnail_link( $post_id ) { |
843 | 844 | if ( has_post_thumbnail( $post_id ) ) { |
@@ -525,7 +525,7 @@ discard block |
||
525 | 525 | * Our [testimonial] shortcode. |
526 | 526 | * Prints Testimonial data styled to look good on *any* theme. |
527 | 527 | * |
528 | - * @return jetpack_testimonial_shortcode_html |
|
528 | + * @return string |
|
529 | 529 | */ |
530 | 530 | static function jetpack_testimonial_shortcode( $atts ) { |
531 | 531 | // Default attributes |
@@ -588,7 +588,7 @@ discard block |
||
588 | 588 | /** |
589 | 589 | * The Testimonial shortcode loop. |
590 | 590 | * |
591 | - * @return html |
|
591 | + * @return string |
|
592 | 592 | */ |
593 | 593 | static function jetpack_testimonial_shortcode_html( $atts ) { |
594 | 594 | // Default query arguments |
@@ -662,6 +662,7 @@ discard block |
||
662 | 662 | /** |
663 | 663 | * Individual testimonial class |
664 | 664 | * |
665 | + * @param integer $testimonial_index_number |
|
665 | 666 | * @return string |
666 | 667 | */ |
667 | 668 | static function get_testimonial_class( $testimonial_index_number, $columns, $image ) { |
@@ -708,7 +709,7 @@ discard block |
||
708 | 709 | /** |
709 | 710 | * Display the featured image if it's available |
710 | 711 | * |
711 | - * @return html |
|
712 | + * @return string|null |
|
712 | 713 | */ |
713 | 714 | static function get_testimonial_thumbnail_link( $post_id ) { |
714 | 715 | if ( has_post_thumbnail( $post_id ) ) { |
@@ -10,7 +10,7 @@ |
||
10 | 10 | * |
11 | 11 | * @access public |
12 | 12 | * @param string $older_than (default: '1 hour') Older Than. |
13 | - * @return void |
|
13 | + * @return false|null |
|
14 | 14 | */ |
15 | 15 | function jp_purge_transients( $older_than = '1 hour' ) { |
16 | 16 | global $wpdb; |