Inspection of "Run phpbcf for added MediaWiki rules" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — add/phpcs-rules-from-MediaWiki (#17419)

unknown

created 2020-10-08 16:11 UTC

Status

Doc Comments +35 added lines, -17 removed lines patch added patch discarded remove patch

@@ -937,7 +937,7 @@  discard block
 block discarded – undo
 	 * This is ported over from the manage module, which has been deprecated and baked in here.
 	 *
 	 * @param $domains
-	 * @return array
+	 * @return string[]
 	 */
 	function allow_wpcom_domain( $domains ) {
 		if ( empty( $domains ) ) {
@@ -1305,7 +1305,7 @@  discard block
 block discarded – undo
 	/**
 	 * Does the network allow admins to add new users.
 	 *
-	 * @return boolian
+	 * @return boolean
 	 */
 	static function network_add_new_users( $option = null ) {
 		return (bool) get_site_option( 'add_new_users' );
@@ -1415,7 +1415,7 @@  discard block
 block discarded – undo
 	 *
 	 * @param  bool $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1426,7 +1426,7 @@  discard block
 block discarded – undo
 	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
 	 *
 	 * @param  string $option
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_multisite( $option ) {
 		return (string) (bool) is_multisite();
@@ -1489,7 +1489,7 @@  discard block
 block discarded – undo
 	/**
 	 * Returns true if the site has file write access false otherwise.
 	 *
-	 * @return string ( '1' | '0' )
+	 * @return integer ( '1' | '0' )
 	 **/
 	public static function file_system_write_access() {
 		if ( ! function_exists( 'get_filesystem_method' ) ) {
@@ -2217,7 +2217,7 @@  discard block
 block discarded – undo
 	 * @param int    $user_id The user id.
 	 * @param string $token The user token.
 	 * @param bool   $is_master_user Whether the user is the master user.
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public static function update_user_token( $user_id, $token, $is_master_user ) {
 		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
@@ -2662,7 +2662,7 @@  discard block
 block discarded – undo
 	 *
 	 * @param string $tag Tag as it appears in each module heading.
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public static function translate_module_tag( $tag ) {
 		return jetpack_get_module_i18n_tag( $tag );
@@ -2777,8 +2777,8 @@  discard block
 block discarded – undo
 	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
 	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
 	 *
-	 * @param $string
-	 * @return mixed
+	 * @param string $string
+	 * @return string|null
 	 */
 	public static function alias_directories( $string ) {
 		// ABSPATH has a trailing slash.
@@ -2789,6 +2789,10 @@  discard block
 block discarded – undo
 		return $string;
 	}
 
+	/**
+	 * @param boolean $redirect
+	 * @param boolean $send_state_messages
+	 */
 	public static function activate_default_modules(
 		$min_version = false,
 		$max_version = false,
@@ -3072,6 +3076,9 @@  discard block
 block discarded – undo
 		return self::update_active_modules( $new );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function enable_module_configurable( $module ) {
 		$module = self::get_module_slug( $module );
 		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
@@ -3100,6 +3107,10 @@  discard block
 block discarded – undo
 	}
 
 	/* Installation */
+
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 		?>
 <!doctype html>
@@ -3869,7 +3880,7 @@  discard block
 block discarded – undo
 	 * Add help to the Jetpack page
 	 *
 	 * @since Jetpack (1.2.3)
-	 * @return false if not the Jetpack page
+	 * @return false|null if not the Jetpack page
 	 */
 	function admin_help() {
 		$current_screen = get_current_screen();
@@ -4573,6 +4584,7 @@  discard block
 block discarded – undo
 
 	/**
 	 * Record a stat for later output.  This will only currently output in the admin_footer.
+	 * @param string $group
 	 */
 	function stat( $group, $detail ) {
 		$this->initialize_stats();
@@ -4968,6 +4980,9 @@  discard block
 block discarded – undo
 		return $url;
 	}
 
+	/**
+	 * @param string $actionurl
+	 */
 	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
 		$actionurl = str_replace( '&amp;', '&', $actionurl );
 		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
@@ -5270,7 +5285,7 @@  discard block
 block discarded – undo
 	 * @param String  $action  The action name.
 	 * @param Integer $user_id The user identifier.
 	 * @param Integer $exp     Expiration time in seconds.
-	 * @return array
+	 * @return boolean
 	 */
 	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
 		return self::connection()->generate_secrets( $action, $user_id, $exp );
@@ -5526,7 +5541,6 @@  discard block
 block discarded – undo
 	 * @deprecated since 8.9.0
 	 * @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authentication_errors()
 	 *
-	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
 	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
 	 */
 	public function wp_rest_authentication_errors( $value ) {
@@ -5651,6 +5665,7 @@  discard block
 block discarded – undo
 	 * @param string $key
 	 * @param string $value
 	 * @param bool   $restate private
+	 * @return string
 	 */
 	public static function state( $key = null, $value = null, $restate = false ) {
 		static $state = array();
@@ -5732,6 +5747,9 @@  discard block
 block discarded – undo
 		return true;
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5812,6 +5830,9 @@  discard block
 block discarded – undo
 		}
 	}
 
+	/**
+	 * @param string $url
+	 */
 	public static function staticize_subdomain( $url ) {
 
 		// Extract hostname from URL
@@ -6312,9 +6333,7 @@  discard block
 block discarded – undo
 	 *
 	 * Attached to `style_loader_src` filter.
 	 *
-	 * @param string $tag The tag that would link to the external asset.
 	 * @param string $handle The registered handle of the script in question.
-	 * @param string $href The url of the asset in question.
 	 */
 	public static function set_suffix_on_min( $src, $handle ) {
 		if ( false === strpos( $src, '.min.css' ) ) {
@@ -6556,8 +6575,8 @@  discard block
 block discarded – undo
 	 *  - Absolute URLs             `http://domain.com/feh.png`
 	 *  - Domain root relative URLs `/feh.png`
 	 *
-	 * @param $css string: The raw CSS -- should be read in directly from the file.
-	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
+	 * @param string $css string: The raw CSS -- should be read in directly from the file.
+	 * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
 	 *
 	 * @return mixed|string
 	 */
@@ -6856,7 +6875,6 @@  discard block
 block discarded – undo
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {

Please login to merge, or discard this patch.

packages/tracking/src/class-tracking.php 1 patch

Doc Comments +2 added lines, -2 removed lines patch added patch discarded remove patch

@@ -119,8 +119,8 @@
 block discarded – undo
 	/**
 	 * Determines whether tracking should be enabled.
 	 *
-	 * @param Automattic\Jetpack\Terms_Of_Service $terms_of_service A Terms_Of_Service object.
-	 * @param Automattic\Jetpack\Status           $status A Status object.
+	 * @param Terms_Of_Service $terms_of_service A Terms_Of_Service object.
+	 * @param Status           $status A Status object.
 	 *
 	 * @return boolean True if tracking should be enabled, else false.
 	 */

Please login to merge, or discard this patch.

class.jetpack-gutenberg.php 1 patch

Doc Comments +4 added lines, -4 removed lines patch added patch discarded remove patch

@@ -583,7 +583,7 @@  discard block
 block discarded – undo
 	 * Only enqueue block assets when needed.
 	 *
 	 * @param string $type Slug of the block.
-	 * @param array  $script_dependencies Script dependencies. Will be merged with automatically
+	 * @param string[]  $script_dependencies Script dependencies. Will be merged with automatically
 	 *                                    detected script dependencies from the webpack build.
 	 *
 	 * @return void
@@ -837,7 +837,7 @@  discard block
 block discarded – undo
 	 *
 	 * @param string $slug  Block slug.
 	 * @param array  $attr  Block attributes.
-	 * @param array  $extra Potential extra classes you may want to provide.
+	 * @param string[]  $extra Potential extra classes you may want to provide.
 	 *
 	 * @return string $classes List of CSS classes for a block.
 	 */
@@ -934,10 +934,10 @@  discard block
 block discarded – undo
 	 * @since 8.3.0
 	 *
 	 * @param string $url      URL saved as an attribute in block.
-	 * @param array  $allowed  Array of allowed hosts for that block, or regexes to check against.
+	 * @param string[]  $allowed  Array of allowed hosts for that block, or regexes to check against.
 	 * @param bool   $is_regex Array of regexes matching the URL that could be used in block.
 	 *
-	 * @return bool|string
+	 * @return false|string
 	 */
 	public static function validate_block_embed_url( $url, $allowed = array(), $is_regex = false ) {
 		if (

Please login to merge, or discard this patch.

class.jetpack-client-server.php 1 patch

Doc Comments +1 added lines, -1 removed lines patch added patch discarded remove patch

@@ -105,7 +105,7 @@
 block discarded – undo
 	/**
 	 * Returns an instance of the Jetpack object.
 	 *
-	 * @return Automattic\Jetpack
+	 * @return Jetpack
 	 */
 	public function get_jetpack() {
 		return Jetpack::init();

Please login to merge, or discard this patch.

_inc/lib/core-api/load-wpcom-endpoints.php 1 patch

Doc Comments +3 added lines patch added patch discarded remove patch

@@ -15,6 +15,9 @@
 block discarded – undo
 	exit;
 }
 
+/**
+ * @param string $file_pattern
+ */
 function wpcom_rest_api_v2_load_plugin_files( $file_pattern ) {
 	$plugins = glob( __DIR__ . '/' . $file_pattern );
 

Please login to merge, or discard this patch.

_inc/lib/markdown/extra.php 1 patch

Doc Comments +27 added lines, -1 removed lines patch added patch discarded remove patch

@@ -65,7 +65,7 @@  discard block
 block discarded – undo
  *
  * @since 5.9
  *
- * @return string Length of the multibyte string
+ * @return integer Length of the multibyte string
  *
  */
 function jetpack_utf8_strlen( $text ) {
@@ -160,6 +160,9 @@  discard block
 block discarded – undo
 		$this->html_hashes = array();
 	}
 
+	/**
+	 * @param string $text
+	 */
 	function transform($text) {
 	#
 	# Main function. Performs some preprocessing on the input text
@@ -882,6 +885,10 @@  discard block
 block discarded – undo
 
 	public $list_level = 0;
 
+	/**
+	 * @param string $list_str
+	 * @param string $marker_any_re
+	 */
 	function processListItems($list_str, $marker_any_re) {
 	#
 	#	Process the contents of a single ordered or unordered list, splitting it
@@ -983,6 +990,9 @@  discard block
 block discarded – undo
 		return "\n\n".$this->hashBlock($codeblock)."\n\n";
 	}
 
+	/**
+	 * @param string $code
+	 */
 	function makeCodeSpan($code) {
 	#
 	# Create a code span markup for $code. Called from handleSpanToken.
@@ -1464,6 +1474,9 @@  discard block
 block discarded – undo
 	# hanlde UTF-8 if the default function does not exist.
 	public $utf8_strlen = 'mb_strlen';
 
+	/**
+	 * @param string $text
+	 */
 	function detab($text) {
 	#
 	# Replace tabs with the appropriate amount of space.
@@ -1998,6 +2011,12 @@  discard block
 block discarded – undo
 
 		return array($parsed, $text);
 	}
+
+	/**
+	 * @param string $text
+	 * @param string $hash_method
+	 * @param boolean $md_attr
+	 */
 	function _hashHTMLBlocks_inHTML($text, $hash_method, $md_attr) {
 	#
 	# Parse HTML, calling _HashHTMLBlocks_InMarkdown for block tags.
@@ -2654,6 +2673,9 @@  discard block
 block discarded – undo
 		return $this->hashBlock($result) . "\n\n";
 	}
 
+	/**
+	 * @return string
+	 */
 	function processDefListItems($list_str) {
 	#
 	#	Process the contents of a single definition list, splitting it
@@ -2764,6 +2786,10 @@  discard block
 block discarded – undo
 
 		return $text;
 	}
+
+	/**
+	 * @param string[] $matches
+	 */
 	function _doFencedCodeBlocks_callback($matches) {
 		$classname =& $matches[2];
 		$attrs     =& $matches[3];

Please login to merge, or discard this patch.

json-endpoints/class.wpcom-json-api-site-settings-v1-2-endpoint.php 1 patch

Doc Comments +3 added lines patch added patch discarded remove patch

@@ -131,6 +131,9 @@
 block discarded – undo
 		return parent::callback( $path, $blog_id );
 	}
 
+	/**
+	 * @param string $key
+	 */
 	protected function get_locale( $key ) {
 		if ( 'locale' == $key ) {
 			if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {

Please login to merge, or discard this patch.

json-endpoints/jetpack/class.jetpack-json-api-plugins-endpoint.php 1 patch

Doc Comments +3 added lines patch added patch discarded remove patch

@@ -303,6 +303,9 @@
 block discarded – undo
 		return true;
 	}
 
+	/**
+	 * @param string $plugin
+	 */
 	protected function validate_plugin( $plugin ) {
 		if ( ! isset( $plugin) || empty( $plugin ) ) {
 			return new WP_Error( 'missing_plugin', __( 'You are required to specify a plugin to activate.', 'jetpack' ), 400 );

Please login to merge, or discard this patch.

sal/class.json-api-site-jetpack-base.php 1 patch

Doc Comments +13 added lines patch added patch discarded remove patch

@@ -2,10 +2,20 @@  discard block
 block discarded – undo
 require_once __DIR__ . '/class.json-api-site-base.php';
 
 abstract class Abstract_Jetpack_Site extends SAL_Site {
+
+	/**
+	 * @param string $name
+	 */
 	abstract protected function get_constant( $name );
 
+	/**
+	 * @param string $feature_name
+	 */
 	abstract protected function current_theme_supports( $feature_name );
 
+	/**
+	 * @param string $feature_name
+	 */
 	abstract protected function get_theme_support( $feature_name );
 
 	abstract protected function get_mock_option( $name );
@@ -14,6 +24,9 @@  discard block
 block discarded – undo
 
 	abstract public function get_updates();
 
+	/**
+	 * @return string
+	 */
 	abstract protected function main_network_site();
 
 	abstract protected function wp_version();

Please login to merge, or discard this patch.

		@@ -119,8 +119,8 @@
		block discarded – undo
119	119	/**
120	120	* Determines whether tracking should be enabled.
121	121	*
122		- * @param Automattic\Jetpack\Terms_Of_Service $terms_of_service A Terms_Of_Service object.
123		- * @param Automattic\Jetpack\Status $status A Status object.
	122	+ * @param Terms_Of_Service $terms_of_service A Terms_Of_Service object.
	123	+ * @param Status $status A Status object.
124	124	*
125	125	* @return boolean True if tracking should be enabled, else false.
126	126	*/

		@@ -131,6 +131,9 @@
		block discarded – undo
131	131	return parent::callback( $path, $blog_id );
132	132	}
133	133
	134	+ /**
	135	+ * @param string $key
	136	+ */
134	137	protected function get_locale( $key ) {
135	138	if ( 'locale' == $key ) {
136	139	if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {

		@@ -937,7 +937,7 @@ discard block
		block discarded – undo
937	937	* This is ported over from the manage module, which has been deprecated and baked in here.
938	938	*
939	939	* @param $domains
940		- * @return array
	940	+ * @return string[]
941	941	*/
942	942	function allow_wpcom_domain( $domains ) {
943	943	if ( empty( $domains ) ) {
		@@ -1305,7 +1305,7 @@ discard block
		block discarded – undo
1305	1305	/**
1306	1306	* Does the network allow admins to add new users.
1307	1307	*
1308		- * @return boolian
	1308	+ * @return boolean
1309	1309	*/
1310	1310	static function network_add_new_users( $option = null ) {
1311	1311	return (bool) get_site_option( 'add_new_users' );
		@@ -1415,7 +1415,7 @@ discard block
		block discarded – undo
1415	1415	*
1416	1416	* @param bool $option
1417	1417	*
1418		- * @return boolean
	1418	+ * @return string
1419	1419	*/
1420	1420	public function is_main_network_option( $option ) {
1421	1421	// return '1' or ''
		@@ -1426,7 +1426,7 @@ discard block
		block discarded – undo
1426	1426	* Return true if we are with multi-site or multi-network false if we are dealing with single site.
1427	1427	*
1428	1428	* @param string $option
1429		- * @return boolean
	1429	+ * @return string
1430	1430	*/
1431	1431	public function is_multisite( $option ) {
1432	1432	return (string) (bool) is_multisite();
		@@ -1489,7 +1489,7 @@ discard block
		block discarded – undo
1489	1489	/**
1490	1490	* Returns true if the site has file write access false otherwise.
1491	1491	*
1492		- * @return string ( '1' \| '0' )
	1492	+ * @return integer ( '1' \| '0' )
1493	1493	**/
1494	1494	public static function file_system_write_access() {
1495	1495	if ( ! function_exists( 'get_filesystem_method' ) ) {
		@@ -2217,7 +2217,7 @@ discard block
		block discarded – undo
2217	2217	* @param int $user_id The user id.
2218	2218	* @param string $token The user token.
2219	2219	* @param bool $is_master_user Whether the user is the master user.
2220		- * @return bool
	2220	+ * @return boolean\|null
2221	2221	*/
2222	2222	public static function update_user_token( $user_id, $token, $is_master_user ) {
2223	2223	_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
		@@ -2662,7 +2662,7 @@ discard block
		block discarded – undo
2662	2662	*
2663	2663	* @param string $tag Tag as it appears in each module heading.
2664	2664	*
2665		- * @return mixed
	2665	+ * @return string
2666	2666	*/
2667	2667	public static function translate_module_tag( $tag ) {
2668	2668	return jetpack_get_module_i18n_tag( $tag );
		@@ -2777,8 +2777,8 @@ discard block
		block discarded – undo
2777	2777	* Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2778	2778	* is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2779	2779	*
2780		- * @param $string
2781		- * @return mixed
	2780	+ * @param string $string
	2781	+ * @return string\|null
2782	2782	*/
2783	2783	public static function alias_directories( $string ) {
2784	2784	// ABSPATH has a trailing slash.
		@@ -2789,6 +2789,10 @@ discard block
		block discarded – undo
2789	2789	return $string;
2790	2790	}
2791	2791
	2792	+ /**
	2793	+ * @param boolean $redirect
	2794	+ * @param boolean $send_state_messages
	2795	+ */
2792	2796	public static function activate_default_modules(
2793	2797	$min_version = false,
2794	2798	$max_version = false,
		@@ -3072,6 +3076,9 @@ discard block
		block discarded – undo
3072	3076	return self::update_active_modules( $new );
3073	3077	}
3074	3078
	3079	+ /**
	3080	+ * @param string $module
	3081	+ */
3075	3082	public static function enable_module_configurable( $module ) {
3076	3083	$module = self::get_module_slug( $module );
3077	3084	add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
		@@ -3100,6 +3107,10 @@ discard block
		block discarded – undo
3100	3107	}
3101	3108
3102	3109	/* Installation */
	3110	+
	3111	+ /**
	3112	+ * @param string $message
	3113	+ */
3103	3114	public static function bail_on_activation( $message, $deactivate = true ) {
3104	3115	?>
3105	3116	<!doctype html>
		@@ -3869,7 +3880,7 @@ discard block
		block discarded – undo
3869	3880	* Add help to the Jetpack page
3870	3881	*
3871	3882	* @since Jetpack (1.2.3)
3872		- * @return false if not the Jetpack page
	3883	+ * @return false\|null if not the Jetpack page
3873	3884	*/
3874	3885	function admin_help() {
3875	3886	$current_screen = get_current_screen();
		@@ -4573,6 +4584,7 @@ discard block
		block discarded – undo
4573	4584
4574	4585	/**
4575	4586	* Record a stat for later output. This will only currently output in the admin_footer.
	4587	+ * @param string $group
4576	4588	*/
4577	4589	function stat( $group, $detail ) {
4578	4590	$this->initialize_stats();
		@@ -4968,6 +4980,9 @@ discard block
		block discarded – undo
4968	4980	return $url;
4969	4981	}
4970	4982
	4983	+ /**
	4984	+ * @param string $actionurl
	4985	+ */
4971	4986	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4972	4987	$actionurl = str_replace( '&', '&', $actionurl );
4973	4988	return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
		@@ -5270,7 +5285,7 @@ discard block
		block discarded – undo
5270	5285	* @param String $action The action name.
5271	5286	* @param Integer $user_id The user identifier.
5272	5287	* @param Integer $exp Expiration time in seconds.
5273		- * @return array
	5288	+ * @return boolean
5274	5289	*/
5275	5290	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5276	5291	return self::connection()->generate_secrets( $action, $user_id, $exp );
		@@ -5526,7 +5541,6 @@ discard block
		block discarded – undo
5526	5541	* @deprecated since 8.9.0
5527	5542	* @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authentication_errors()
5528	5543	*
5529		- * @param WP_Error\|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5530	5544	* @return WP_Error\|boolean\|null {@see WP_JSON_Server::check_authentication}
5531	5545	*/
5532	5546	public function wp_rest_authentication_errors( $value ) {
		@@ -5651,6 +5665,7 @@ discard block
		block discarded – undo
5651	5665	* @param string $key
5652	5666	* @param string $value
5653	5667	* @param bool $restate private
	5668	+ * @return string
5654	5669	*/
5655	5670	public static function state( $key = null, $value = null, $restate = false ) {
5656	5671	static $state = array();
		@@ -5732,6 +5747,9 @@ discard block
		block discarded – undo
5732	5747	return true;
5733	5748	}
5734	5749
	5750	+ /**
	5751	+ * @param string $file
	5752	+ */
5735	5753	public static function check_privacy( $file ) {
5736	5754	static $is_site_publicly_accessible = null;
5737	5755
		@@ -5812,6 +5830,9 @@ discard block
		block discarded – undo
5812	5830	}
5813	5831	}
5814	5832
	5833	+ /**
	5834	+ * @param string $url
	5835	+ */
5815	5836	public static function staticize_subdomain( $url ) {
5816	5837
5817	5838	// Extract hostname from URL
		@@ -6312,9 +6333,7 @@ discard block
		block discarded – undo
6312	6333	*
6313	6334	* Attached to `style_loader_src` filter.
6314	6335	*
6315		- * @param string $tag The tag that would link to the external asset.
6316	6336	* @param string $handle The registered handle of the script in question.
6317		- * @param string $href The url of the asset in question.
6318	6337	*/
6319	6338	public static function set_suffix_on_min( $src, $handle ) {
6320	6339	if ( false === strpos( $src, '.min.css' ) ) {
		@@ -6556,8 +6575,8 @@ discard block
		block discarded – undo
6556	6575	* - Absolute URLs `http://domain.com/feh.png`
6557	6576	* - Domain root relative URLs `/feh.png`
6558	6577	*
6559		- * @param $css string: The raw CSS -- should be read in directly from the file.
6560		- * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
	6578	+ * @param string $css string: The raw CSS -- should be read in directly from the file.
	6579	+ * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6561	6580	*
6562	6581	* @return mixed\|string
6563	6582	*/
		@@ -6856,7 +6875,6 @@ discard block
		block discarded – undo
6856	6875	}
6857	6876
6858	6877	/**
6859		- * @param mixed $result Value for the user's option
6860	6878	* @return mixed
6861	6879	*/
6862	6880	function get_user_option_meta_box_order_dashboard( $sorted ) {

		@@ -583,7 +583,7 @@ discard block
		block discarded – undo
583	583	* Only enqueue block assets when needed.
584	584	*
585	585	* @param string $type Slug of the block.
586		- * @param array $script_dependencies Script dependencies. Will be merged with automatically
	586	+ * @param string[] $script_dependencies Script dependencies. Will be merged with automatically
587	587	* detected script dependencies from the webpack build.
588	588	*
589	589	* @return void
		@@ -837,7 +837,7 @@ discard block
		block discarded – undo
837	837	*
838	838	* @param string $slug Block slug.
839	839	* @param array $attr Block attributes.
840		- * @param array $extra Potential extra classes you may want to provide.
	840	+ * @param string[] $extra Potential extra classes you may want to provide.
841	841	*
842	842	* @return string $classes List of CSS classes for a block.
843	843	*/
		@@ -934,10 +934,10 @@ discard block
		block discarded – undo
934	934	* @since 8.3.0
935	935	*
936	936	* @param string $url URL saved as an attribute in block.
937		- * @param array $allowed Array of allowed hosts for that block, or regexes to check against.
	937	+ * @param string[] $allowed Array of allowed hosts for that block, or regexes to check against.
938	938	* @param bool $is_regex Array of regexes matching the URL that could be used in block.
939	939	*
940		- * @return bool\|string
	940	+ * @return false\|string
941	941	*/
942	942	public static function validate_block_embed_url( $url, $allowed = array(), $is_regex = false ) {
943	943	if (

		@@ -105,7 +105,7 @@
		block discarded – undo
105	105	/**
106	106	* Returns an instance of the Jetpack object.
107	107	*
108		- * @return Automattic\Jetpack
	108	+ * @return Jetpack
109	109	*/
110	110	public function get_jetpack() {
111	111	return Jetpack::init();

		@@ -15,6 +15,9 @@
		block discarded – undo
15	15	exit;
16	16	}
17	17
	18	+/**
	19	+ * @param string $file_pattern
	20	+ */
18	21	function wpcom_rest_api_v2_load_plugin_files( $file_pattern ) {
19	22	$plugins = glob( __DIR__ . '/' . $file_pattern );
20	23

		@@ -65,7 +65,7 @@ discard block
		block discarded – undo
65	65	*
66	66	* @since 5.9
67	67	*
68		- * @return string Length of the multibyte string
	68	+ * @return integer Length of the multibyte string
69	69	*
70	70	*/
71	71	function jetpack_utf8_strlen( $text ) {
		@@ -160,6 +160,9 @@ discard block
		block discarded – undo
160	160	$this->html_hashes = array();
161	161	}
162	162
	163	+ /**
	164	+ * @param string $text
	165	+ */
163	166	function transform($text) {
164	167	#
165	168	# Main function. Performs some preprocessing on the input text
		@@ -882,6 +885,10 @@ discard block
		block discarded – undo
882	885
883	886	public $list_level = 0;
884	887
	888	+ /**
	889	+ * @param string $list_str
	890	+ * @param string $marker_any_re
	891	+ */
885	892	function processListItems($list_str, $marker_any_re) {
886	893	#
887	894	# Process the contents of a single ordered or unordered list, splitting it
		@@ -983,6 +990,9 @@ discard block
		block discarded – undo
983	990	return "\n\n".$this->hashBlock($codeblock)."\n\n";
984	991	}
985	992
	993	+ /**
	994	+ * @param string $code
	995	+ */
986	996	function makeCodeSpan($code) {
987	997	#
988	998	# Create a code span markup for $code. Called from handleSpanToken.
		@@ -1464,6 +1474,9 @@ discard block
		block discarded – undo
1464	1474	# hanlde UTF-8 if the default function does not exist.
1465	1475	public $utf8_strlen = 'mb_strlen';
1466	1476
	1477	+ /**
	1478	+ * @param string $text
	1479	+ */
1467	1480	function detab($text) {
1468	1481	#
1469	1482	# Replace tabs with the appropriate amount of space.
		@@ -1998,6 +2011,12 @@ discard block
		block discarded – undo
1998	2011
1999	2012	return array($parsed, $text);
2000	2013	}
	2014	+
	2015	+ /**
	2016	+ * @param string $text
	2017	+ * @param string $hash_method
	2018	+ * @param boolean $md_attr
	2019	+ */
2001	2020	function _hashHTMLBlocks_inHTML($text, $hash_method, $md_attr) {
2002	2021	#
2003	2022	# Parse HTML, calling _HashHTMLBlocks_InMarkdown for block tags.
		@@ -2654,6 +2673,9 @@ discard block
		block discarded – undo
2654	2673	return $this->hashBlock($result) . "\n\n";
2655	2674	}
2656	2675
	2676	+ /**
	2677	+ * @return string
	2678	+ */
2657	2679	function processDefListItems($list_str) {
2658	2680	#
2659	2681	# Process the contents of a single definition list, splitting it
		@@ -2764,6 +2786,10 @@ discard block
		block discarded – undo
2764	2786
2765	2787	return $text;
2766	2788	}
	2789	+
	2790	+ /**
	2791	+ * @param string[] $matches
	2792	+ */
2767	2793	function _doFencedCodeBlocks_callback($matches) {
2768	2794	$classname =& $matches[2];
2769	2795	$attrs =& $matches[3];

		@@ -303,6 +303,9 @@
		block discarded – undo
303	303	return true;
304	304	}
305	305
	306	+ /**
	307	+ * @param string $plugin
	308	+ */
306	309	protected function validate_plugin( $plugin ) {
307	310	if ( ! isset( $plugin) \|\| empty( $plugin ) ) {
308	311	return new WP_Error( 'missing_plugin', __( 'You are required to specify a plugin to activate.', 'jetpack' ), 400 );

		@@ -2,10 +2,20 @@ discard block
		block discarded – undo
2	2	require_once __DIR__ . '/class.json-api-site-base.php';
3	3
4	4	abstract class Abstract_Jetpack_Site extends SAL_Site {
	5	+
	6	+ /**
	7	+ * @param string $name
	8	+ */
5	9	abstract protected function get_constant( $name );
6	10
	11	+ /**
	12	+ * @param string $feature_name
	13	+ */
7	14	abstract protected function current_theme_supports( $feature_name );
8	15
	16	+ /**
	17	+ * @param string $feature_name
	18	+ */
9	19	abstract protected function get_theme_support( $feature_name );
10	20
11	21	abstract protected function get_mock_option( $name );
		@@ -14,6 +24,9 @@ discard block
		block discarded – undo
14	24
15	25	abstract public function get_updates();
16	26
	27	+ /**
	28	+ * @return string
	29	+ */
17	30	abstract protected function main_network_site();
18	31
19	32	abstract protected function wp_version();

Automattic / jetpack

Pull Request — add/phpcs-rules-from-MediaWiki (#17419)

Status

Category

Doc Comments +35 added lines, -17 removed lines patch added patch discarded remove patch

Doc Comments +2 added lines, -2 removed lines patch added patch discarded remove patch

Doc Comments +4 added lines, -4 removed lines patch added patch discarded remove patch

Doc Comments +1 added lines, -1 removed lines patch added patch discarded remove patch

Doc Comments +3 added lines patch added patch discarded remove patch

Doc Comments +27 added lines, -1 removed lines patch added patch discarded remove patch

Doc Comments +3 added lines patch added patch discarded remove patch

Doc Comments +3 added lines patch added patch discarded remove patch

Doc Comments +13 added lines patch added patch discarded remove patch