Automattic /
jetpack
@@ -1222,7 +1222,7 @@ discard block |
||
| 1222 | 1222 | } |
| 1223 | 1223 | /** |
| 1224 | 1224 | * Does the network allow admins to add new users. |
| 1225 | - * @return boolian |
|
| 1225 | + * @return boolean |
|
| 1226 | 1226 | */ |
| 1227 | 1227 | static function network_add_new_users( $option = null ) { |
| 1228 | 1228 | return (bool) get_site_option( 'add_new_users' ); |
@@ -1327,7 +1327,7 @@ discard block |
||
| 1327 | 1327 | * database which could be set to anything as opposed to what this function returns. |
| 1328 | 1328 | * @param bool $option |
| 1329 | 1329 | * |
| 1330 | - * @return boolean |
|
| 1330 | + * @return string |
|
| 1331 | 1331 | */ |
| 1332 | 1332 | public function is_main_network_option( $option ) { |
| 1333 | 1333 | // return '1' or '' |
@@ -1338,7 +1338,7 @@ discard block |
||
| 1338 | 1338 | * Return true if we are with multi-site or multi-network false if we are dealing with single site. |
| 1339 | 1339 | * |
| 1340 | 1340 | * @param string $option |
| 1341 | - * @return boolean |
|
| 1341 | + * @return string |
|
| 1342 | 1342 | */ |
| 1343 | 1343 | public function is_multisite( $option ) { |
| 1344 | 1344 | return (string) (bool) is_multisite(); |
@@ -1400,7 +1400,7 @@ discard block |
||
| 1400 | 1400 | |
| 1401 | 1401 | /** |
| 1402 | 1402 | * Returns true if the site has file write access false otherwise. |
| 1403 | - * @return string ( '1' | '0' ) |
|
| 1403 | + * @return integer ( '1' | '0' ) |
|
| 1404 | 1404 | **/ |
| 1405 | 1405 | public static function file_system_write_access() { |
| 1406 | 1406 | if ( ! function_exists( 'get_filesystem_method' ) ) { |
@@ -2256,6 +2256,7 @@ discard block |
||
| 2256 | 2256 | * @param int $user_id |
| 2257 | 2257 | * @param string $token |
| 2258 | 2258 | * return bool |
| 2259 | + * @param boolean $is_master_user |
|
| 2259 | 2260 | */ |
| 2260 | 2261 | public static function update_user_token( $user_id, $token, $is_master_user ) { |
| 2261 | 2262 | // not designed for concurrent updates |
@@ -2658,6 +2659,7 @@ discard block |
||
| 2658 | 2659 | |
| 2659 | 2660 | /** |
| 2660 | 2661 | * Like core's get_file_data implementation, but caches the result. |
| 2662 | + * @param string $file |
|
| 2661 | 2663 | */ |
| 2662 | 2664 | public static function get_file_data( $file, $headers ) { |
| 2663 | 2665 | //Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated |
@@ -2694,7 +2696,7 @@ discard block |
||
| 2694 | 2696 | * |
| 2695 | 2697 | * @param string $tag Tag as it appears in each module heading. |
| 2696 | 2698 | * |
| 2697 | - * @return mixed |
|
| 2699 | + * @return string |
|
| 2698 | 2700 | */ |
| 2699 | 2701 | public static function translate_module_tag( $tag ) { |
| 2700 | 2702 | return jetpack_get_module_i18n_tag( $tag ); |
@@ -2859,8 +2861,8 @@ discard block |
||
| 2859 | 2861 | * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR |
| 2860 | 2862 | * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR. |
| 2861 | 2863 | * |
| 2862 | - * @param $string |
|
| 2863 | - * @return mixed |
|
| 2864 | + * @param string $string |
|
| 2865 | + * @return string|null |
|
| 2864 | 2866 | */ |
| 2865 | 2867 | public static function alias_directories( $string ) { |
| 2866 | 2868 | // ABSPATH has a trailing slash. |
@@ -3140,6 +3142,9 @@ discard block |
||
| 3140 | 3142 | return self::update_active_modules( $new ); |
| 3141 | 3143 | } |
| 3142 | 3144 | |
| 3145 | + /** |
|
| 3146 | + * @param string $module |
|
| 3147 | + */ |
|
| 3143 | 3148 | public static function enable_module_configurable( $module ) { |
| 3144 | 3149 | $module = Jetpack::get_module_slug( $module ); |
| 3145 | 3150 | add_filter( 'jetpack_module_configurable_' . $module, '__return_true' ); |
@@ -3167,21 +3172,33 @@ discard block |
||
| 3167 | 3172 | return $url; |
| 3168 | 3173 | } |
| 3169 | 3174 | |
| 3175 | + /** |
|
| 3176 | + * @param string $module |
|
| 3177 | + */ |
|
| 3170 | 3178 | public static function module_configuration_load( $module, $method ) { |
| 3171 | 3179 | $module = Jetpack::get_module_slug( $module ); |
| 3172 | 3180 | add_action( 'jetpack_module_configuration_load_' . $module, $method ); |
| 3173 | 3181 | } |
| 3174 | 3182 | |
| 3183 | + /** |
|
| 3184 | + * @param string $module |
|
| 3185 | + */ |
|
| 3175 | 3186 | public static function module_configuration_head( $module, $method ) { |
| 3176 | 3187 | $module = Jetpack::get_module_slug( $module ); |
| 3177 | 3188 | add_action( 'jetpack_module_configuration_head_' . $module, $method ); |
| 3178 | 3189 | } |
| 3179 | 3190 | |
| 3191 | + /** |
|
| 3192 | + * @param string $module |
|
| 3193 | + */ |
|
| 3180 | 3194 | public static function module_configuration_screen( $module, $method ) { |
| 3181 | 3195 | $module = Jetpack::get_module_slug( $module ); |
| 3182 | 3196 | add_action( 'jetpack_module_configuration_screen_' . $module, $method ); |
| 3183 | 3197 | } |
| 3184 | 3198 | |
| 3199 | + /** |
|
| 3200 | + * @param string $module |
|
| 3201 | + */ |
|
| 3185 | 3202 | public static function module_configuration_activation_screen( $module, $method ) { |
| 3186 | 3203 | $module = Jetpack::get_module_slug( $module ); |
| 3187 | 3204 | add_action( 'display_activate_module_setting_' . $module, $method ); |
@@ -3189,6 +3206,9 @@ discard block |
||
| 3189 | 3206 | |
| 3190 | 3207 | /* Installation */ |
| 3191 | 3208 | |
| 3209 | + /** |
|
| 3210 | + * @param string $message |
|
| 3211 | + */ |
|
| 3192 | 3212 | public static function bail_on_activation( $message, $deactivate = true ) { |
| 3193 | 3213 | ?> |
| 3194 | 3214 | <!doctype html> |
@@ -3949,7 +3969,7 @@ discard block |
||
| 3949 | 3969 | * Add help to the Jetpack page |
| 3950 | 3970 | * |
| 3951 | 3971 | * @since Jetpack (1.2.3) |
| 3952 | - * @return false if not the Jetpack page |
|
| 3972 | + * @return false|null if not the Jetpack page |
|
| 3953 | 3973 | */ |
| 3954 | 3974 | function admin_help() { |
| 3955 | 3975 | $current_screen = get_current_screen(); |
@@ -4845,6 +4865,9 @@ discard block |
||
| 4845 | 4865 | return $url; |
| 4846 | 4866 | } |
| 4847 | 4867 | |
| 4868 | + /** |
|
| 4869 | + * @return string |
|
| 4870 | + */ |
|
| 4848 | 4871 | public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) { |
| 4849 | 4872 | $actionurl = str_replace( '&', '&', $actionurl ); |
| 4850 | 4873 | return add_query_arg( $name, wp_create_nonce( $action ), $actionurl ); |
@@ -5056,6 +5079,7 @@ discard block |
||
| 5056 | 5079 | /** |
| 5057 | 5080 | * Returns the requested Jetpack API URL |
| 5058 | 5081 | * |
| 5082 | + * @param string $relative_url |
|
| 5059 | 5083 | * @return string |
| 5060 | 5084 | */ |
| 5061 | 5085 | public static function api_url( $relative_url ) { |
@@ -5247,6 +5271,7 @@ discard block |
||
| 5247 | 5271 | * Note these tokens are unique per call, NOT static per site for connecting. |
| 5248 | 5272 | * |
| 5249 | 5273 | * @since 2.6 |
| 5274 | + * @param string $action |
|
| 5250 | 5275 | * @return array |
| 5251 | 5276 | */ |
| 5252 | 5277 | public static function generate_secrets( $action, $user_id = false, $exp = 600 ) { |
@@ -5780,7 +5805,6 @@ discard block |
||
| 5780 | 5805 | /** |
| 5781 | 5806 | * Report authentication status to the WP REST API. |
| 5782 | 5807 | * |
| 5783 | - * @param WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not |
|
| 5784 | 5808 | * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication} |
| 5785 | 5809 | */ |
| 5786 | 5810 | public function wp_rest_authentication_errors( $value ) { |
@@ -5790,6 +5814,10 @@ discard block |
||
| 5790 | 5814 | return $this->rest_authentication_status; |
| 5791 | 5815 | } |
| 5792 | 5816 | |
| 5817 | + /** |
|
| 5818 | + * @param integer $timestamp |
|
| 5819 | + * @param string $nonce |
|
| 5820 | + */ |
|
| 5793 | 5821 | function add_nonce( $timestamp, $nonce ) { |
| 5794 | 5822 | global $wpdb; |
| 5795 | 5823 | static $nonces_used_this_request = array(); |
@@ -5935,6 +5963,7 @@ discard block |
||
| 5935 | 5963 | * @param string $key |
| 5936 | 5964 | * @param string $value |
| 5937 | 5965 | * @param bool $restate private |
| 5966 | + * @return string |
|
| 5938 | 5967 | */ |
| 5939 | 5968 | public static function state( $key = null, $value = null, $restate = false ) { |
| 5940 | 5969 | static $state = array(); |
@@ -5991,6 +6020,9 @@ discard block |
||
| 5991 | 6020 | Jetpack::state( null, null, true ); |
| 5992 | 6021 | } |
| 5993 | 6022 | |
| 6023 | + /** |
|
| 6024 | + * @param string $file |
|
| 6025 | + */ |
|
| 5994 | 6026 | public static function check_privacy( $file ) { |
| 5995 | 6027 | static $is_site_publicly_accessible = null; |
| 5996 | 6028 | |
@@ -6608,9 +6640,7 @@ discard block |
||
| 6608 | 6640 | * |
| 6609 | 6641 | * Attached to `style_loader_src` filter. |
| 6610 | 6642 | * |
| 6611 | - * @param string $tag The tag that would link to the external asset. |
|
| 6612 | 6643 | * @param string $handle The registered handle of the script in question. |
| 6613 | - * @param string $href The url of the asset in question. |
|
| 6614 | 6644 | */ |
| 6615 | 6645 | public static function set_suffix_on_min( $src, $handle ) { |
| 6616 | 6646 | if ( false === strpos( $src, '.min.css' ) ) { |
@@ -6791,8 +6821,8 @@ discard block |
||
| 6791 | 6821 | * - Absolute URLs `http://domain.com/feh.png` |
| 6792 | 6822 | * - Domain root relative URLs `/feh.png` |
| 6793 | 6823 | * |
| 6794 | - * @param $css string: The raw CSS -- should be read in directly from the file. |
|
| 6795 | - * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from. |
|
| 6824 | + * @param string $css string: The raw CSS -- should be read in directly from the file. |
|
| 6825 | + * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from. |
|
| 6796 | 6826 | * |
| 6797 | 6827 | * @return mixed|string |
| 6798 | 6828 | */ |
@@ -7021,7 +7051,7 @@ discard block |
||
| 7021 | 7051 | * |
| 7022 | 7052 | * @param string $option_name |
| 7023 | 7053 | * |
| 7024 | - * @return bool |
|
| 7054 | + * @return false|null |
|
| 7025 | 7055 | */ |
| 7026 | 7056 | public static function jumpstart_has_updated_module_option( $option_name = '' ) { |
| 7027 | 7057 | // Bail if Jump Start has already been dismissed |
@@ -7062,7 +7092,7 @@ discard block |
||
| 7062 | 7092 | /** |
| 7063 | 7093 | * Stores and prints out domains to prefetch for page speed optimization. |
| 7064 | 7094 | * |
| 7065 | - * @param mixed $new_urls |
|
| 7095 | + * @param string[] $new_urls |
|
| 7066 | 7096 | */ |
| 7067 | 7097 | public static function dns_prefetch( $new_urls = null ) { |
| 7068 | 7098 | static $prefetch_urls = array(); |
@@ -7108,7 +7138,6 @@ discard block |
||
| 7108 | 7138 | } |
| 7109 | 7139 | |
| 7110 | 7140 | /** |
| 7111 | - * @param mixed $result Value for the user's option |
|
| 7112 | 7141 | * @return mixed |
| 7113 | 7142 | */ |
| 7114 | 7143 | function get_user_option_meta_box_order_dashboard( $sorted ) { |
