@@ -35,6 +35,9 @@ discard block |
||
35 | 35 | public $amp_source_origin = null; |
36 | 36 | |
37 | 37 | /** |
38 | + * @param string $method |
|
39 | + * @param string $url |
|
40 | + * @param string $post_body |
|
38 | 41 | * @return WPCOM_JSON_API instance |
39 | 42 | */ |
40 | 43 | static function init( $method = null, $url = null, $post_body = null ) { |
@@ -348,6 +351,9 @@ discard block |
||
348 | 351 | return call_user_func_array( array( $endpoint, 'callback' ), $path_pieces ); |
349 | 352 | } |
350 | 353 | |
354 | + /** |
|
355 | + * @param integer $status_code |
|
356 | + */ |
|
351 | 357 | function output_early( $status_code, $response = null, $content_type = 'application/json' ) { |
352 | 358 | $exit = $this->exit; |
353 | 359 | $this->exit = false; |
@@ -572,11 +578,18 @@ discard block |
||
572 | 578 | return wp_json_encode( $data ); |
573 | 579 | } |
574 | 580 | |
581 | + /** |
|
582 | + * @param string $needle |
|
583 | + */ |
|
575 | 584 | function ends_with( $haystack, $needle ) { |
576 | 585 | return $needle === substr( $haystack, -strlen( $needle ) ); |
577 | 586 | } |
578 | 587 | |
579 | 588 | // Returns the site's blog_id in the WP.com ecosystem |
589 | + |
|
590 | + /** |
|
591 | + * @return integer |
|
592 | + */ |
|
580 | 593 | function get_blog_id_for_output() { |
581 | 594 | return $this->token_details['blog_id']; |
582 | 595 | } |
@@ -599,6 +612,10 @@ discard block |
||
599 | 612 | } |
600 | 613 | |
601 | 614 | // Returns true if the specified blog ID is a restricted blog |
615 | + |
|
616 | + /** |
|
617 | + * @param integer $blog_id |
|
618 | + */ |
|
602 | 619 | function is_restricted_blog( $blog_id ) { |
603 | 620 | /** |
604 | 621 | * Filters all REST API access and return a 403 unauthorized response for all Restricted blog IDs. |
@@ -648,7 +665,7 @@ discard block |
||
648 | 665 | /** |
649 | 666 | * Counts the number of comments on a site, excluding certain comment types. |
650 | 667 | * |
651 | - * @param $post_id int Post ID. |
|
668 | + * @param integer $post_id int Post ID. |
|
652 | 669 | * @return array Array of counts, matching the output of https://developer.wordpress.org/reference/functions/get_comment_count/. |
653 | 670 | */ |
654 | 671 | public function wp_count_comments( $post_id ) { |
@@ -1540,6 +1540,7 @@ discard block |
||
1540 | 1540 | * timezone set in the options table for the blog or the GMT offset. |
1541 | 1541 | * |
1542 | 1542 | * @param datetime string $date_string Date to parse. |
1543 | + * @param string $date_string |
|
1543 | 1544 | * |
1544 | 1545 | * @return array( $local_time_string, $gmt_time_string ) |
1545 | 1546 | */ |
@@ -1649,6 +1650,10 @@ discard block |
||
1649 | 1650 | do_action( 'restapi_theme_init' ); |
1650 | 1651 | } |
1651 | 1652 | |
1653 | + /** |
|
1654 | + * @param string $from_hook |
|
1655 | + * @param string $to_hook |
|
1656 | + */ |
|
1652 | 1657 | function copy_hooks( $from_hook, $to_hook, $base_paths ) { |
1653 | 1658 | global $wp_filter; |
1654 | 1659 | foreach ( $wp_filter as $hook => $actions ) { |
@@ -2073,7 +2078,7 @@ discard block |
||
2073 | 2078 | * Get an array of all valid AMP origins for a blog's siteurl. |
2074 | 2079 | * |
2075 | 2080 | * @param string $siteurl Origin url of the API request. |
2076 | - * @return array |
|
2081 | + * @return string[] |
|
2077 | 2082 | */ |
2078 | 2083 | public function get_amp_cache_origins( $siteurl ) { |
2079 | 2084 | $host = parse_url( $siteurl, PHP_URL_HOST ); |