Automattic /
jetpack
@@ -219,6 +219,9 @@ discard block |
||
| 219 | 219 | return $body_json; |
| 220 | 220 | } |
| 221 | 221 | |
| 222 | + /** |
|
| 223 | + * @param integer $user_id |
|
| 224 | + */ |
|
| 222 | 225 | private static function authorize_user( $user_id, $access_token ) { |
| 223 | 226 | // authorize user and enable SSO |
| 224 | 227 | Connection_Utils::update_user_token( $user_id, sprintf( '%s.%d', $access_token, $user_id ), true ); |
@@ -242,6 +245,9 @@ discard block |
||
| 242 | 245 | } |
| 243 | 246 | } |
| 244 | 247 | |
| 248 | + /** |
|
| 249 | + * @param string $access_token |
|
| 250 | + */ |
|
| 245 | 251 | private static function verify_token( $access_token ) { |
| 246 | 252 | $request = array( |
| 247 | 253 | 'headers' => array( |
@@ -956,7 +956,7 @@ discard block |
||
| 956 | 956 | * This is ported over from the manage module, which has been deprecated and baked in here. |
| 957 | 957 | * |
| 958 | 958 | * @param $domains |
| 959 | - * @return array |
|
| 959 | + * @return string[] |
|
| 960 | 960 | */ |
| 961 | 961 | function allow_wpcom_domain( $domains ) { |
| 962 | 962 | if ( empty( $domains ) ) { |
@@ -1324,7 +1324,7 @@ discard block |
||
| 1324 | 1324 | /** |
| 1325 | 1325 | * Does the network allow admins to add new users. |
| 1326 | 1326 | * |
| 1327 | - * @return boolian |
|
| 1327 | + * @return boolean |
|
| 1328 | 1328 | */ |
| 1329 | 1329 | static function network_add_new_users( $option = null ) { |
| 1330 | 1330 | return (bool) get_site_option( 'add_new_users' ); |
@@ -1434,7 +1434,7 @@ discard block |
||
| 1434 | 1434 | * |
| 1435 | 1435 | * @param bool $option |
| 1436 | 1436 | * |
| 1437 | - * @return boolean |
|
| 1437 | + * @return string |
|
| 1438 | 1438 | */ |
| 1439 | 1439 | public function is_main_network_option( $option ) { |
| 1440 | 1440 | // return '1' or '' |
@@ -1445,7 +1445,7 @@ discard block |
||
| 1445 | 1445 | * Return true if we are with multi-site or multi-network false if we are dealing with single site. |
| 1446 | 1446 | * |
| 1447 | 1447 | * @param string $option |
| 1448 | - * @return boolean |
|
| 1448 | + * @return string |
|
| 1449 | 1449 | */ |
| 1450 | 1450 | public function is_multisite( $option ) { |
| 1451 | 1451 | return (string) (bool) is_multisite(); |
@@ -1508,7 +1508,7 @@ discard block |
||
| 1508 | 1508 | /** |
| 1509 | 1509 | * Returns true if the site has file write access false otherwise. |
| 1510 | 1510 | * |
| 1511 | - * @return string ( '1' | '0' ) |
|
| 1511 | + * @return integer ( '1' | '0' ) |
|
| 1512 | 1512 | **/ |
| 1513 | 1513 | public static function file_system_write_access() { |
| 1514 | 1514 | if ( ! function_exists( 'get_filesystem_method' ) ) { |
@@ -1786,6 +1786,7 @@ discard block |
||
| 1786 | 1786 | |
| 1787 | 1787 | /** |
| 1788 | 1788 | * Get the wpcom user data of the current|specified connected user. |
| 1789 | + * @param integer $user_id |
|
| 1789 | 1790 | */ |
| 1790 | 1791 | public static function get_connected_user_data( $user_id = null ) { |
| 1791 | 1792 | // TODO: remove in favor of Connection_Manager->get_connected_user_data |
@@ -2237,7 +2238,7 @@ discard block |
||
| 2237 | 2238 | * @param int $user_id The user id. |
| 2238 | 2239 | * @param string $token The user token. |
| 2239 | 2240 | * @param bool $is_master_user Whether the user is the master user. |
| 2240 | - * @return bool |
|
| 2241 | + * @return boolean|null |
|
| 2241 | 2242 | */ |
| 2242 | 2243 | public static function update_user_token( $user_id, $token, $is_master_user ) { |
| 2243 | 2244 | _deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' ); |
@@ -2681,7 +2682,7 @@ discard block |
||
| 2681 | 2682 | * |
| 2682 | 2683 | * @param string $tag Tag as it appears in each module heading. |
| 2683 | 2684 | * |
| 2684 | - * @return mixed |
|
| 2685 | + * @return string |
|
| 2685 | 2686 | */ |
| 2686 | 2687 | public static function translate_module_tag( $tag ) { |
| 2687 | 2688 | return jetpack_get_module_i18n_tag( $tag ); |
@@ -2796,8 +2797,8 @@ discard block |
||
| 2796 | 2797 | * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR |
| 2797 | 2798 | * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR. |
| 2798 | 2799 | * |
| 2799 | - * @param $string |
|
| 2800 | - * @return mixed |
|
| 2800 | + * @param string $string |
|
| 2801 | + * @return string|null |
|
| 2801 | 2802 | */ |
| 2802 | 2803 | public static function alias_directories( $string ) { |
| 2803 | 2804 | // ABSPATH has a trailing slash. |
@@ -2808,6 +2809,10 @@ discard block |
||
| 2808 | 2809 | return $string; |
| 2809 | 2810 | } |
| 2810 | 2811 | |
| 2812 | + /** |
|
| 2813 | + * @param boolean $redirect |
|
| 2814 | + * @param boolean $send_state_messages |
|
| 2815 | + */ |
|
| 2811 | 2816 | public static function activate_default_modules( |
| 2812 | 2817 | $min_version = false, |
| 2813 | 2818 | $max_version = false, |
@@ -3091,6 +3096,9 @@ discard block |
||
| 3091 | 3096 | return self::update_active_modules( $new ); |
| 3092 | 3097 | } |
| 3093 | 3098 | |
| 3099 | + /** |
|
| 3100 | + * @param string $module |
|
| 3101 | + */ |
|
| 3094 | 3102 | public static function enable_module_configurable( $module ) { |
| 3095 | 3103 | $module = self::get_module_slug( $module ); |
| 3096 | 3104 | add_filter( 'jetpack_module_configurable_' . $module, '__return_true' ); |
@@ -3119,6 +3127,10 @@ discard block |
||
| 3119 | 3127 | } |
| 3120 | 3128 | |
| 3121 | 3129 | /* Installation */ |
| 3130 | + |
|
| 3131 | + /** |
|
| 3132 | + * @param string $message |
|
| 3133 | + */ |
|
| 3122 | 3134 | public static function bail_on_activation( $message, $deactivate = true ) { |
| 3123 | 3135 | ?> |
| 3124 | 3136 | <!doctype html> |
@@ -3164,6 +3176,7 @@ discard block |
||
| 3164 | 3176 | * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook() |
| 3165 | 3177 | * |
| 3166 | 3178 | * @static |
| 3179 | + * @param boolean $network_wide |
|
| 3167 | 3180 | */ |
| 3168 | 3181 | public static function plugin_activation( $network_wide ) { |
| 3169 | 3182 | Jetpack_Options::update_option( 'activated', 1 ); |
@@ -3884,7 +3897,7 @@ discard block |
||
| 3884 | 3897 | * Add help to the Jetpack page |
| 3885 | 3898 | * |
| 3886 | 3899 | * @since Jetpack (1.2.3) |
| 3887 | - * @return false if not the Jetpack page |
|
| 3900 | + * @return false|null if not the Jetpack page |
|
| 3888 | 3901 | */ |
| 3889 | 3902 | function admin_help() { |
| 3890 | 3903 | $current_screen = get_current_screen(); |
@@ -4588,6 +4601,7 @@ discard block |
||
| 4588 | 4601 | |
| 4589 | 4602 | /** |
| 4590 | 4603 | * Record a stat for later output. This will only currently output in the admin_footer. |
| 4604 | + * @param string $group |
|
| 4591 | 4605 | */ |
| 4592 | 4606 | function stat( $group, $detail ) { |
| 4593 | 4607 | $this->initialize_stats(); |
@@ -5001,6 +5015,9 @@ discard block |
||
| 5001 | 5015 | return $url; |
| 5002 | 5016 | } |
| 5003 | 5017 | |
| 5018 | + /** |
|
| 5019 | + * @param string $actionurl |
|
| 5020 | + */ |
|
| 5004 | 5021 | public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) { |
| 5005 | 5022 | $actionurl = str_replace( '&', '&', $actionurl ); |
| 5006 | 5023 | return add_query_arg( $name, wp_create_nonce( $action ), $actionurl ); |
@@ -5291,12 +5308,16 @@ discard block |
||
| 5291 | 5308 | * @param String $action The action name. |
| 5292 | 5309 | * @param Integer $user_id The user identifier. |
| 5293 | 5310 | * @param Integer $exp Expiration time in seconds. |
| 5294 | - * @return array |
|
| 5311 | + * @return boolean |
|
| 5295 | 5312 | */ |
| 5296 | 5313 | public static function generate_secrets( $action, $user_id = false, $exp = 600 ) { |
| 5297 | 5314 | return self::connection()->generate_secrets( $action, $user_id, $exp ); |
| 5298 | 5315 | } |
| 5299 | 5316 | |
| 5317 | + /** |
|
| 5318 | + * @param string $action |
|
| 5319 | + * @param integer $user_id |
|
| 5320 | + */ |
|
| 5300 | 5321 | public static function get_secrets( $action, $user_id ) { |
| 5301 | 5322 | $secrets = self::connection()->get_secrets( $action, $user_id ); |
| 5302 | 5323 | |
@@ -5547,7 +5568,6 @@ discard block |
||
| 5547 | 5568 | * @deprecated since 8.9.0 |
| 5548 | 5569 | * @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authentication_errors() |
| 5549 | 5570 | * |
| 5550 | - * @param WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not |
|
| 5551 | 5571 | * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication} |
| 5552 | 5572 | */ |
| 5553 | 5573 | public function wp_rest_authentication_errors( $value ) { |
@@ -5640,6 +5660,7 @@ discard block |
||
| 5640 | 5660 | * @param string $key |
| 5641 | 5661 | * @param string $value |
| 5642 | 5662 | * @param bool $restate private |
| 5663 | + * @return string |
|
| 5643 | 5664 | */ |
| 5644 | 5665 | public static function state( $key = null, $value = null, $restate = false ) { |
| 5645 | 5666 | static $state = array(); |
@@ -5721,6 +5742,9 @@ discard block |
||
| 5721 | 5742 | return true; |
| 5722 | 5743 | } |
| 5723 | 5744 | |
| 5745 | + /** |
|
| 5746 | + * @param string $file |
|
| 5747 | + */ |
|
| 5724 | 5748 | public static function check_privacy( $file ) { |
| 5725 | 5749 | static $is_site_publicly_accessible = null; |
| 5726 | 5750 | |
@@ -6293,9 +6317,7 @@ discard block |
||
| 6293 | 6317 | * |
| 6294 | 6318 | * Attached to `style_loader_src` filter. |
| 6295 | 6319 | * |
| 6296 | - * @param string $tag The tag that would link to the external asset. |
|
| 6297 | 6320 | * @param string $handle The registered handle of the script in question. |
| 6298 | - * @param string $href The url of the asset in question. |
|
| 6299 | 6321 | */ |
| 6300 | 6322 | public static function set_suffix_on_min( $src, $handle ) { |
| 6301 | 6323 | if ( false === strpos( $src, '.min.css' ) ) { |
@@ -6671,8 +6693,8 @@ discard block |
||
| 6671 | 6693 | * - Absolute URLs `http://domain.com/feh.png` |
| 6672 | 6694 | * - Domain root relative URLs `/feh.png` |
| 6673 | 6695 | * |
| 6674 | - * @param $css string: The raw CSS -- should be read in directly from the file. |
|
| 6675 | - * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from. |
|
| 6696 | + * @param string $css string: The raw CSS -- should be read in directly from the file. |
|
| 6697 | + * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from. |
|
| 6676 | 6698 | * |
| 6677 | 6699 | * @return mixed|string |
| 6678 | 6700 | */ |
@@ -6974,7 +6996,6 @@ discard block |
||
| 6974 | 6996 | } |
| 6975 | 6997 | |
| 6976 | 6998 | /** |
| 6977 | - * @param mixed $result Value for the user's option |
|
| 6978 | 6999 | * @return mixed |
| 6979 | 7000 | */ |
| 6980 | 7001 | function get_user_option_meta_box_order_dashboard( $sorted ) { |
@@ -247,7 +247,7 @@ |
||
| 247 | 247 | * |
| 248 | 248 | * @param string $service_name 'facebook', 'twitter', etc. |
| 249 | 249 | * @param false|int $_blog_id The blog ID. Use false (default) for the current blog |
| 250 | - * @param false|int $_user_id The user ID. Use false (default) for the current user |
|
| 250 | + * @param integer $_user_id The user ID. Use false (default) for the current user |
|
| 251 | 251 | * @return false|object[]|array[] false if no connections exist |
| 252 | 252 | */ |
| 253 | 253 | abstract function get_connections( $service_name, $_blog_id = false, $_user_id = false ); |
