Automattic /
jetpack
@@ -783,7 +783,7 @@ discard block |
||
| 783 | 783 | * This is ported over from the manage module, which has been deprecated and baked in here. |
| 784 | 784 | * |
| 785 | 785 | * @param $domains |
| 786 | - * @return array |
|
| 786 | + * @return string[] |
|
| 787 | 787 | */ |
| 788 | 788 | function allow_wpcom_domain( $domains ) { |
| 789 | 789 | if ( empty( $domains ) ) { |
@@ -1241,7 +1241,7 @@ discard block |
||
| 1241 | 1241 | } |
| 1242 | 1242 | /** |
| 1243 | 1243 | * Does the network allow admins to add new users. |
| 1244 | - * @return boolian |
|
| 1244 | + * @return boolean |
|
| 1245 | 1245 | */ |
| 1246 | 1246 | static function network_add_new_users( $option = null ) { |
| 1247 | 1247 | return (bool) get_site_option( 'add_new_users' ); |
@@ -1346,7 +1346,7 @@ discard block |
||
| 1346 | 1346 | * database which could be set to anything as opposed to what this function returns. |
| 1347 | 1347 | * @param bool $option |
| 1348 | 1348 | * |
| 1349 | - * @return boolean |
|
| 1349 | + * @return string |
|
| 1350 | 1350 | */ |
| 1351 | 1351 | public function is_main_network_option( $option ) { |
| 1352 | 1352 | // return '1' or '' |
@@ -1357,7 +1357,7 @@ discard block |
||
| 1357 | 1357 | * Return true if we are with multi-site or multi-network false if we are dealing with single site. |
| 1358 | 1358 | * |
| 1359 | 1359 | * @param string $option |
| 1360 | - * @return boolean |
|
| 1360 | + * @return string |
|
| 1361 | 1361 | */ |
| 1362 | 1362 | public function is_multisite( $option ) { |
| 1363 | 1363 | return (string) (bool) is_multisite(); |
@@ -1419,7 +1419,7 @@ discard block |
||
| 1419 | 1419 | |
| 1420 | 1420 | /** |
| 1421 | 1421 | * Returns true if the site has file write access false otherwise. |
| 1422 | - * @return string ( '1' | '0' ) |
|
| 1422 | + * @return integer ( '1' | '0' ) |
|
| 1423 | 1423 | **/ |
| 1424 | 1424 | public static function file_system_write_access() { |
| 1425 | 1425 | if ( ! function_exists( 'get_filesystem_method' ) ) { |
@@ -2154,6 +2154,7 @@ discard block |
||
| 2154 | 2154 | * @param int $user_id |
| 2155 | 2155 | * @param string $token |
| 2156 | 2156 | * return bool |
| 2157 | + * @param boolean $is_master_user |
|
| 2157 | 2158 | */ |
| 2158 | 2159 | public static function update_user_token( $user_id, $token, $is_master_user ) { |
| 2159 | 2160 | // not designed for concurrent updates |
@@ -2598,7 +2599,7 @@ discard block |
||
| 2598 | 2599 | * |
| 2599 | 2600 | * @param string $tag Tag as it appears in each module heading. |
| 2600 | 2601 | * |
| 2601 | - * @return mixed |
|
| 2602 | + * @return string |
|
| 2602 | 2603 | */ |
| 2603 | 2604 | public static function translate_module_tag( $tag ) { |
| 2604 | 2605 | return jetpack_get_module_i18n_tag( $tag ); |
@@ -2770,8 +2771,8 @@ discard block |
||
| 2770 | 2771 | * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR |
| 2771 | 2772 | * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR. |
| 2772 | 2773 | * |
| 2773 | - * @param $string |
|
| 2774 | - * @return mixed |
|
| 2774 | + * @param string $string |
|
| 2775 | + * @return string|null |
|
| 2775 | 2776 | */ |
| 2776 | 2777 | public static function alias_directories( $string ) { |
| 2777 | 2778 | // ABSPATH has a trailing slash. |
@@ -3031,6 +3032,9 @@ discard block |
||
| 3031 | 3032 | return self::update_active_modules( $new ); |
| 3032 | 3033 | } |
| 3033 | 3034 | |
| 3035 | + /** |
|
| 3036 | + * @param string $module |
|
| 3037 | + */ |
|
| 3034 | 3038 | public static function enable_module_configurable( $module ) { |
| 3035 | 3039 | $module = Jetpack::get_module_slug( $module ); |
| 3036 | 3040 | add_filter( 'jetpack_module_configurable_' . $module, '__return_true' ); |
@@ -3059,6 +3063,9 @@ discard block |
||
| 3059 | 3063 | } |
| 3060 | 3064 | |
| 3061 | 3065 | /* Installation */ |
| 3066 | + /** |
|
| 3067 | + * @param string $message |
|
| 3068 | + */ |
|
| 3062 | 3069 | public static function bail_on_activation( $message, $deactivate = true ) { |
| 3063 | 3070 | ?> |
| 3064 | 3071 | <!doctype html> |
@@ -3774,7 +3781,7 @@ discard block |
||
| 3774 | 3781 | * Add help to the Jetpack page |
| 3775 | 3782 | * |
| 3776 | 3783 | * @since Jetpack (1.2.3) |
| 3777 | - * @return false if not the Jetpack page |
|
| 3784 | + * @return false|null if not the Jetpack page |
|
| 3778 | 3785 | */ |
| 3779 | 3786 | function admin_help() { |
| 3780 | 3787 | $current_screen = get_current_screen(); |
@@ -4505,6 +4512,9 @@ discard block |
||
| 4505 | 4512 | return $raw ? esc_url_raw( $url ) : esc_url( $url ); |
| 4506 | 4513 | } |
| 4507 | 4514 | |
| 4515 | + /** |
|
| 4516 | + * @return string |
|
| 4517 | + */ |
|
| 4508 | 4518 | public static function build_authorize_url( $redirect = false, $iframe = false ) { |
| 4509 | 4519 | if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) { |
| 4510 | 4520 | $gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() ); |
@@ -4644,6 +4654,9 @@ discard block |
||
| 4644 | 4654 | return $url; |
| 4645 | 4655 | } |
| 4646 | 4656 | |
| 4657 | + /** |
|
| 4658 | + * @return string |
|
| 4659 | + */ |
|
| 4647 | 4660 | public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) { |
| 4648 | 4661 | $actionurl = str_replace( '&', '&', $actionurl ); |
| 4649 | 4662 | return add_query_arg( $name, wp_create_nonce( $action ), $actionurl ); |
@@ -4947,7 +4960,8 @@ discard block |
||
| 4947 | 4960 | * Note these tokens are unique per call, NOT static per site for connecting. |
| 4948 | 4961 | * |
| 4949 | 4962 | * @since 2.6 |
| 4950 | - * @return array |
|
| 4963 | + * @param string $action |
|
| 4964 | + * @return boolean |
|
| 4951 | 4965 | */ |
| 4952 | 4966 | public static function generate_secrets( $action, $user_id = false, $exp = 600 ) { |
| 4953 | 4967 | if ( false === $user_id ) { |
@@ -5236,7 +5250,6 @@ discard block |
||
| 5236 | 5250 | /** |
| 5237 | 5251 | * Report authentication status to the WP REST API. |
| 5238 | 5252 | * |
| 5239 | - * @param WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not |
|
| 5240 | 5253 | * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication} |
| 5241 | 5254 | */ |
| 5242 | 5255 | public function wp_rest_authentication_errors( $value ) { |
@@ -5338,6 +5351,7 @@ discard block |
||
| 5338 | 5351 | * @param string $key |
| 5339 | 5352 | * @param string $value |
| 5340 | 5353 | * @param bool $restate private |
| 5354 | + * @return string |
|
| 5341 | 5355 | */ |
| 5342 | 5356 | public static function state( $key = null, $value = null, $restate = false ) { |
| 5343 | 5357 | static $state = array(); |
@@ -5394,6 +5408,9 @@ discard block |
||
| 5394 | 5408 | Jetpack::state( null, null, true ); |
| 5395 | 5409 | } |
| 5396 | 5410 | |
| 5411 | + /** |
|
| 5412 | + * @param string $file |
|
| 5413 | + */ |
|
| 5397 | 5414 | public static function check_privacy( $file ) { |
| 5398 | 5415 | static $is_site_publicly_accessible = null; |
| 5399 | 5416 | |
@@ -5476,6 +5493,9 @@ discard block |
||
| 5476 | 5493 | } |
| 5477 | 5494 | } |
| 5478 | 5495 | |
| 5496 | + /** |
|
| 5497 | + * @param string $url |
|
| 5498 | + */ |
|
| 5479 | 5499 | public static function staticize_subdomain( $url ) { |
| 5480 | 5500 | |
| 5481 | 5501 | // Extract hostname from URL |
@@ -6031,9 +6051,7 @@ discard block |
||
| 6031 | 6051 | * |
| 6032 | 6052 | * Attached to `style_loader_src` filter. |
| 6033 | 6053 | * |
| 6034 | - * @param string $tag The tag that would link to the external asset. |
|
| 6035 | 6054 | * @param string $handle The registered handle of the script in question. |
| 6036 | - * @param string $href The url of the asset in question. |
|
| 6037 | 6055 | */ |
| 6038 | 6056 | public static function set_suffix_on_min( $src, $handle ) { |
| 6039 | 6057 | if ( false === strpos( $src, '.min.css' ) ) { |
@@ -6221,8 +6239,8 @@ discard block |
||
| 6221 | 6239 | * - Absolute URLs `http://domain.com/feh.png` |
| 6222 | 6240 | * - Domain root relative URLs `/feh.png` |
| 6223 | 6241 | * |
| 6224 | - * @param $css string: The raw CSS -- should be read in directly from the file. |
|
| 6225 | - * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from. |
|
| 6242 | + * @param string $css string: The raw CSS -- should be read in directly from the file. |
|
| 6243 | + * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from. |
|
| 6226 | 6244 | * |
| 6227 | 6245 | * @return mixed|string |
| 6228 | 6246 | */ |
@@ -6483,7 +6501,7 @@ discard block |
||
| 6483 | 6501 | /** |
| 6484 | 6502 | * Stores and prints out domains to prefetch for page speed optimization. |
| 6485 | 6503 | * |
| 6486 | - * @param mixed $new_urls |
|
| 6504 | + * @param string[] $new_urls |
|
| 6487 | 6505 | */ |
| 6488 | 6506 | public static function dns_prefetch( $new_urls = null ) { |
| 6489 | 6507 | static $prefetch_urls = array(); |
@@ -6539,7 +6557,6 @@ discard block |
||
| 6539 | 6557 | } |
| 6540 | 6558 | |
| 6541 | 6559 | /** |
| 6542 | - * @param mixed $result Value for the user's option |
|
| 6543 | 6560 | * @return mixed |
| 6544 | 6561 | */ |
| 6545 | 6562 | function get_user_option_meta_box_order_dashboard( $sorted ) { |
@@ -273,7 +273,7 @@ discard block |
||
| 273 | 273 | /** |
| 274 | 274 | * Verifies the signature of the current request. |
| 275 | 275 | * |
| 276 | - * @return false|array |
|
| 276 | + * @return boolean |
|
| 277 | 277 | */ |
| 278 | 278 | public function verify_xml_rpc_signature() { |
| 279 | 279 | if ( is_null( $this->xmlrpc_verification ) ) { |
@@ -1029,6 +1029,7 @@ discard block |
||
| 1029 | 1029 | * @param String $action The action name. |
| 1030 | 1030 | * @param Integer $user_id The user identifier. |
| 1031 | 1031 | * @param Integer $exp Expiration time in seconds. |
| 1032 | + * @return string |
|
| 1032 | 1033 | */ |
| 1033 | 1034 | public function generate_secrets( $action, $user_id = false, $exp = 600 ) { |
| 1034 | 1035 | $callable = $this->get_secret_callable(); |
@@ -1419,7 +1420,7 @@ discard block |
||
| 1419 | 1420 | * |
| 1420 | 1421 | * @param int|false $user_id false: Return the Blog Token. int: Return that user's User Token. |
| 1421 | 1422 | * @param string|false $token_key If provided, check that the token matches the provided input. |
| 1422 | - * @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. |
|
| 1423 | + * @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. |
|
| 1423 | 1424 | * |
| 1424 | 1425 | * @return object|false |
| 1425 | 1426 | */ |
@@ -36,6 +36,9 @@ |
||
| 36 | 36 | add_action( 'init', array( &$this, 'action_init' ) ); |
| 37 | 37 | } |
| 38 | 38 | |
| 39 | + /** |
|
| 40 | + * @param string $file |
|
| 41 | + */ |
|
| 39 | 42 | function wpcom_static_url($file) { |
| 40 | 43 | $i = hexdec( substr( md5( $file ), -1 ) ) % 2; |
| 41 | 44 | return 'https://s' . $i . '.wp.com' . $file; |
