Completed
Push — fix/strip-image-dimensions-may... ( 04048d...a84daa )
by
unknown
08:23
created
packages/tracking/src/Tracking.php 1 patch
Doc Comments   -1 removed lines patch added patch discarded remove patch
@@ -183,7 +183,6 @@
 block discarded – undo
183 183
 	/**
184 184
 	 * Record an event in Tracks - this is the preferred way to record events from PHP.
185 185
 	 *
186
-	 * @param mixed  $identity username, user_id, or WP_user object
187 186
 	 * @param string $event_name The name of the event
188 187
 	 * @param array  $properties Custom properties to send with the event
189 188
 	 * @param int    $event_timestamp_millis The time in millis since 1970-01-01 00:00:00 when the event occurred
Please login to merge, or discard this patch.
packages/sync/src/modules/Module.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -53,7 +53,7 @@  discard block
 block discarded – undo
53 53
 	 *
54 54
 	 * @param string $object_type Type of the sync object.
55 55
 	 * @param int    $id          ID of the sync object.
56
-	 * @return mixed Object, or false if the object is invalid.
56
+	 * @return boolean Object, or false if the object is invalid.
57 57
 	 */
58 58
 	public function get_object_by_id( $object_type, $id ) {
59 59
 		return false;
@@ -152,8 +152,8 @@  discard block
 block discarded – undo
152 152
 	 * @access protected
153 153
 	 *
154 154
 	 * @param array $action_names     Action names we're interested in.
155
-	 * @param array $actions_to_count Unfiltered list of actions we want to count.
156
-	 * @return array Number of actions that we're interested in.
155
+	 * @param string[] $actions_to_count Unfiltered list of actions we want to count.
156
+	 * @return integer Number of actions that we're interested in.
157 157
 	 */
158 158
 	protected function count_actions( $action_names, $actions_to_count ) {
159 159
 		return count( array_intersect( $action_names, $actions_to_count ) );
Please login to merge, or discard this patch.
class.json-api.php 1 patch
Doc Comments   +18 added lines, -1 removed lines patch added patch discarded remove patch
@@ -33,6 +33,9 @@  discard block
 block discarded – undo
33 33
 	public $extra_headers = array();
34 34
 
35 35
 	/**
36
+	 * @param string $method
37
+	 * @param string $url
38
+	 * @param string $post_body
36 39
 	 * @return WPCOM_JSON_API instance
37 40
 	 */
38 41
 	static function init( $method = null, $url = null, $post_body = null ) {
@@ -337,6 +340,9 @@  discard block
 block discarded – undo
337 340
 		return call_user_func_array( array( $endpoint, 'callback' ), $path_pieces );
338 341
 	}
339 342
 
343
+	/**
344
+	 * @param integer $status_code
345
+	 */
340 346
 	function output_early( $status_code, $response = null, $content_type = 'application/json' ) {
341 347
 		$exit = $this->exit;
342 348
 		$this->exit = false;
@@ -545,11 +551,18 @@  discard block
 block discarded – undo
545 551
 		return wp_json_encode( $data );
546 552
 	}
547 553
 
554
+	/**
555
+	 * @param string $needle
556
+	 */
548 557
 	function ends_with( $haystack, $needle ) {
549 558
 		return $needle === substr( $haystack, -strlen( $needle ) );
550 559
 	}
551 560
 
552 561
 	// Returns the site's blog_id in the WP.com ecosystem
562
+
563
+	/**
564
+	 * @return integer
565
+	 */
553 566
 	function get_blog_id_for_output() {
554 567
 		return $this->token_details['blog_id'];
555 568
 	}
@@ -572,6 +585,10 @@  discard block
 block discarded – undo
572 585
 	}
573 586
 
574 587
 	// Returns true if the specified blog ID is a restricted blog
588
+
589
+	/**
590
+	 * @param integer $blog_id
591
+	 */
575 592
 	function is_restricted_blog( $blog_id ) {
576 593
 		/**
577 594
 		 * Filters all REST API access and return a 403 unauthorized response for all Restricted blog IDs.
@@ -621,7 +638,7 @@  discard block
 block discarded – undo
621 638
 	/**
622 639
 	 * Counts the number of comments on a site, excluding certain comment types.
623 640
 	 *
624
-	 * @param $post_id int Post ID.
641
+	 * @param integer $post_id int Post ID.
625 642
 	 * @return array Array of counts, matching the output of https://developer.wordpress.org/reference/functions/get_comment_count/.
626 643
 	 */
627 644
 	public function wp_count_comments( $post_id ) {
Please login to merge, or discard this patch.
packages/connection/src/Manager.php 1 patch
Doc Comments   +3 added lines, -2 removed lines patch added patch discarded remove patch
@@ -273,7 +273,7 @@  discard block
 block discarded – undo
273 273
 	/**
274 274
 	 * Verifies the signature of the current request.
275 275
 	 *
276
-	 * @return false|array
276
+	 * @return boolean
277 277
 	 */
278 278
 	public function verify_xml_rpc_signature() {
279 279
 		if ( is_null( $this->xmlrpc_verification ) ) {
@@ -1029,6 +1029,7 @@  discard block
 block discarded – undo
1029 1029
 	 * @param String  $action  The action name.
1030 1030
 	 * @param Integer $user_id The user identifier.
1031 1031
 	 * @param Integer $exp     Expiration time in seconds.
1032
+	 * @return string
1032 1033
 	 */
1033 1034
 	public function generate_secrets( $action, $user_id = false, $exp = 600 ) {
1034 1035
 		$callable = $this->get_secret_callable();
@@ -1419,7 +1420,7 @@  discard block
 block discarded – undo
1419 1420
 	 *
1420 1421
 	 * @param int|false    $user_id   false: Return the Blog Token. int: Return that user's User Token.
1421 1422
 	 * @param string|false $token_key If provided, check that the token matches the provided input.
1422
-	 * @param bool|true    $suppress_errors If true, return a falsy value when the token isn't found; When false, return a descriptive WP_Error when the token isn't found.
1423
+	 * @param boolean    $suppress_errors If true, return a falsy value when the token isn't found; When false, return a descriptive WP_Error when the token isn't found.
1423 1424
 	 *
1424 1425
 	 * @return object|false
1425 1426
 	 */
Please login to merge, or discard this patch.
modules/notes.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -36,6 +36,9 @@
 block discarded – undo
36 36
 		add_action( 'init', array( &$this, 'action_init' ) );
37 37
 	}
38 38
 
39
+	/**
40
+	 * @param string $file
41
+	 */
39 42
 	function wpcom_static_url($file) {
40 43
 		$i = hexdec( substr( md5( $file ), -1 ) ) % 2;
41 44
 		return 'https://s' . $i . '.wp.com' . $file;
Please login to merge, or discard this patch.
class.jetpack-gutenberg.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -456,7 +456,7 @@  discard block
 block discarded – undo
456 456
 	 * Only enqueue block assets when needed.
457 457
 	 *
458 458
 	 * @param string $type Slug of the block.
459
-	 * @param array  $script_dependencies Script dependencies. Will be merged with automatically
459
+	 * @param string[]  $script_dependencies Script dependencies. Will be merged with automatically
460 460
 	 *                                    detected script dependencies from the webpack build.
461 461
 	 *
462 462
 	 * @return void
@@ -697,7 +697,7 @@  discard block
 block discarded – undo
697 697
 	 *
698 698
 	 * @param string $slug  Block slug.
699 699
 	 * @param array  $attr  Block attributes.
700
-	 * @param array  $extra Potential extra classes you may want to provide.
700
+	 * @param string[]  $extra Potential extra classes you may want to provide.
701 701
 	 *
702 702
 	 * @return string $classes List of CSS classes for a block.
703 703
 	 */
Please login to merge, or discard this patch.
class.jetpack.php 1 patch
Doc Comments   +38 added lines, -17 removed lines patch added patch discarded remove patch
@@ -773,7 +773,7 @@  discard block
 block discarded – undo
773 773
 	 * This is ported over from the manage module, which has been deprecated and baked in here.
774 774
 	 *
775 775
 	 * @param $domains
776
-	 * @return array
776
+	 * @return string[]
777 777
 	 */
778 778
 	function allow_wpcom_domain( $domains ) {
779 779
 		if ( empty( $domains ) ) {
@@ -1231,7 +1231,7 @@  discard block
 block discarded – undo
1231 1231
 	}
1232 1232
 	/**
1233 1233
 	 * Does the network allow admins to add new users.
1234
-	 * @return boolian
1234
+	 * @return boolean
1235 1235
 	 */
1236 1236
 	static function network_add_new_users( $option = null ) {
1237 1237
 		return (bool) get_site_option( 'add_new_users' );
@@ -1336,7 +1336,7 @@  discard block
 block discarded – undo
1336 1336
 	 * database which could be set to anything as opposed to what this function returns.
1337 1337
 	 * @param  bool  $option
1338 1338
 	 *
1339
-	 * @return boolean
1339
+	 * @return string
1340 1340
 	 */
1341 1341
 	public function is_main_network_option( $option ) {
1342 1342
 		// return '1' or ''
@@ -1347,7 +1347,7 @@  discard block
 block discarded – undo
1347 1347
 	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1348 1348
 	 *
1349 1349
 	 * @param  string  $option
1350
-	 * @return boolean
1350
+	 * @return string
1351 1351
 	 */
1352 1352
 	public function is_multisite( $option ) {
1353 1353
 		return (string) (bool) is_multisite();
@@ -1409,7 +1409,7 @@  discard block
 block discarded – undo
1409 1409
 
1410 1410
 	/**
1411 1411
 	 * Returns true if the site has file write access false otherwise.
1412
-	 * @return string ( '1' | '0' )
1412
+	 * @return integer ( '1' | '0' )
1413 1413
 	 **/
1414 1414
 	public static function file_system_write_access() {
1415 1415
 		if ( ! function_exists( 'get_filesystem_method' ) ) {
@@ -2143,6 +2143,7 @@  discard block
 block discarded – undo
2143 2143
 	 * @param int $user_id
2144 2144
 	 * @param string $token
2145 2145
 	 * return bool
2146
+	 * @param boolean $is_master_user
2146 2147
 	 */
2147 2148
 	public static function update_user_token( $user_id, $token, $is_master_user ) {
2148 2149
 		// not designed for concurrent updates
@@ -2587,7 +2588,7 @@  discard block
 block discarded – undo
2587 2588
 	 *
2588 2589
 	 * @param string $tag Tag as it appears in each module heading.
2589 2590
 	 *
2590
-	 * @return mixed
2591
+	 * @return string
2591 2592
 	 */
2592 2593
 	public static function translate_module_tag( $tag ) {
2593 2594
 		return jetpack_get_module_i18n_tag( $tag );
@@ -2759,8 +2760,8 @@  discard block
 block discarded – undo
2759 2760
 	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2760 2761
 	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2761 2762
 	 *
2762
-	 * @param $string
2763
-	 * @return mixed
2763
+	 * @param string $string
2764
+	 * @return string|null
2764 2765
 	 */
2765 2766
 	public static function alias_directories( $string ) {
2766 2767
 		// ABSPATH has a trailing slash.
@@ -2771,6 +2772,10 @@  discard block
 block discarded – undo
2771 2772
 		return $string;
2772 2773
 	}
2773 2774
 
2775
+	/**
2776
+	 * @param boolean $redirect
2777
+	 * @param boolean $send_state_messages
2778
+	 */
2774 2779
 	public static function activate_default_modules(
2775 2780
 		$min_version = false,
2776 2781
 		$max_version = false,
@@ -3048,6 +3053,9 @@  discard block
 block discarded – undo
3048 3053
 		return self::update_active_modules( $new );
3049 3054
 	}
3050 3055
 
3056
+	/**
3057
+	 * @param string $module
3058
+	 */
3051 3059
 	public static function enable_module_configurable( $module ) {
3052 3060
 		$module = Jetpack::get_module_slug( $module );
3053 3061
 		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
@@ -3076,6 +3084,9 @@  discard block
 block discarded – undo
3076 3084
 	}
3077 3085
 
3078 3086
 /* Installation */
3087
+	/**
3088
+	 * @param string $message
3089
+	 */
3079 3090
 	public static function bail_on_activation( $message, $deactivate = true ) {
3080 3091
 ?>
3081 3092
 <!doctype html>
@@ -3822,7 +3833,7 @@  discard block
 block discarded – undo
3822 3833
 	 * Add help to the Jetpack page
3823 3834
 	 *
3824 3835
 	 * @since Jetpack (1.2.3)
3825
-	 * @return false if not the Jetpack page
3836
+	 * @return false|null if not the Jetpack page
3826 3837
 	 */
3827 3838
 	function admin_help() {
3828 3839
 		$current_screen = get_current_screen();
@@ -4554,6 +4565,9 @@  discard block
 block discarded – undo
4554 4565
 		return $raw ? esc_url_raw( $url ) : esc_url( $url );
4555 4566
 	}
4556 4567
 
4568
+	/**
4569
+	 * @return string
4570
+	 */
4557 4571
 	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4558 4572
 		if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4559 4573
 			$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
@@ -4693,6 +4707,9 @@  discard block
 block discarded – undo
4693 4707
 		return $url;
4694 4708
 	}
4695 4709
 
4710
+	/**
4711
+	 * @return string
4712
+	 */
4696 4713
 	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4697 4714
 		$actionurl = str_replace( '&amp;', '&', $actionurl );
4698 4715
 		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
@@ -4981,7 +4998,8 @@  discard block
 block discarded – undo
4981 4998
 	 * Note these tokens are unique per call, NOT static per site for connecting.
4982 4999
 	 *
4983 5000
 	 * @since 2.6
4984
-	 * @return array
5001
+	 * @param string $action
5002
+	 * @return boolean
4985 5003
 	 */
4986 5004
 	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4987 5005
 		if ( false === $user_id ) {
@@ -5272,7 +5290,6 @@  discard block
 block discarded – undo
5272 5290
 	/**
5273 5291
 	 * Report authentication status to the WP REST API.
5274 5292
 	 *
5275
-	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5276 5293
 	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5277 5294
 	 */
5278 5295
 	public function wp_rest_authentication_errors( $value ) {
@@ -5374,6 +5391,7 @@  discard block
 block discarded – undo
5374 5391
 	 * @param string $key
5375 5392
 	 * @param string $value
5376 5393
 	 * @param bool $restate private
5394
+	 * @return string
5377 5395
 	 */
5378 5396
 	public static function state( $key = null, $value = null, $restate = false ) {
5379 5397
 		static $state = array();
@@ -5430,6 +5448,9 @@  discard block
 block discarded – undo
5430 5448
 		Jetpack::state( null, null, true );
5431 5449
 	}
5432 5450
 
5451
+	/**
5452
+	 * @param string $file
5453
+	 */
5433 5454
 	public static function check_privacy( $file ) {
5434 5455
 		static $is_site_publicly_accessible = null;
5435 5456
 
@@ -5510,6 +5531,9 @@  discard block
 block discarded – undo
5510 5531
 		}
5511 5532
 	}
5512 5533
 
5534
+	/**
5535
+	 * @param string $url
5536
+	 */
5513 5537
 	public static function staticize_subdomain( $url ) {
5514 5538
 
5515 5539
 		// Extract hostname from URL
@@ -6064,9 +6088,7 @@  discard block
 block discarded – undo
6064 6088
 	 *
6065 6089
 	 * Attached to `style_loader_src` filter.
6066 6090
 	 *
6067
-	 * @param string $tag The tag that would link to the external asset.
6068 6091
 	 * @param string $handle The registered handle of the script in question.
6069
-	 * @param string $href The url of the asset in question.
6070 6092
 	 */
6071 6093
 	public static function set_suffix_on_min( $src, $handle ) {
6072 6094
 		if ( false === strpos( $src, '.min.css' ) ) {
@@ -6254,8 +6276,8 @@  discard block
 block discarded – undo
6254 6276
 	 *  - Absolute URLs             `http://domain.com/feh.png`
6255 6277
 	 *  - Domain root relative URLs `/feh.png`
6256 6278
 	 *
6257
-	 * @param $css string: The raw CSS -- should be read in directly from the file.
6258
-	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6279
+	 * @param string $css string: The raw CSS -- should be read in directly from the file.
6280
+	 * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6259 6281
 	 *
6260 6282
 	 * @return mixed|string
6261 6283
 	 */
@@ -6516,7 +6538,7 @@  discard block
 block discarded – undo
6516 6538
 	/**
6517 6539
 	 * Stores and prints out domains to prefetch for page speed optimization.
6518 6540
 	 *
6519
-	 * @param mixed $new_urls
6541
+	 * @param string[] $new_urls
6520 6542
 	 */
6521 6543
 	public static function dns_prefetch( $new_urls = null ) {
6522 6544
 		static $prefetch_urls = array();
@@ -6573,7 +6595,6 @@  discard block
 block discarded – undo
6573 6595
 	}
6574 6596
 
6575 6597
 	/**
6576
-	 * @param mixed $result Value for the user's option
6577 6598
 	 * @return mixed
6578 6599
 	 */
6579 6600
 	function get_user_option_meta_box_order_dashboard( $sorted ) {
Please login to merge, or discard this patch.