Automattic /
jetpack
@@ -750,7 +750,7 @@ discard block |
||
| 750 | 750 | * This is ported over from the manage module, which has been deprecated and baked in here. |
| 751 | 751 | * |
| 752 | 752 | * @param $domains |
| 753 | - * @return array |
|
| 753 | + * @return string[] |
|
| 754 | 754 | */ |
| 755 | 755 | function allow_wpcom_domain( $domains ) { |
| 756 | 756 | if ( empty( $domains ) ) { |
@@ -1208,7 +1208,7 @@ discard block |
||
| 1208 | 1208 | } |
| 1209 | 1209 | /** |
| 1210 | 1210 | * Does the network allow admins to add new users. |
| 1211 | - * @return boolian |
|
| 1211 | + * @return boolean |
|
| 1212 | 1212 | */ |
| 1213 | 1213 | static function network_add_new_users( $option = null ) { |
| 1214 | 1214 | return (bool) get_site_option( 'add_new_users' ); |
@@ -1313,7 +1313,7 @@ discard block |
||
| 1313 | 1313 | * database which could be set to anything as opposed to what this function returns. |
| 1314 | 1314 | * @param bool $option |
| 1315 | 1315 | * |
| 1316 | - * @return boolean |
|
| 1316 | + * @return string |
|
| 1317 | 1317 | */ |
| 1318 | 1318 | public function is_main_network_option( $option ) { |
| 1319 | 1319 | // return '1' or '' |
@@ -1324,7 +1324,7 @@ discard block |
||
| 1324 | 1324 | * Return true if we are with multi-site or multi-network false if we are dealing with single site. |
| 1325 | 1325 | * |
| 1326 | 1326 | * @param string $option |
| 1327 | - * @return boolean |
|
| 1327 | + * @return string |
|
| 1328 | 1328 | */ |
| 1329 | 1329 | public function is_multisite( $option ) { |
| 1330 | 1330 | return (string) (bool) is_multisite(); |
@@ -1386,7 +1386,7 @@ discard block |
||
| 1386 | 1386 | |
| 1387 | 1387 | /** |
| 1388 | 1388 | * Returns true if the site has file write access false otherwise. |
| 1389 | - * @return string ( '1' | '0' ) |
|
| 1389 | + * @return integer ( '1' | '0' ) |
|
| 1390 | 1390 | **/ |
| 1391 | 1391 | public static function file_system_write_access() { |
| 1392 | 1392 | if ( ! function_exists( 'get_filesystem_method' ) ) { |
@@ -2114,6 +2114,7 @@ discard block |
||
| 2114 | 2114 | * @param int $user_id |
| 2115 | 2115 | * @param string $token |
| 2116 | 2116 | * return bool |
| 2117 | + * @param boolean $is_master_user |
|
| 2117 | 2118 | */ |
| 2118 | 2119 | public static function update_user_token( $user_id, $token, $is_master_user ) { |
| 2119 | 2120 | // not designed for concurrent updates |
@@ -2558,7 +2559,7 @@ discard block |
||
| 2558 | 2559 | * |
| 2559 | 2560 | * @param string $tag Tag as it appears in each module heading. |
| 2560 | 2561 | * |
| 2561 | - * @return mixed |
|
| 2562 | + * @return string |
|
| 2562 | 2563 | */ |
| 2563 | 2564 | public static function translate_module_tag( $tag ) { |
| 2564 | 2565 | return jetpack_get_module_i18n_tag( $tag ); |
@@ -2730,8 +2731,8 @@ discard block |
||
| 2730 | 2731 | * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR |
| 2731 | 2732 | * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR. |
| 2732 | 2733 | * |
| 2733 | - * @param $string |
|
| 2734 | - * @return mixed |
|
| 2734 | + * @param string $string |
|
| 2735 | + * @return string|null |
|
| 2735 | 2736 | */ |
| 2736 | 2737 | public static function alias_directories( $string ) { |
| 2737 | 2738 | // ABSPATH has a trailing slash. |
@@ -2991,6 +2992,9 @@ discard block |
||
| 2991 | 2992 | return self::update_active_modules( $new ); |
| 2992 | 2993 | } |
| 2993 | 2994 | |
| 2995 | + /** |
|
| 2996 | + * @param string $module |
|
| 2997 | + */ |
|
| 2994 | 2998 | public static function enable_module_configurable( $module ) { |
| 2995 | 2999 | $module = Jetpack::get_module_slug( $module ); |
| 2996 | 3000 | add_filter( 'jetpack_module_configurable_' . $module, '__return_true' ); |
@@ -3019,6 +3023,9 @@ discard block |
||
| 3019 | 3023 | } |
| 3020 | 3024 | |
| 3021 | 3025 | /* Installation */ |
| 3026 | + /** |
|
| 3027 | + * @param string $message |
|
| 3028 | + */ |
|
| 3022 | 3029 | public static function bail_on_activation( $message, $deactivate = true ) { |
| 3023 | 3030 | ?> |
| 3024 | 3031 | <!doctype html> |
@@ -3755,7 +3762,7 @@ discard block |
||
| 3755 | 3762 | * Add help to the Jetpack page |
| 3756 | 3763 | * |
| 3757 | 3764 | * @since Jetpack (1.2.3) |
| 3758 | - * @return false if not the Jetpack page |
|
| 3765 | + * @return false|null if not the Jetpack page |
|
| 3759 | 3766 | */ |
| 3760 | 3767 | function admin_help() { |
| 3761 | 3768 | $current_screen = get_current_screen(); |
@@ -4618,6 +4625,9 @@ discard block |
||
| 4618 | 4625 | return $url; |
| 4619 | 4626 | } |
| 4620 | 4627 | |
| 4628 | + /** |
|
| 4629 | + * @return string |
|
| 4630 | + */ |
|
| 4621 | 4631 | public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) { |
| 4622 | 4632 | $actionurl = str_replace( '&', '&', $actionurl ); |
| 4623 | 4633 | return add_query_arg( $name, wp_create_nonce( $action ), $actionurl ); |
@@ -4921,6 +4931,7 @@ discard block |
||
| 4921 | 4931 | * Note these tokens are unique per call, NOT static per site for connecting. |
| 4922 | 4932 | * |
| 4923 | 4933 | * @since 2.6 |
| 4934 | + * @param string $action |
|
| 4924 | 4935 | * @return array |
| 4925 | 4936 | */ |
| 4926 | 4937 | public static function generate_secrets( $action, $user_id = false, $exp = 600 ) { |
@@ -5210,7 +5221,6 @@ discard block |
||
| 5210 | 5221 | /** |
| 5211 | 5222 | * Report authentication status to the WP REST API. |
| 5212 | 5223 | * |
| 5213 | - * @param WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not |
|
| 5214 | 5224 | * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication} |
| 5215 | 5225 | */ |
| 5216 | 5226 | public function wp_rest_authentication_errors( $value ) { |
@@ -5312,6 +5322,7 @@ discard block |
||
| 5312 | 5322 | * @param string $key |
| 5313 | 5323 | * @param string $value |
| 5314 | 5324 | * @param bool $restate private |
| 5325 | + * @return string |
|
| 5315 | 5326 | */ |
| 5316 | 5327 | public static function state( $key = null, $value = null, $restate = false ) { |
| 5317 | 5328 | static $state = array(); |
@@ -5368,6 +5379,9 @@ discard block |
||
| 5368 | 5379 | Jetpack::state( null, null, true ); |
| 5369 | 5380 | } |
| 5370 | 5381 | |
| 5382 | + /** |
|
| 5383 | + * @param string $file |
|
| 5384 | + */ |
|
| 5371 | 5385 | public static function check_privacy( $file ) { |
| 5372 | 5386 | static $is_site_publicly_accessible = null; |
| 5373 | 5387 | |
@@ -5450,6 +5464,9 @@ discard block |
||
| 5450 | 5464 | } |
| 5451 | 5465 | } |
| 5452 | 5466 | |
| 5467 | + /** |
|
| 5468 | + * @param string $url |
|
| 5469 | + */ |
|
| 5453 | 5470 | public static function staticize_subdomain( $url ) { |
| 5454 | 5471 | |
| 5455 | 5472 | // Extract hostname from URL |
@@ -6005,9 +6022,7 @@ discard block |
||
| 6005 | 6022 | * |
| 6006 | 6023 | * Attached to `style_loader_src` filter. |
| 6007 | 6024 | * |
| 6008 | - * @param string $tag The tag that would link to the external asset. |
|
| 6009 | 6025 | * @param string $handle The registered handle of the script in question. |
| 6010 | - * @param string $href The url of the asset in question. |
|
| 6011 | 6026 | */ |
| 6012 | 6027 | public static function set_suffix_on_min( $src, $handle ) { |
| 6013 | 6028 | if ( false === strpos( $src, '.min.css' ) ) { |
@@ -6194,8 +6209,8 @@ discard block |
||
| 6194 | 6209 | * - Absolute URLs `http://domain.com/feh.png` |
| 6195 | 6210 | * - Domain root relative URLs `/feh.png` |
| 6196 | 6211 | * |
| 6197 | - * @param $css string: The raw CSS -- should be read in directly from the file. |
|
| 6198 | - * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from. |
|
| 6212 | + * @param string $css string: The raw CSS -- should be read in directly from the file. |
|
| 6213 | + * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from. |
|
| 6199 | 6214 | * |
| 6200 | 6215 | * @return mixed|string |
| 6201 | 6216 | */ |
@@ -6438,7 +6453,7 @@ discard block |
||
| 6438 | 6453 | /** |
| 6439 | 6454 | * Stores and prints out domains to prefetch for page speed optimization. |
| 6440 | 6455 | * |
| 6441 | - * @param mixed $new_urls |
|
| 6456 | + * @param string[] $new_urls |
|
| 6442 | 6457 | */ |
| 6443 | 6458 | public static function dns_prefetch( $new_urls = null ) { |
| 6444 | 6459 | static $prefetch_urls = array(); |
@@ -6494,7 +6509,6 @@ discard block |
||
| 6494 | 6509 | } |
| 6495 | 6510 | |
| 6496 | 6511 | /** |
| 6497 | - * @param mixed $result Value for the user's option |
|
| 6498 | 6512 | * @return mixed |
| 6499 | 6513 | */ |
| 6500 | 6514 | function get_user_option_meta_box_order_dashboard( $sorted ) { |
@@ -305,7 +305,7 @@ discard block |
||
| 305 | 305 | /** |
| 306 | 306 | * Verifies the signature of the current request. |
| 307 | 307 | * |
| 308 | - * @return false|array |
|
| 308 | + * @return boolean |
|
| 309 | 309 | */ |
| 310 | 310 | public function verify_xml_rpc_signature() { |
| 311 | 311 | if ( is_null( $this->xmlrpc_verification ) ) { |
@@ -1424,7 +1424,7 @@ discard block |
||
| 1424 | 1424 | * |
| 1425 | 1425 | * @param int|false $user_id false: Return the Blog Token. int: Return that user's User Token. |
| 1426 | 1426 | * @param string|false $token_key If provided, check that the token matches the provided input. |
| 1427 | - * @param bool|true $suppress_errors If true, return a falsy value when the token isn't found; When false, return a descriptive WP_Error when the token isn't found. |
|
| 1427 | + * @param boolean $suppress_errors If true, return a falsy value when the token isn't found; When false, return a descriptive WP_Error when the token isn't found. |
|
| 1428 | 1428 | * |
| 1429 | 1429 | * @return object|false |
| 1430 | 1430 | */ |
@@ -33,6 +33,9 @@ discard block |
||
| 33 | 33 | public $extra_headers = array(); |
| 34 | 34 | |
| 35 | 35 | /** |
| 36 | + * @param string $method |
|
| 37 | + * @param string $url |
|
| 38 | + * @param string $post_body |
|
| 36 | 39 | * @return WPCOM_JSON_API instance |
| 37 | 40 | */ |
| 38 | 41 | static function init( $method = null, $url = null, $post_body = null ) { |
@@ -337,6 +340,9 @@ discard block |
||
| 337 | 340 | return call_user_func_array( array( $endpoint, 'callback' ), $path_pieces ); |
| 338 | 341 | } |
| 339 | 342 | |
| 343 | + /** |
|
| 344 | + * @param integer $status_code |
|
| 345 | + */ |
|
| 340 | 346 | function output_early( $status_code, $response = null, $content_type = 'application/json' ) { |
| 341 | 347 | $exit = $this->exit; |
| 342 | 348 | $this->exit = false; |
@@ -545,11 +551,18 @@ discard block |
||
| 545 | 551 | return wp_json_encode( $data ); |
| 546 | 552 | } |
| 547 | 553 | |
| 554 | + /** |
|
| 555 | + * @param string $needle |
|
| 556 | + */ |
|
| 548 | 557 | function ends_with( $haystack, $needle ) { |
| 549 | 558 | return $needle === substr( $haystack, -strlen( $needle ) ); |
| 550 | 559 | } |
| 551 | 560 | |
| 552 | 561 | // Returns the site's blog_id in the WP.com ecosystem |
| 562 | + |
|
| 563 | + /** |
|
| 564 | + * @return integer |
|
| 565 | + */ |
|
| 553 | 566 | function get_blog_id_for_output() { |
| 554 | 567 | return $this->token_details['blog_id']; |
| 555 | 568 | } |
@@ -572,6 +585,10 @@ discard block |
||
| 572 | 585 | } |
| 573 | 586 | |
| 574 | 587 | // Returns true if the specified blog ID is a restricted blog |
| 588 | + |
|
| 589 | + /** |
|
| 590 | + * @param integer $blog_id |
|
| 591 | + */ |
|
| 575 | 592 | function is_restricted_blog( $blog_id ) { |
| 576 | 593 | /** |
| 577 | 594 | * Filters all REST API access and return a 403 unauthorized response for all Restricted blog IDs. |
@@ -621,7 +638,7 @@ discard block |
||
| 621 | 638 | /** |
| 622 | 639 | * Counts the number of comments on a site, excluding certain comment types. |
| 623 | 640 | * |
| 624 | - * @param $post_id int Post ID. |
|
| 641 | + * @param integer $post_id int Post ID. |
|
| 625 | 642 | * @return array Array of counts, matching the output of https://developer.wordpress.org/reference/functions/get_comment_count/. |
| 626 | 643 | */ |
| 627 | 644 | public function wp_count_comments( $post_id ) { |
