Automattic /
jetpack
@@ -1143,7 +1143,7 @@ discard block |
||
| 1143 | 1143 | } |
| 1144 | 1144 | /** |
| 1145 | 1145 | * Does the network allow admins to add new users. |
| 1146 | - * @return boolian |
|
| 1146 | + * @return boolean |
|
| 1147 | 1147 | */ |
| 1148 | 1148 | static function network_add_new_users( $option = null ) { |
| 1149 | 1149 | return (bool) get_site_option( 'add_new_users' ); |
@@ -1248,7 +1248,7 @@ discard block |
||
| 1248 | 1248 | * database which could be set to anything as opposed to what this function returns. |
| 1249 | 1249 | * @param bool $option |
| 1250 | 1250 | * |
| 1251 | - * @return boolean |
|
| 1251 | + * @return string |
|
| 1252 | 1252 | */ |
| 1253 | 1253 | public function is_main_network_option( $option ) { |
| 1254 | 1254 | // return '1' or '' |
@@ -1259,7 +1259,7 @@ discard block |
||
| 1259 | 1259 | * Return true if we are with multi-site or multi-network false if we are dealing with single site. |
| 1260 | 1260 | * |
| 1261 | 1261 | * @param string $option |
| 1262 | - * @return boolean |
|
| 1262 | + * @return string |
|
| 1263 | 1263 | */ |
| 1264 | 1264 | public function is_multisite( $option ) { |
| 1265 | 1265 | return (string) (bool) is_multisite(); |
@@ -1321,7 +1321,7 @@ discard block |
||
| 1321 | 1321 | |
| 1322 | 1322 | /** |
| 1323 | 1323 | * Returns true if the site has file write access false otherwise. |
| 1324 | - * @return string ( '1' | '0' ) |
|
| 1324 | + * @return integer ( '1' | '0' ) |
|
| 1325 | 1325 | **/ |
| 1326 | 1326 | public static function file_system_write_access() { |
| 1327 | 1327 | 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 |
@@ -2579,6 +2580,7 @@ discard block |
||
| 2579 | 2580 | |
| 2580 | 2581 | /** |
| 2581 | 2582 | * Like core's get_file_data implementation, but caches the result. |
| 2583 | + * @param string $file |
|
| 2582 | 2584 | */ |
| 2583 | 2585 | public static function get_file_data( $file, $headers ) { |
| 2584 | 2586 | //Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated |
@@ -2615,7 +2617,7 @@ discard block |
||
| 2615 | 2617 | * |
| 2616 | 2618 | * @param string $tag Tag as it appears in each module heading. |
| 2617 | 2619 | * |
| 2618 | - * @return mixed |
|
| 2620 | + * @return string |
|
| 2619 | 2621 | */ |
| 2620 | 2622 | public static function translate_module_tag( $tag ) { |
| 2621 | 2623 | return jetpack_get_module_i18n_tag( $tag ); |
@@ -2780,8 +2782,8 @@ discard block |
||
| 2780 | 2782 | * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR |
| 2781 | 2783 | * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR. |
| 2782 | 2784 | * |
| 2783 | - * @param $string |
|
| 2784 | - * @return mixed |
|
| 2785 | + * @param string $string |
|
| 2786 | + * @return string|null |
|
| 2785 | 2787 | */ |
| 2786 | 2788 | public static function alias_directories( $string ) { |
| 2787 | 2789 | // ABSPATH has a trailing slash. |
@@ -3061,6 +3063,9 @@ discard block |
||
| 3061 | 3063 | return self::update_active_modules( $new ); |
| 3062 | 3064 | } |
| 3063 | 3065 | |
| 3066 | + /** |
|
| 3067 | + * @param string $module |
|
| 3068 | + */ |
|
| 3064 | 3069 | public static function enable_module_configurable( $module ) { |
| 3065 | 3070 | $module = Jetpack::get_module_slug( $module ); |
| 3066 | 3071 | add_filter( 'jetpack_module_configurable_' . $module, '__return_true' ); |
@@ -3074,11 +3079,17 @@ discard block |
||
| 3074 | 3079 | return $url; |
| 3075 | 3080 | } |
| 3076 | 3081 | |
| 3082 | + /** |
|
| 3083 | + * @param string $module |
|
| 3084 | + */ |
|
| 3077 | 3085 | public static function module_configuration_screen( $module, $method ) { |
| 3078 | 3086 | $module = Jetpack::get_module_slug( $module ); |
| 3079 | 3087 | add_action( 'jetpack_module_configuration_screen_' . $module, $method ); |
| 3080 | 3088 | } |
| 3081 | 3089 | |
| 3090 | + /** |
|
| 3091 | + * @param string $module |
|
| 3092 | + */ |
|
| 3082 | 3093 | public static function module_configuration_activation_screen( $module, $method ) { |
| 3083 | 3094 | $module = Jetpack::get_module_slug( $module ); |
| 3084 | 3095 | add_action( 'display_activate_module_setting_' . $module, $method ); |
@@ -3086,6 +3097,9 @@ discard block |
||
| 3086 | 3097 | |
| 3087 | 3098 | /* Installation */ |
| 3088 | 3099 | |
| 3100 | + /** |
|
| 3101 | + * @param string $message |
|
| 3102 | + */ |
|
| 3089 | 3103 | public static function bail_on_activation( $message, $deactivate = true ) { |
| 3090 | 3104 | ?> |
| 3091 | 3105 | <!doctype html> |
@@ -3842,7 +3856,7 @@ discard block |
||
| 3842 | 3856 | * Add help to the Jetpack page |
| 3843 | 3857 | * |
| 3844 | 3858 | * @since Jetpack (1.2.3) |
| 3845 | - * @return false if not the Jetpack page |
|
| 3859 | + * @return false|null if not the Jetpack page |
|
| 3846 | 3860 | */ |
| 3847 | 3861 | function admin_help() { |
| 3848 | 3862 | $current_screen = get_current_screen(); |
@@ -4817,6 +4831,7 @@ discard block |
||
| 4817 | 4831 | /** |
| 4818 | 4832 | * Returns the requested Jetpack API URL |
| 4819 | 4833 | * |
| 4834 | + * @param string $relative_url |
|
| 4820 | 4835 | * @return string |
| 4821 | 4836 | */ |
| 4822 | 4837 | public static function api_url( $relative_url ) { |
@@ -5008,6 +5023,7 @@ discard block |
||
| 5008 | 5023 | * Note these tokens are unique per call, NOT static per site for connecting. |
| 5009 | 5024 | * |
| 5010 | 5025 | * @since 2.6 |
| 5026 | + * @param string $action |
|
| 5011 | 5027 | * @return array |
| 5012 | 5028 | */ |
| 5013 | 5029 | public static function generate_secrets( $action, $user_id = false, $exp = 600 ) { |
@@ -5541,7 +5557,6 @@ discard block |
||
| 5541 | 5557 | /** |
| 5542 | 5558 | * Report authentication status to the WP REST API. |
| 5543 | 5559 | * |
| 5544 | - * @param WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not |
|
| 5545 | 5560 | * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication} |
| 5546 | 5561 | */ |
| 5547 | 5562 | public function wp_rest_authentication_errors( $value ) { |
@@ -5551,6 +5566,10 @@ discard block |
||
| 5551 | 5566 | return $this->rest_authentication_status; |
| 5552 | 5567 | } |
| 5553 | 5568 | |
| 5569 | + /** |
|
| 5570 | + * @param integer $timestamp |
|
| 5571 | + * @param string $nonce |
|
| 5572 | + */ |
|
| 5554 | 5573 | function add_nonce( $timestamp, $nonce ) { |
| 5555 | 5574 | global $wpdb; |
| 5556 | 5575 | static $nonces_used_this_request = array(); |
@@ -5696,6 +5715,7 @@ discard block |
||
| 5696 | 5715 | * @param string $key |
| 5697 | 5716 | * @param string $value |
| 5698 | 5717 | * @param bool $restate private |
| 5718 | + * @return string |
|
| 5699 | 5719 | */ |
| 5700 | 5720 | public static function state( $key = null, $value = null, $restate = false ) { |
| 5701 | 5721 | static $state = array(); |
@@ -5752,6 +5772,9 @@ discard block |
||
| 5752 | 5772 | Jetpack::state( null, null, true ); |
| 5753 | 5773 | } |
| 5754 | 5774 | |
| 5775 | + /** |
|
| 5776 | + * @param string $file |
|
| 5777 | + */ |
|
| 5755 | 5778 | public static function check_privacy( $file ) { |
| 5756 | 5779 | static $is_site_publicly_accessible = null; |
| 5757 | 5780 | |
@@ -6369,9 +6392,7 @@ discard block |
||
| 6369 | 6392 | * |
| 6370 | 6393 | * Attached to `style_loader_src` filter. |
| 6371 | 6394 | * |
| 6372 | - * @param string $tag The tag that would link to the external asset. |
|
| 6373 | 6395 | * @param string $handle The registered handle of the script in question. |
| 6374 | - * @param string $href The url of the asset in question. |
|
| 6375 | 6396 | */ |
| 6376 | 6397 | public static function set_suffix_on_min( $src, $handle ) { |
| 6377 | 6398 | if ( false === strpos( $src, '.min.css' ) ) { |
@@ -6552,8 +6573,8 @@ discard block |
||
| 6552 | 6573 | * - Absolute URLs `http://domain.com/feh.png` |
| 6553 | 6574 | * - Domain root relative URLs `/feh.png` |
| 6554 | 6575 | * |
| 6555 | - * @param $css string: The raw CSS -- should be read in directly from the file. |
|
| 6556 | - * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from. |
|
| 6576 | + * @param string $css string: The raw CSS -- should be read in directly from the file. |
|
| 6577 | + * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from. |
|
| 6557 | 6578 | * |
| 6558 | 6579 | * @return mixed|string |
| 6559 | 6580 | */ |
@@ -6782,7 +6803,7 @@ discard block |
||
| 6782 | 6803 | * |
| 6783 | 6804 | * @param string $option_name |
| 6784 | 6805 | * |
| 6785 | - * @return bool |
|
| 6806 | + * @return false|null |
|
| 6786 | 6807 | */ |
| 6787 | 6808 | public static function jumpstart_has_updated_module_option( $option_name = '' ) { |
| 6788 | 6809 | // Bail if Jump Start has already been dismissed |
@@ -6823,7 +6844,7 @@ discard block |
||
| 6823 | 6844 | /** |
| 6824 | 6845 | * Stores and prints out domains to prefetch for page speed optimization. |
| 6825 | 6846 | * |
| 6826 | - * @param mixed $new_urls |
|
| 6847 | + * @param string[] $new_urls |
|
| 6827 | 6848 | */ |
| 6828 | 6849 | public static function dns_prefetch( $new_urls = null ) { |
| 6829 | 6850 | static $prefetch_urls = array(); |
@@ -6869,7 +6890,6 @@ discard block |
||
| 6869 | 6890 | } |
| 6870 | 6891 | |
| 6871 | 6892 | /** |
| 6872 | - * @param mixed $result Value for the user's option |
|
| 6873 | 6893 | * @return mixed |
| 6874 | 6894 | */ |
| 6875 | 6895 | function get_user_option_meta_box_order_dashboard( $sorted ) { |
@@ -127,6 +127,9 @@ discard block |
||
| 127 | 127 | return apply_filters( 'jp_carousel_load_for_images_linked_to_file', false ); |
| 128 | 128 | } |
| 129 | 129 | |
| 130 | + /** |
|
| 131 | + * @param string $version |
|
| 132 | + */ |
|
| 130 | 133 | function asset_version( $version ) { |
| 131 | 134 | /** |
| 132 | 135 | * Filter the version string used when enqueuing Carousel assets. |
@@ -701,6 +704,9 @@ discard block |
||
| 701 | 704 | return ( 1 == $value ) ? 1 : 0; |
| 702 | 705 | } |
| 703 | 706 | |
| 707 | + /** |
|
| 708 | + * @param string $name |
|
| 709 | + */ |
|
| 704 | 710 | function settings_checkbox( $name, $label_text, $extra_text = '', $default_to_checked = true ) { |
| 705 | 711 | if ( empty( $name ) ) { |
| 706 | 712 | return; |
@@ -716,6 +722,9 @@ discard block |
||
| 716 | 722 | echo '</fieldset>'; |
| 717 | 723 | } |
| 718 | 724 | |
| 725 | + /** |
|
| 726 | + * @param string $name |
|
| 727 | + */ |
|
| 719 | 728 | function settings_select( $name, $values, $extra_text = '' ) { |
| 720 | 729 | if ( empty( $name ) || ! is_array( $values ) || empty( $values ) ) { |
| 721 | 730 | return; |
