Completed
Push — add/sso-first-time-notice ( e879b5...ee7fa6 )
by Jeremy
07:06
created
modules/contact-form/grunion-contact-form.php 1 patch
Doc Comments   +44 added lines, -2 removed lines patch added patch discarded remove patch
@@ -283,6 +283,9 @@  discard block
 block discarded – undo
283 283
 		return Grunion_Contact_Form::parse( $atts, do_blocks( $content ) );
284 284
 	}
285 285
 
286
+	/**
287
+	 * @param string $type
288
+	 */
286 289
 	public static function block_attributes_to_shortcode_attributes( $atts, $type ) {
287 290
 		$atts['type'] = $type;
288 291
 		if ( isset( $atts['className'] ) ) {
@@ -1878,7 +1881,6 @@  discard block
 block discarded – undo
1878 1881
 	 *
1879 1882
 	 * @see ::style()
1880 1883
 	 * @internal
1881
-	 * @param bool $style
1882 1884
 	 */
1883 1885
 	static function _style_on() {
1884 1886
 		return self::style( true );
@@ -2023,6 +2025,7 @@  discard block
 block discarded – undo
2023 2025
 	 *
2024 2026
 	 * @param int                         $feedback_id
2025 2027
 	 * @param object Grunion_Contact_Form $form
2028
+	 * @param Grunion_Contact_Form $form
2026 2029
 	 *
2027 2030
 	 * @return string $message
2028 2031
 	 */
@@ -2135,7 +2138,7 @@  discard block
 block discarded – undo
2135 2138
 	 *
2136 2139
 	 * @param array       $attributes Key => Value pairs as parsed by shortcode_parse_atts()
2137 2140
 	 * @param string|null $content The shortcode's inner content: [contact-field]$content[/contact-field]
2138
-	 * @return HTML for the contact form field
2141
+	 * @return string for the contact form field
2139 2142
 	 */
2140 2143
 	static function parse_contact_field( $attributes, $content ) {
2141 2144
 		// Don't try to parse contact form fields if not inside a contact form
@@ -3158,6 +3161,9 @@  discard block
 block discarded – undo
3158 3161
 
3159 3162
 	}
3160 3163
 
3164
+	/**
3165
+	 * @param string $type
3166
+	 */
3161 3167
 	function render_input_field( $type, $id, $value, $class, $placeholder, $required ) {
3162 3168
 		return "<input 
3163 3169
 					type='". esc_attr( $type ) ."' 
@@ -3169,24 +3175,40 @@  discard block
 block discarded – undo
3169 3175
 				/>\n";
3170 3176
 	}
3171 3177
 
3178
+	/**
3179
+	 * @param string $class
3180
+	 * @param string $placeholder
3181
+	 */
3172 3182
 	function render_email_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
3173 3183
 		$field = $this->render_label( 'email', $id, $label, $required, $required_field_text );
3174 3184
 		$field .= $this->render_input_field( 'email', $id, $value, $class, $placeholder, $required );
3175 3185
 		return $field;
3176 3186
 	}
3177 3187
 
3188
+	/**
3189
+	 * @param string $class
3190
+	 * @param string $placeholder
3191
+	 */
3178 3192
 	function render_telephone_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
3179 3193
 		$field = $this->render_label( 'telephone', $id, $label, $required, $required_field_text );
3180 3194
 		$field .= $this->render_input_field( 'tel', $id, $value, $class, $placeholder, $required );
3181 3195
 		return $field;
3182 3196
 	}
3183 3197
 
3198
+	/**
3199
+	 * @param string $class
3200
+	 * @param string $placeholder
3201
+	 */
3184 3202
 	function render_url_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
3185 3203
 		$field = $this->render_label( 'url', $id, $label, $required, $required_field_text );
3186 3204
 		$field .= $this->render_input_field( 'url', $id, $value, $class, $placeholder, $required );
3187 3205
 		return $field;
3188 3206
 	}
3189 3207
 
3208
+	/**
3209
+	 * @param string $class
3210
+	 * @param string $placeholder
3211
+	 */
3190 3212
 	function render_textarea_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
3191 3213
 		$field = $this->render_label( 'textarea', 'contact-form-comment-' . $id, $label, $required, $required_field_text );
3192 3214
 		$field .= "<textarea
@@ -3201,6 +3223,9 @@  discard block
 block discarded – undo
3201 3223
 		return $field;
3202 3224
 	}
3203 3225
 
3226
+	/**
3227
+	 * @param string $class
3228
+	 */
3204 3229
 	function render_radio_field( $id, $label, $value, $class, $required, $required_field_text ) {
3205 3230
 		$field = $this->render_label( '', $id, $label, $required, $required_field_text );
3206 3231
 		foreach ( (array) $this->get_attribute( 'options' ) as $optionIndex => $option ) {
@@ -3222,6 +3247,9 @@  discard block
 block discarded – undo
3222 3247
 		return $field;
3223 3248
 	}
3224 3249
 
3250
+	/**
3251
+	 * @param string $class
3252
+	 */
3225 3253
 	function render_checkbox_field( $id, $label, $value, $class, $required, $required_field_text ) {
3226 3254
 		$field = "<label class='grunion-field-label checkbox" . ( $this->is_error() ? ' form-error' : '' ) . "'>";
3227 3255
 			$field .= "\t\t<input type='checkbox' name='" . esc_attr( $id ) . "' value='" . esc_attr__( 'Yes', 'jetpack' ) . "' " . $class . checked( (bool) $value, true, false ) . ' ' . ( $required ? "required aria-required='true'" : '' ) . "/> \n";
@@ -3231,6 +3259,9 @@  discard block
 block discarded – undo
3231 3259
 		return $field;
3232 3260
 	}
3233 3261
 
3262
+	/**
3263
+	 * @param string $class
3264
+	 */
3234 3265
 	function render_checkbox_multiple_field( $id, $label, $value, $class, $required, $required_field_text  ) {
3235 3266
 		$field = $this->render_label( '', $id, $label, $required, $required_field_text );
3236 3267
 		foreach ( (array) $this->get_attribute( 'options' ) as $optionIndex => $option ) {
@@ -3246,6 +3277,9 @@  discard block
 block discarded – undo
3246 3277
 		return $field;
3247 3278
 	}
3248 3279
 
3280
+	/**
3281
+	 * @param string $class
3282
+	 */
3249 3283
 	function render_select_field( $id, $label, $value, $class, $required, $required_field_text ) {
3250 3284
 		$field = $this->render_label( 'select', $id, $label, $required, $required_field_text );
3251 3285
 		$field  .= "\t<select name='" . esc_attr( $id ) . "' id='" . esc_attr( $id ) . "' " . $class . ( $required ? "required aria-required='true'" : '' ) . ">\n";
@@ -3263,6 +3297,10 @@  discard block
 block discarded – undo
3263 3297
 		return $field;
3264 3298
 	}
3265 3299
 
3300
+	/**
3301
+	 * @param string $class
3302
+	 * @param string $placeholder
3303
+	 */
3266 3304
 	function render_date_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
3267 3305
 		$field = $this->render_label( 'date', $id, $label, $required, $required_field_text );
3268 3306
 		$field .= $this->render_input_field( 'text', $id, $value, $class, $placeholder, $required );
@@ -3282,6 +3320,10 @@  discard block
 block discarded – undo
3282 3320
 		return $field;
3283 3321
 	}
3284 3322
 
3323
+	/**
3324
+	 * @param string $class
3325
+	 * @param string $placeholder
3326
+	 */
3285 3327
 	function render_default_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder, $type ) {
3286 3328
 		$field = $this->render_label( $type, $id, $label, $required, $required_field_text );
3287 3329
 		$field .= $this->render_input_field( 'text', $id, $value, $class, $placeholder, $required );
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.
class.jetpack.php 1 patch
Doc Comments   +45 added lines, -16 removed lines patch added patch discarded remove patch
@@ -1222,7 +1222,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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( '&amp;', '&', $actionurl );
4850 4873
 		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
@@ -5056,6 +5079,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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 ) {
Please login to merge, or discard this patch.
modules/theme-tools/compat/jitm-engine.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -14,7 +14,7 @@
 block discarded – undo
14 14
 	/**
15 15
 	 * Add plan highlights to a list
16 16
 	 *
17
-	 * @param $list Message The list to apply to
17
+	 * @param Message $list Message The list to apply to
18 18
 	 * @param $cache Cache The jitm cache
19 19
 	 */
20 20
 	private static function add_plan_highlights_to_list( $list, $cache ) {
Please login to merge, or discard this patch.
modules/theme-tools/compat/jitm-message.php 1 patch
Doc Comments   +20 added lines, -18 removed lines patch added patch discarded remove patch
@@ -794,7 +794,7 @@  discard block
 block discarded – undo
794 794
 	 *
795 795
 	 * @param $external_user_id int The external user id
796 796
 	 *
797
-	 * @return object The rendered rule
797
+	 * @return \stdClass The rendered rule
798 798
 	 */
799 799
 	public function post_render( $external_user_id ) {
800 800
 		// render guides if there's at least one
@@ -849,7 +849,7 @@  discard block
 block discarded – undo
849 849
 	/**
850 850
 	 * Requires a widget to be inactive
851 851
 	 *
852
-	 * @param $widget_slug string The slug of the widget
852
+	 * @param string $widget_slug string The slug of the widget
853 853
 	 *
854 854
 	 * @return $this
855 855
 	 */
@@ -862,7 +862,7 @@  discard block
 block discarded – undo
862 862
 	/**
863 863
 	 * Requires the user or blog owner to be in the gdpr zone
864 864
 	 *
865
-	 * @param $flag bool Whether or not to show in the gdpr zone
865
+	 * @param boolean $flag bool Whether or not to show in the gdpr zone
866 866
 	 *
867 867
 	 * @return $this
868 868
 	 */
@@ -875,7 +875,7 @@  discard block
 block discarded – undo
875 875
 	/**
876 876
 	 * Check if a blog has a specific sticker
877 877
 	 *
878
-	 * @param $sticker string The sticker to check for
878
+	 * @param string $sticker string The sticker to check for
879 879
 	 *
880 880
 	 * @return $this
881 881
 	 */
@@ -888,8 +888,8 @@  discard block
 block discarded – undo
888 888
 	/**
889 889
 	 * Ensure that the browser carries a specific query string
890 890
 	 *
891
-	 * @param $key string The key to check for
892
-	 * @param $value string A regex to match
891
+	 * @param string $key string The key to check for
892
+	 * @param string $value string A regex to match
893 893
 	 *
894 894
 	 * @return $this
895 895
 	 */
@@ -899,6 +899,9 @@  discard block
 block discarded – undo
899 899
 		return $this;
900 900
 	}
901 901
 
902
+	/**
903
+	 * @param boolean $value
904
+	 */
902 905
 	public function with_backups_possible( $value ) {
903 906
 		$this->with_backups = $value;
904 907
 
@@ -943,7 +946,7 @@  discard block
 block discarded – undo
943 946
 	/**
944 947
 	 * Ensure that a specific theme is active
945 948
 	 *
946
-	 * @param $theme
949
+	 * @param string $theme
947 950
 	 *
948 951
 	 * @return $this
949 952
 	 */
@@ -956,7 +959,7 @@  discard block
 block discarded – undo
956 959
 	/**
957 960
 	 * Only show this JITM when the specified plugin is inactive OR not installed
958 961
 	 *
959
-	 * @param $plugin string The path to the plugin
962
+	 * @param string $plugin string The path to the plugin
960 963
 	 *
961 964
 	 * @return $this
962 965
 	 */
@@ -970,7 +973,7 @@  discard block
 block discarded – undo
970 973
 	 * Only show this JITM when the specified plugin is active and installed
971 974
 	 * Multiple calls are treated as OR: if _any_ of the plugins are active, the rule passes
972 975
 	 *
973
-	 * @param $plugin string The path to the plugin
976
+	 * @param string $plugin string The path to the plugin
974 977
 	 *
975 978
 	 * @return $this
976 979
 	 */
@@ -983,7 +986,7 @@  discard block
 block discarded – undo
983 986
 	/**
984 987
 	 * A rule for a plugin being installed but either active or not active
985 988
 	 *
986
-	 * @param $plugin string The path to the plugin
989
+	 * @param string $plugin string The path to the plugin
987 990
 	 *
988 991
 	 * @return $this
989 992
 	 */
@@ -996,7 +999,7 @@  discard block
 block discarded – undo
996 999
 	/**
997 1000
 	 * A rule to check that a specific plugin is not installed
998 1001
 	 *
999
-	 * @param $plugin string The path to the plugin
1002
+	 * @param string $plugin string The path to the plugin
1000 1003
 	 *
1001 1004
 	 * @return $this
1002 1005
 	 */
@@ -1009,7 +1012,7 @@  discard block
 block discarded – undo
1009 1012
 	/**
1010 1013
 	 * Only show if the user is in the specified role
1011 1014
 	 *
1012
-	 * @param $role string The role
1015
+	 * @param string $role string The role
1013 1016
 	 *
1014 1017
 	 * @return $this
1015 1018
 	 */
@@ -1087,7 +1090,7 @@  discard block
 block discarded – undo
1087 1090
 	 *
1088 1091
 	 * The hook to display the content on, such as `admin-notices`
1089 1092
 	 *
1090
-	 * @param $regex string The message path regex
1093
+	 * @param string $regex string The message path regex
1091 1094
 	 *
1092 1095
 	 * @return $this
1093 1096
 	 */
@@ -1130,7 +1133,7 @@  discard block
 block discarded – undo
1130 1133
 	/**
1131 1134
 	 * Set's the priority of this specific jitm if there are any conflicts
1132 1135
 	 *
1133
-	 * @param $priority int The priority. Higher numbers result in a higher priority
1136
+	 * @param integer $priority int The priority. Higher numbers result in a higher priority
1134 1137
 	 *
1135 1138
 	 * @return $this
1136 1139
 	 */
@@ -1178,7 +1181,7 @@  discard block
 block discarded – undo
1178 1181
 	/**
1179 1182
 	 * Set the maximum number of dismissals before this jitm will never be shown again
1180 1183
 	 *
1181
-	 * @param $times int The maximum number of times to show this message
1184
+	 * @param integer $times int The maximum number of times to show this message
1182 1185
 	 *
1183 1186
 	 * @return $this
1184 1187
 	 */
@@ -1244,7 +1247,6 @@  discard block
 block discarded – undo
1244 1247
 	/**
1245 1248
 	 * Sets the ES query to check against the site profile
1246 1249
 	 *
1247
-	 * @param bool $with_plan
1248 1250
 	 *
1249 1251
 	 * @return $this
1250 1252
 	 */
@@ -1303,7 +1305,7 @@  discard block
 block discarded – undo
1303 1305
 	 * Limits the JITM to only the provided types.
1304 1306
 	 * Default: [ 'jetpack' ] (non-Atomic)
1305 1307
 	 *
1306
-	 * @param array $site_types - can include 'jetpack', 'atomic'
1308
+	 * @param string[] $site_types - can include 'jetpack', 'atomic'
1307 1309
 	 *
1308 1310
 	 * @return $this
1309 1311
 	 */
@@ -1342,7 +1344,7 @@  discard block
 block discarded – undo
1342 1344
 	/**
1343 1345
 	 * A rule for a module to be activated
1344 1346
 	 *
1345
-	 * @param $module string Module slug.
1347
+	 * @param string $module string Module slug.
1346 1348
 	 *
1347 1349
 	 * @return $this
1348 1350
 	 */
Please login to merge, or discard this patch.
modules/sso.php 1 patch
Doc Comments   +2 added lines, -3 removed lines patch added patch discarded remove patch
@@ -270,7 +270,7 @@  discard block
 block discarded – undo
270 270
 	 * Validate the require  two step checkbox in Settings > General
271 271
 	 *
272 272
 	 * @since 2.7
273
-	 * @return boolean
273
+	 * @return integer
274 274
 	 **/
275 275
 	public function validate_jetpack_sso_require_two_step( $input ) {
276 276
 		return ( ! empty( $input ) ) ? 1 : 0;
@@ -300,7 +300,7 @@  discard block
 block discarded – undo
300 300
 	 * Validate the match by email check in Settings > General
301 301
 	 *
302 302
 	 * @since 2.9
303
-	 * @return boolean
303
+	 * @return integer
304 304
 	 **/
305 305
 	public function validate_jetpack_sso_match_by_email( $input ) {
306 306
 		return ( ! empty( $input ) ) ? 1 : 0;
@@ -1094,7 +1094,6 @@  discard block
 block discarded – undo
1094 1094
 	 *
1095 1095
 	 * @since 6.9.0
1096 1096
 	 *
1097
-	 * @param string $jitm_id ID of the JITM being displayed.
1098 1097
 	 *
1099 1098
 	 * @return void
1100 1099
 	 */
Please login to merge, or discard this patch.