Completed
Push — add/ui-aff-code ( 8597a7...5532a7 )
by
unknown
09:59 queued 01:46
created
class.jetpack.php 1 patch
Doc Comments   +42 added lines, -16 removed lines patch added patch discarded remove patch
@@ -1143,7 +1143,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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' );
@@ -3088,21 +3093,33 @@  discard block
 block discarded – undo
3088 3093
 		return $url;
3089 3094
 	}
3090 3095
 
3096
+	/**
3097
+	 * @param string $module
3098
+	 */
3091 3099
 	public static function module_configuration_load( $module, $method ) {
3092 3100
 		$module = Jetpack::get_module_slug( $module );
3093 3101
 		add_action( 'jetpack_module_configuration_load_' . $module, $method );
3094 3102
 	}
3095 3103
 
3104
+	/**
3105
+	 * @param string $module
3106
+	 */
3096 3107
 	public static function module_configuration_head( $module, $method ) {
3097 3108
 		$module = Jetpack::get_module_slug( $module );
3098 3109
 		add_action( 'jetpack_module_configuration_head_' . $module, $method );
3099 3110
 	}
3100 3111
 
3112
+	/**
3113
+	 * @param string $module
3114
+	 */
3101 3115
 	public static function module_configuration_screen( $module, $method ) {
3102 3116
 		$module = Jetpack::get_module_slug( $module );
3103 3117
 		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
3104 3118
 	}
3105 3119
 
3120
+	/**
3121
+	 * @param string $module
3122
+	 */
3106 3123
 	public static function module_configuration_activation_screen( $module, $method ) {
3107 3124
 		$module = Jetpack::get_module_slug( $module );
3108 3125
 		add_action( 'display_activate_module_setting_' . $module, $method );
@@ -3110,6 +3127,9 @@  discard block
 block discarded – undo
3110 3127
 
3111 3128
 /* Installation */
3112 3129
 
3130
+	/**
3131
+	 * @param string $message
3132
+	 */
3113 3133
 	public static function bail_on_activation( $message, $deactivate = true ) {
3114 3134
 ?>
3115 3135
 <!doctype html>
@@ -3866,7 +3886,7 @@  discard block
 block discarded – undo
3866 3886
 	 * Add help to the Jetpack page
3867 3887
 	 *
3868 3888
 	 * @since Jetpack (1.2.3)
3869
-	 * @return false if not the Jetpack page
3889
+	 * @return false|null if not the Jetpack page
3870 3890
 	 */
3871 3891
 	function admin_help() {
3872 3892
 		$current_screen = get_current_screen();
@@ -4967,6 +4987,7 @@  discard block
 block discarded – undo
4967 4987
 	/**
4968 4988
 	 * Returns the requested Jetpack API URL
4969 4989
 	 *
4990
+	 * @param string $relative_url
4970 4991
 	 * @return string
4971 4992
 	 */
4972 4993
 	public static function api_url( $relative_url ) {
@@ -5158,6 +5179,7 @@  discard block
 block discarded – undo
5158 5179
 	 * Note these tokens are unique per call, NOT static per site for connecting.
5159 5180
 	 *
5160 5181
 	 * @since 2.6
5182
+	 * @param string $action
5161 5183
 	 * @return array
5162 5184
 	 */
5163 5185
 	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
@@ -5691,7 +5713,6 @@  discard block
 block discarded – undo
5691 5713
 	/**
5692 5714
 	 * Report authentication status to the WP REST API.
5693 5715
 	 *
5694
-	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5695 5716
 	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5696 5717
 	 */
5697 5718
 	public function wp_rest_authentication_errors( $value ) {
@@ -5701,6 +5722,10 @@  discard block
 block discarded – undo
5701 5722
 		return $this->rest_authentication_status;
5702 5723
 	}
5703 5724
 
5725
+	/**
5726
+	 * @param integer $timestamp
5727
+	 * @param string $nonce
5728
+	 */
5704 5729
 	function add_nonce( $timestamp, $nonce ) {
5705 5730
 		global $wpdb;
5706 5731
 		static $nonces_used_this_request = array();
@@ -5846,6 +5871,7 @@  discard block
 block discarded – undo
5846 5871
 	 * @param string $key
5847 5872
 	 * @param string $value
5848 5873
 	 * @param bool $restate private
5874
+	 * @return string
5849 5875
 	 */
5850 5876
 	public static function state( $key = null, $value = null, $restate = false ) {
5851 5877
 		static $state = array();
@@ -5902,6 +5928,9 @@  discard block
 block discarded – undo
5902 5928
 		Jetpack::state( null, null, true );
5903 5929
 	}
5904 5930
 
5931
+	/**
5932
+	 * @param string $file
5933
+	 */
5905 5934
 	public static function check_privacy( $file ) {
5906 5935
 		static $is_site_publicly_accessible = null;
5907 5936
 
@@ -6519,9 +6548,7 @@  discard block
 block discarded – undo
6519 6548
 	 *
6520 6549
 	 * Attached to `style_loader_src` filter.
6521 6550
 	 *
6522
-	 * @param string $tag The tag that would link to the external asset.
6523 6551
 	 * @param string $handle The registered handle of the script in question.
6524
-	 * @param string $href The url of the asset in question.
6525 6552
 	 */
6526 6553
 	public static function set_suffix_on_min( $src, $handle ) {
6527 6554
 		if ( false === strpos( $src, '.min.css' ) ) {
@@ -6702,8 +6729,8 @@  discard block
 block discarded – undo
6702 6729
 	 *  - Absolute URLs             `http://domain.com/feh.png`
6703 6730
 	 *  - Domain root relative URLs `/feh.png`
6704 6731
 	 *
6705
-	 * @param $css string: The raw CSS -- should be read in directly from the file.
6706
-	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6732
+	 * @param string $css string: The raw CSS -- should be read in directly from the file.
6733
+	 * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6707 6734
 	 *
6708 6735
 	 * @return mixed|string
6709 6736
 	 */
@@ -6932,7 +6959,7 @@  discard block
 block discarded – undo
6932 6959
 	 *
6933 6960
 	 * @param string $option_name
6934 6961
 	 *
6935
-	 * @return bool
6962
+	 * @return false|null
6936 6963
 	 */
6937 6964
 	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6938 6965
 		// Bail if Jump Start has already been dismissed
@@ -6973,7 +7000,7 @@  discard block
 block discarded – undo
6973 7000
 	/**
6974 7001
 	 * Stores and prints out domains to prefetch for page speed optimization.
6975 7002
 	 *
6976
-	 * @param mixed $new_urls
7003
+	 * @param string[] $new_urls
6977 7004
 	 */
6978 7005
 	public static function dns_prefetch( $new_urls = null ) {
6979 7006
 		static $prefetch_urls = array();
@@ -7019,7 +7046,6 @@  discard block
 block discarded – undo
7019 7046
 	}
7020 7047
 
7021 7048
 	/**
7022
-	 * @param mixed $result Value for the user's option
7023 7049
 	 * @return mixed
7024 7050
 	 */
7025 7051
 	function get_user_option_meta_box_order_dashboard( $sorted ) {
Please login to merge, or discard this patch.
class.jetpack-gutenberg.php 1 patch
Doc Comments   +5 added lines, -6 removed lines patch added patch discarded remove patch
@@ -11,7 +11,7 @@  discard block
 block discarded – undo
11 11
  *
12 12
  * @param string $slug Slug of the block
13 13
  * @param array  $args Arguments that are passed into the register_block_type.
14
- * @param array  $avalibility Arguments that tells us what kind of avalibility the block has
14
+ * @param array  $availability Arguments that tells us what kind of avalibility the block has
15 15
  *
16 16
  * @see register_block_type
17 17
  *
@@ -27,7 +27,7 @@  discard block
 block discarded – undo
27 27
  * Helper function to register a Jetpack Gutenberg plugin
28 28
  *
29 29
  * @param string $slug Slug of the plugin.
30
- * @param array  $avalibility Arguments that tells us what kind of avalibility the plugin has
30
+ * @param array  $availability Arguments that tells us what kind of avalibility the plugin has
31 31
  *
32 32
  * @see register_block_type
33 33
  *
@@ -134,7 +134,6 @@  discard block
 block discarded – undo
134 134
 	/**
135 135
 	 * Add a block to the list of blocks to be registered.
136 136
 	 *
137
-	 * @param string $slug Slug of the block.
138 137
 	 * @param array  $args Arguments that are passed into the register_block_type.
139 138
 	 * @param array $availability array containing if a block is available and the reason when it is not.
140 139
 	 *
@@ -254,7 +253,7 @@  discard block
 block discarded – undo
254 253
 	/**
255 254
 	 * Checks for a given .json file in the blocks folder.
256 255
 	 *
257
-	 * @param $preset The name of the .json file to look for.
256
+	 * @param string $preset The name of the .json file to look for.
258 257
 	 *
259 258
 	 * @return bool True if the file is found.
260 259
 	 */
@@ -265,7 +264,7 @@  discard block
 block discarded – undo
265 264
 	/**
266 265
 	 * Decodes JSON loaded from a preset file in the blocks folder
267 266
 	 *
268
-	 * @param $preset The name of the .json file to load.
267
+	 * @param string $preset The name of the .json file to load.
269 268
 	 *
270 269
 	 * @return mixed Returns an object if the file is present, or false if a valid .json file is not present.
271 270
 	 */
@@ -369,7 +368,7 @@  discard block
 block discarded – undo
369 368
 	 * Only enqueue block assets when needed.
370 369
 	 *
371 370
 	 * @param string $type slug of the block.
372
-	 * @param array $script_dependencies An array of view-side Javascript dependencies to be enqueued.
371
+	 * @param string[] $script_dependencies An array of view-side Javascript dependencies to be enqueued.
373 372
 	 *
374 373
 	 * @return void
375 374
 	 */
Please login to merge, or discard this patch.