Automattic /
jetpack
@@ -781,7 +781,7 @@ discard block |
||
| 781 | 781 | * This is ported over from the manage module, which has been deprecated and baked in here. |
| 782 | 782 | * |
| 783 | 783 | * @param $domains |
| 784 | - * @return array |
|
| 784 | + * @return string[] |
|
| 785 | 785 | */ |
| 786 | 786 | function allow_wpcom_domain( $domains ) { |
| 787 | 787 | if ( empty( $domains ) ) { |
@@ -1247,7 +1247,7 @@ discard block |
||
| 1247 | 1247 | /** |
| 1248 | 1248 | * Does the network allow admins to add new users. |
| 1249 | 1249 | * |
| 1250 | - * @return boolian |
|
| 1250 | + * @return boolean |
|
| 1251 | 1251 | */ |
| 1252 | 1252 | static function network_add_new_users( $option = null ) { |
| 1253 | 1253 | return (bool) get_site_option( 'add_new_users' ); |
@@ -1357,7 +1357,7 @@ discard block |
||
| 1357 | 1357 | * |
| 1358 | 1358 | * @param bool $option |
| 1359 | 1359 | * |
| 1360 | - * @return boolean |
|
| 1360 | + * @return string |
|
| 1361 | 1361 | */ |
| 1362 | 1362 | public function is_main_network_option( $option ) { |
| 1363 | 1363 | // return '1' or '' |
@@ -1368,7 +1368,7 @@ discard block |
||
| 1368 | 1368 | * Return true if we are with multi-site or multi-network false if we are dealing with single site. |
| 1369 | 1369 | * |
| 1370 | 1370 | * @param string $option |
| 1371 | - * @return boolean |
|
| 1371 | + * @return string |
|
| 1372 | 1372 | */ |
| 1373 | 1373 | public function is_multisite( $option ) { |
| 1374 | 1374 | return (string) (bool) is_multisite(); |
@@ -1431,7 +1431,7 @@ discard block |
||
| 1431 | 1431 | /** |
| 1432 | 1432 | * Returns true if the site has file write access false otherwise. |
| 1433 | 1433 | * |
| 1434 | - * @return string ( '1' | '0' ) |
|
| 1434 | + * @return integer ( '1' | '0' ) |
|
| 1435 | 1435 | **/ |
| 1436 | 1436 | public static function file_system_write_access() { |
| 1437 | 1437 | if ( ! function_exists( 'get_filesystem_method' ) ) { |
@@ -2177,6 +2177,7 @@ discard block |
||
| 2177 | 2177 | * @param int $user_id |
| 2178 | 2178 | * @param string $token |
| 2179 | 2179 | * return bool |
| 2180 | + * @param boolean $is_master_user |
|
| 2180 | 2181 | */ |
| 2181 | 2182 | public static function update_user_token( $user_id, $token, $is_master_user ) { |
| 2182 | 2183 | // not designed for concurrent updates |
@@ -2630,7 +2631,7 @@ discard block |
||
| 2630 | 2631 | * |
| 2631 | 2632 | * @param string $tag Tag as it appears in each module heading. |
| 2632 | 2633 | * |
| 2633 | - * @return mixed |
|
| 2634 | + * @return string |
|
| 2634 | 2635 | */ |
| 2635 | 2636 | public static function translate_module_tag( $tag ) { |
| 2636 | 2637 | return jetpack_get_module_i18n_tag( $tag ); |
@@ -2802,8 +2803,8 @@ discard block |
||
| 2802 | 2803 | * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR |
| 2803 | 2804 | * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR. |
| 2804 | 2805 | * |
| 2805 | - * @param $string |
|
| 2806 | - * @return mixed |
|
| 2806 | + * @param string $string |
|
| 2807 | + * @return string|null |
|
| 2807 | 2808 | */ |
| 2808 | 2809 | public static function alias_directories( $string ) { |
| 2809 | 2810 | // ABSPATH has a trailing slash. |
@@ -2814,6 +2815,10 @@ discard block |
||
| 2814 | 2815 | return $string; |
| 2815 | 2816 | } |
| 2816 | 2817 | |
| 2818 | + /** |
|
| 2819 | + * @param boolean $redirect |
|
| 2820 | + * @param boolean $send_state_messages |
|
| 2821 | + */ |
|
| 2817 | 2822 | public static function activate_default_modules( |
| 2818 | 2823 | $min_version = false, |
| 2819 | 2824 | $max_version = false, |
@@ -3096,6 +3101,9 @@ discard block |
||
| 3096 | 3101 | return self::update_active_modules( $new ); |
| 3097 | 3102 | } |
| 3098 | 3103 | |
| 3104 | + /** |
|
| 3105 | + * @param string $module |
|
| 3106 | + */ |
|
| 3099 | 3107 | public static function enable_module_configurable( $module ) { |
| 3100 | 3108 | $module = self::get_module_slug( $module ); |
| 3101 | 3109 | add_filter( 'jetpack_module_configurable_' . $module, '__return_true' ); |
@@ -3124,6 +3132,10 @@ discard block |
||
| 3124 | 3132 | } |
| 3125 | 3133 | |
| 3126 | 3134 | /* Installation */ |
| 3135 | + |
|
| 3136 | + /** |
|
| 3137 | + * @param string $message |
|
| 3138 | + */ |
|
| 3127 | 3139 | public static function bail_on_activation( $message, $deactivate = true ) { |
| 3128 | 3140 | ?> |
| 3129 | 3141 | <!doctype html> |
@@ -3887,7 +3899,7 @@ discard block |
||
| 3887 | 3899 | * Add help to the Jetpack page |
| 3888 | 3900 | * |
| 3889 | 3901 | * @since Jetpack (1.2.3) |
| 3890 | - * @return false if not the Jetpack page |
|
| 3902 | + * @return false|null if not the Jetpack page |
|
| 3891 | 3903 | */ |
| 3892 | 3904 | function admin_help() { |
| 3893 | 3905 | $current_screen = get_current_screen(); |
@@ -4684,6 +4696,9 @@ discard block |
||
| 4684 | 4696 | return $raw ? esc_url_raw( $url ) : esc_url( $url ); |
| 4685 | 4697 | } |
| 4686 | 4698 | |
| 4699 | + /** |
|
| 4700 | + * @return string |
|
| 4701 | + */ |
|
| 4687 | 4702 | public static function build_authorize_url( $redirect = false, $iframe = false ) { |
| 4688 | 4703 | if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) { |
| 4689 | 4704 | $gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() ); |
@@ -4832,6 +4847,9 @@ discard block |
||
| 4832 | 4847 | return $url; |
| 4833 | 4848 | } |
| 4834 | 4849 | |
| 4850 | + /** |
|
| 4851 | + * @return string |
|
| 4852 | + */ |
|
| 4835 | 4853 | public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) { |
| 4836 | 4854 | $actionurl = str_replace( '&', '&', $actionurl ); |
| 4837 | 4855 | return add_query_arg( $name, wp_create_nonce( $action ), $actionurl ); |
@@ -5128,7 +5146,8 @@ discard block |
||
| 5128 | 5146 | * Note these tokens are unique per call, NOT static per site for connecting. |
| 5129 | 5147 | * |
| 5130 | 5148 | * @since 2.6 |
| 5131 | - * @return array |
|
| 5149 | + * @param string $action |
|
| 5150 | + * @return boolean |
|
| 5132 | 5151 | */ |
| 5133 | 5152 | public static function generate_secrets( $action, $user_id = false, $exp = 600 ) { |
| 5134 | 5153 | if ( false === $user_id ) { |
@@ -5420,7 +5439,6 @@ discard block |
||
| 5420 | 5439 | /** |
| 5421 | 5440 | * Report authentication status to the WP REST API. |
| 5422 | 5441 | * |
| 5423 | - * @param WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not |
|
| 5424 | 5442 | * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication} |
| 5425 | 5443 | */ |
| 5426 | 5444 | public function wp_rest_authentication_errors( $value ) { |
@@ -5522,6 +5540,7 @@ discard block |
||
| 5522 | 5540 | * @param string $key |
| 5523 | 5541 | * @param string $value |
| 5524 | 5542 | * @param bool $restate private |
| 5543 | + * @return string |
|
| 5525 | 5544 | */ |
| 5526 | 5545 | public static function state( $key = null, $value = null, $restate = false ) { |
| 5527 | 5546 | static $state = array(); |
@@ -5580,6 +5599,9 @@ discard block |
||
| 5580 | 5599 | self::state( null, null, true ); |
| 5581 | 5600 | } |
| 5582 | 5601 | |
| 5602 | + /** |
|
| 5603 | + * @param string $file |
|
| 5604 | + */ |
|
| 5583 | 5605 | public static function check_privacy( $file ) { |
| 5584 | 5606 | static $is_site_publicly_accessible = null; |
| 5585 | 5607 | |
@@ -5660,6 +5682,9 @@ discard block |
||
| 5660 | 5682 | } |
| 5661 | 5683 | } |
| 5662 | 5684 | |
| 5685 | + /** |
|
| 5686 | + * @param string $url |
|
| 5687 | + */ |
|
| 5663 | 5688 | public static function staticize_subdomain( $url ) { |
| 5664 | 5689 | |
| 5665 | 5690 | // Extract hostname from URL |
@@ -6225,9 +6250,7 @@ discard block |
||
| 6225 | 6250 | * |
| 6226 | 6251 | * Attached to `style_loader_src` filter. |
| 6227 | 6252 | * |
| 6228 | - * @param string $tag The tag that would link to the external asset. |
|
| 6229 | 6253 | * @param string $handle The registered handle of the script in question. |
| 6230 | - * @param string $href The url of the asset in question. |
|
| 6231 | 6254 | */ |
| 6232 | 6255 | public static function set_suffix_on_min( $src, $handle ) { |
| 6233 | 6256 | if ( false === strpos( $src, '.min.css' ) ) { |
@@ -6415,8 +6438,8 @@ discard block |
||
| 6415 | 6438 | * - Absolute URLs `http://domain.com/feh.png` |
| 6416 | 6439 | * - Domain root relative URLs `/feh.png` |
| 6417 | 6440 | * |
| 6418 | - * @param $css string: The raw CSS -- should be read in directly from the file. |
|
| 6419 | - * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from. |
|
| 6441 | + * @param string $css string: The raw CSS -- should be read in directly from the file. |
|
| 6442 | + * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from. |
|
| 6420 | 6443 | * |
| 6421 | 6444 | * @return mixed|string |
| 6422 | 6445 | */ |
@@ -6677,7 +6700,7 @@ discard block |
||
| 6677 | 6700 | /** |
| 6678 | 6701 | * Stores and prints out domains to prefetch for page speed optimization. |
| 6679 | 6702 | * |
| 6680 | - * @param mixed $new_urls |
|
| 6703 | + * @param string[] $new_urls |
|
| 6681 | 6704 | */ |
| 6682 | 6705 | public static function dns_prefetch( $new_urls = null ) { |
| 6683 | 6706 | static $prefetch_urls = array(); |
@@ -6734,7 +6757,6 @@ discard block |
||
| 6734 | 6757 | } |
| 6735 | 6758 | |
| 6736 | 6759 | /** |
| 6737 | - * @param mixed $result Value for the user's option |
|
| 6738 | 6760 | * @return mixed |
| 6739 | 6761 | */ |
| 6740 | 6762 | function get_user_option_meta_box_order_dashboard( $sorted ) { |
@@ -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 ) { |
@@ -347,6 +350,9 @@ discard block |
||
| 347 | 350 | return call_user_func_array( array( $endpoint, 'callback' ), $path_pieces ); |
| 348 | 351 | } |
| 349 | 352 | |
| 353 | + /** |
|
| 354 | + * @param integer $status_code |
|
| 355 | + */ |
|
| 350 | 356 | function output_early( $status_code, $response = null, $content_type = 'application/json' ) { |
| 351 | 357 | $exit = $this->exit; |
| 352 | 358 | $this->exit = false; |
@@ -563,11 +569,18 @@ discard block |
||
| 563 | 569 | return wp_json_encode( $data ); |
| 564 | 570 | } |
| 565 | 571 | |
| 572 | + /** |
|
| 573 | + * @param string $needle |
|
| 574 | + */ |
|
| 566 | 575 | function ends_with( $haystack, $needle ) { |
| 567 | 576 | return $needle === substr( $haystack, -strlen( $needle ) ); |
| 568 | 577 | } |
| 569 | 578 | |
| 570 | 579 | // Returns the site's blog_id in the WP.com ecosystem |
| 580 | + |
|
| 581 | + /** |
|
| 582 | + * @return integer |
|
| 583 | + */ |
|
| 571 | 584 | function get_blog_id_for_output() { |
| 572 | 585 | return $this->token_details['blog_id']; |
| 573 | 586 | } |
@@ -590,6 +603,10 @@ discard block |
||
| 590 | 603 | } |
| 591 | 604 | |
| 592 | 605 | // Returns true if the specified blog ID is a restricted blog |
| 606 | + |
|
| 607 | + /** |
|
| 608 | + * @param integer $blog_id |
|
| 609 | + */ |
|
| 593 | 610 | function is_restricted_blog( $blog_id ) { |
| 594 | 611 | /** |
| 595 | 612 | * Filters all REST API access and return a 403 unauthorized response for all Restricted blog IDs. |
@@ -639,7 +656,7 @@ discard block |
||
| 639 | 656 | /** |
| 640 | 657 | * Counts the number of comments on a site, excluding certain comment types. |
| 641 | 658 | * |
| 642 | - * @param $post_id int Post ID. |
|
| 659 | + * @param integer $post_id int Post ID. |
|
| 643 | 660 | * @return array Array of counts, matching the output of https://developer.wordpress.org/reference/functions/get_comment_count/. |
| 644 | 661 | */ |
| 645 | 662 | public function wp_count_comments( $post_id ) { |
@@ -84,7 +84,7 @@ discard block |
||
| 84 | 84 | /** |
| 85 | 85 | * Return an array of allowed mime_type items used to upload a media file. |
| 86 | 86 | * |
| 87 | - * @return array mime_type array |
|
| 87 | + * @return string[] mime_type array |
|
| 88 | 88 | */ |
| 89 | 89 | static function get_allowed_mime_types( $default_mime_types ) { |
| 90 | 90 | return array_unique( array_merge( $default_mime_types, array( |
@@ -252,7 +252,7 @@ discard block |
||
| 252 | 252 | * @param object $media_item - media post object |
| 253 | 253 | * @param file $file - file recently added |
| 254 | 254 | * @param bool $has_original_media - condition is the original media has been already added |
| 255 | - * @return bool `true` if the item has been added. Otherwise `false`. |
|
| 255 | + * @return false|null `true` if the item has been added. Otherwise `false`. |
|
| 256 | 256 | */ |
| 257 | 257 | public static function register_revision( $media_item, $file, $has_original_media ) { |
| 258 | 258 | if ( is_wp_error( $file ) || ! $has_original_media ) { |
@@ -280,6 +280,9 @@ discard block |
||
| 280 | 280 | return $original; |
| 281 | 281 | } |
| 282 | 282 | |
| 283 | + /** |
|
| 284 | + * @param string $pathname |
|
| 285 | + */ |
|
| 283 | 286 | public static function delete_file( $pathname ) { |
| 284 | 287 | if ( ! file_exists( $pathname ) || ! is_file( $pathname ) ) { |
| 285 | 288 | // let's touch a fake file to try to `really` remove the media file |
@@ -295,7 +298,7 @@ discard block |
||
| 295 | 298 | * |
| 296 | 299 | * @param number $media_id - media post ID |
| 297 | 300 | * @param string $filename - basename of the file ( name-of-file.ext ) |
| 298 | - * @return bool `true` is the file has been removed, `false` if not. |
|
| 301 | + * @return boolean|null `true` is the file has been removed, `false` if not. |
|
| 299 | 302 | */ |
| 300 | 303 | private static function delete_media_history_file( $media_id, $filename ) { |
| 301 | 304 | $attached_path = get_attached_file( $media_id ); |
@@ -365,6 +368,7 @@ discard block |
||
| 365 | 368 | * |
| 366 | 369 | * @param number $media_id - media post ID |
| 367 | 370 | * @param number [$limit] - maximun amount of items. 20 as default. |
| 371 | + * @param integer $limit |
|
| 368 | 372 | * @return array items removed from `revision_history` |
| 369 | 373 | */ |
| 370 | 374 | public static function limit_revision_history( $media_id, $limit = null) { |
@@ -165,7 +165,7 @@ |
||
| 165 | 165 | * @param string $url Request URL. |
| 166 | 166 | * @param mixed $body Request body. |
| 167 | 167 | * @param bool $verify_body_hash Whether to verify the body hash against the body. |
| 168 | - * @return string|WP_Error Request signature, or a WP_Error on failure. |
|
| 168 | + * @return string Request signature, or a WP_Error on failure. |
|
| 169 | 169 | */ |
| 170 | 170 | public function sign_request( $token = '', $timestamp = 0, $nonce = '', $body_hash = '', $method = '', $url = '', $body = null, $verify_body_hash = true ) { |
| 171 | 171 | if ( ! $this->secret ) { |
@@ -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 ) { |
