Inspection of "[not verified] AMP: allow the display of the admin..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — branch-8.4 ( 2b405d...95d4b8 )

by Jeremy

created 2020-04-14 12:16 UTC

Status

Doc Comments +32 added lines, -18 removed lines patch added patch discarded remove patch

@@ -807,7 +807,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 ) ) {
@@ -1222,7 +1222,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' );
@@ -1332,7 +1332,7 @@  discard block
 block discarded – undo
 	 *
 	 * @param  bool $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1343,7 +1343,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();
@@ -1406,7 +1406,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' ) ) {
@@ -2142,7 +2142,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' );
@@ -2585,7 +2585,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 );
@@ -2757,8 +2757,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.
@@ -2769,6 +2769,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,
@@ -3052,6 +3056,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' );
@@ -3080,6 +3087,10 @@  discard block
 block discarded – undo
 	}
 
 	/* Installation */
+
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 		?>
 <!doctype html>
@@ -3829,7 +3840,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();
@@ -5126,7 +5137,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 );
@@ -5433,7 +5444,6 @@  discard block
 block discarded – undo
 	/**
 	 * Report authentication status to the WP REST API.
 	 *
-	 * @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 ) {
@@ -5535,6 +5545,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();
@@ -5593,6 +5604,9 @@  discard block
 block discarded – undo
 		self::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5673,6 +5687,9 @@  discard block
 block discarded – undo
 		}
 	}
 
+	/**
+	 * @param string $url
+	 */
 	public static function staticize_subdomain( $url ) {
 
 		// Extract hostname from URL
@@ -6242,9 +6259,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' ) ) {
@@ -6435,8 +6450,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
 	 */
@@ -6697,7 +6712,7 @@  discard block
 block discarded – undo
 	/**
 	 * Stores and prints out domains to prefetch for page speed optimization.
 	 *
-	 * @param mixed $new_urls
+	 * @param string[] $new_urls
 	 */
 	public static function dns_prefetch( $new_urls = null ) {
 		static $prefetch_urls = array();
@@ -6754,7 +6769,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/status/tests/php/test_Status.php 1 patch

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

@@ -205,8 +205,7 @@  discard block
 block discarded – undo
 	/**
 	 * Mock a set of constants.
 	 *
-	 * @param array $args Array of sets with constants and their respective values.
-	 * @return phpmock\Mock The mock object.
+	 * @return phpmock\Mock[] The mock object.
 	 */
 	protected function mock_constants( $constants = array() ) {
 		$prepare_constant = function( $constant ) {
@@ -222,7 +221,7 @@  discard block
 block discarded – undo
 	/**
 	 * Mock $wpdb->get_var() and make it return a certain value.
 	 *
-	 * @param mixed  $return_value  Return value of the function.
+	 * @param integer  $return_value  Return value of the function.
 	 * @return PHPUnit\Framework\MockObject\MockObject The mock object.
 	 */
 	protected function mock_wpdb_get_var( $return_value = null ) {

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

@@ -8,6 +8,9 @@
 block discarded – undo
  *  - wp-content/rest-api-plugins/jetpack-endpoints/
  */
 
+/**
+ * @param string $file_pattern
+ */
 function wpcom_rest_api_v2_load_plugin_files( $file_pattern ) {
 	$plugins = glob( dirname( __FILE__ ) . '/' . $file_pattern );
 

Please login to merge, or discard this patch.

packages/sync/src/class-functions.php 1 patch

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

@@ -181,7 +181,7 @@  discard block
 block discarded – undo
 	/**
 	 * Return a hosting provider using a set of known constants.
 	 *
-	 * @return mixed A host identifier string or false.
+	 * @return string|false A host identifier string or false.
 	 */
 	public function get_hosting_provider_by_known_constant() {
 		$hosting_provider_constants = array(
@@ -209,7 +209,7 @@  discard block
 block discarded – undo
 	/**
 	 * Return a hosting provider using a set of known classes.
 	 *
-	 * @return mixed A host identifier string or false.
+	 * @return string|false A host identifier string or false.
 	 */
 	public function get_hosting_provider_by_known_class() {
 		$hosting_provider = false;
@@ -226,7 +226,7 @@  discard block
 block discarded – undo
 	/**
 	 * Return a hosting provider using a set of known functions.
 	 *
-	 * @return mixed A host identifier string or false.
+	 * @return string|false A host identifier string or false.
 	 */
 	public function get_hosting_provider_by_known_function() {
 		$hosting_provider = false;
@@ -441,7 +441,7 @@  discard block
 block discarded – undo
 	 *
 	 * @param string   $option Option value from the site.
 	 * @param callable $url_function Function retrieving the URL to normalize.
-	 * @return mixed|string URL.
+	 * @return callable URL.
 	 */
 	public static function normalize_www_in_url( $option, $url_function ) {
 		$url        = wp_parse_url( call_user_func( $url_function ) );

Please login to merge, or discard this patch.

packages/sync/src/class-listener.php 1 patch

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

@@ -157,7 +157,7 @@  discard block
 block discarded – undo
 	 * Prevent adding items to the queue if it hasn't sent an item for 15 mins
 	 * AND the queue is over 1000 items long (by default).
 	 *
-	 * @param object $queue Sync queue.
+	 * @param string $queue Sync queue.
 	 * @return bool
 	 */
 	public function can_add_to_queue( $queue ) {
@@ -360,7 +360,7 @@  discard block
 block discarded – undo
 	 * Sync Data Loss Handler
 	 *
 	 * @param Queue $queue Sync queue.
-	 * @return boolean was send successful
+	 * @return null|Items was send successful
 	 */
 	public function sync_data_loss( $queue ) {
 		if ( ! Settings::is_sync_enabled() ) {

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

@@ -35,6 +35,9 @@  discard block
 block discarded – undo
 	public $amp_source_origin = null;
 
 	/**
+	 * @param string $method
+	 * @param string $url
+	 * @param string $post_body
 	 * @return WPCOM_JSON_API instance
 	 */
 	static function init( $method = null, $url = null, $post_body = null ) {
@@ -348,6 +351,9 @@  discard block
 block discarded – undo
 		return call_user_func_array( array( $endpoint, 'callback' ), $path_pieces );
 	}
 
+	/**
+	 * @param integer $status_code
+	 */
 	function output_early( $status_code, $response = null, $content_type = 'application/json' ) {
 		$exit       = $this->exit;
 		$this->exit = false;
@@ -572,11 +578,18 @@  discard block
 block discarded – undo
 		return wp_json_encode( $data );
 	}
 
+	/**
+	 * @param string $needle
+	 */
 	function ends_with( $haystack, $needle ) {
 		return $needle === substr( $haystack, -strlen( $needle ) );
 	}
 
 	// Returns the site's blog_id in the WP.com ecosystem
+
+	/**
+	 * @return integer
+	 */
 	function get_blog_id_for_output() {
 		return $this->token_details['blog_id'];
 	}
@@ -599,6 +612,10 @@  discard block
 block discarded – undo
 	}
 
 	// Returns true if the specified blog ID is a restricted blog
+
+	/**
+	 * @param integer $blog_id
+	 */
 	function is_restricted_blog( $blog_id ) {
 		/**
 		 * Filters all REST API access and return a 403 unauthorized response for all Restricted blog IDs.
@@ -648,7 +665,7 @@  discard block
 block discarded – undo
 	/**
 	 * Counts the number of comments on a site, excluding certain comment types.
 	 *
-	 * @param $post_id int Post ID.
+	 * @param integer $post_id int Post ID.
 	 * @return array Array of counts, matching the output of https://developer.wordpress.org/reference/functions/get_comment_count/.
 	 */
 	public function wp_count_comments( $post_id ) {

Please login to merge, or discard this patch.

class.json-api-endpoints.php 1 patch

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

@@ -1540,6 +1540,7 @@  discard block
 block discarded – undo
 	 * timezone set in the options table for the blog or the GMT offset.
 	 *
 	 * @param datetime string $date_string Date to parse.
+	 * @param string $date_string
 	 *
 	 * @return array( $local_time_string, $gmt_time_string )
 	 */
@@ -1649,6 +1650,10 @@  discard block
 block discarded – undo
 		do_action( 'restapi_theme_init' );
 	}
 
+	/**
+	 * @param string $from_hook
+	 * @param string $to_hook
+	 */
 	function copy_hooks( $from_hook, $to_hook, $base_paths ) {
 		global $wp_filter;
 		foreach ( $wp_filter as $hook => $actions ) {
@@ -2073,7 +2078,7 @@  discard block
 block discarded – undo
 	 * Get an array of all valid AMP origins for a blog's siteurl.
 	 *
 	 * @param string $siteurl Origin url of the API request.
-	 * @return array
+	 * @return string[]
 	 */
 	public function get_amp_cache_origins( $siteurl ) {
 		$host = parse_url( $siteurl, PHP_URL_HOST );

Please login to merge, or discard this patch.

class.jetpack-gutenberg.php 1 patch

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

@@ -518,7 +518,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
@@ -866,10 +866,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.

_inc/lib/class-jetpack-podcast-helper.php 1 patch

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

@@ -58,7 +58,7 @@
 block discarded – undo
 	 * Loads an RSS feed using `fetch_feed`.
 	 *
 	 * @param string $feed        The RSS feed URL to load.
-	 * @return SimplePie|WP_Error The RSS object or error.
+	 * @return string The RSS object or error.
 	 */
 	private static function load_feed( $feed ) {
 		$rss = fetch_feed( esc_url_raw( $feed ) );

Please login to merge, or discard this patch.

		@@ -157,7 +157,7 @@ discard block
		block discarded – undo
157	157	* Prevent adding items to the queue if it hasn't sent an item for 15 mins
158	158	* AND the queue is over 1000 items long (by default).
159	159	*
160		- * @param object $queue Sync queue.
	160	+ * @param string $queue Sync queue.
161	161	* @return bool
162	162	*/
163	163	public function can_add_to_queue( $queue ) {
		@@ -360,7 +360,7 @@ discard block
		block discarded – undo
360	360	* Sync Data Loss Handler
361	361	*
362	362	* @param Queue $queue Sync queue.
363		- * @return boolean was send successful
	363	+ * @return null\|Items was send successful
364	364	*/
365	365	public function sync_data_loss( $queue ) {
366	366	if ( ! Settings::is_sync_enabled() ) {

		@@ -1540,6 +1540,7 @@ discard block
		block discarded – undo
1540	1540	* timezone set in the options table for the blog or the GMT offset.
1541	1541	*
1542	1542	* @param datetime string $date_string Date to parse.
	1543	+ * @param string $date_string
1543	1544	*
1544	1545	* @return array( $local_time_string, $gmt_time_string )
1545	1546	*/
		@@ -1649,6 +1650,10 @@ discard block
		block discarded – undo
1649	1650	do_action( 'restapi_theme_init' );
1650	1651	}
1651	1652
	1653	+ /**
	1654	+ * @param string $from_hook
	1655	+ * @param string $to_hook
	1656	+ */
1652	1657	function copy_hooks( $from_hook, $to_hook, $base_paths ) {
1653	1658	global $wp_filter;
1654	1659	foreach ( $wp_filter as $hook => $actions ) {
		@@ -2073,7 +2078,7 @@ discard block
		block discarded – undo
2073	2078	* Get an array of all valid AMP origins for a blog's siteurl.
2074	2079	*
2075	2080	* @param string $siteurl Origin url of the API request.
2076		- * @return array
	2081	+ * @return string[]
2077	2082	*/
2078	2083	public function get_amp_cache_origins( $siteurl ) {
2079	2084	$host = parse_url( $siteurl, PHP_URL_HOST );

		@@ -518,7 +518,7 @@ discard block
		block discarded – undo
518	518	* Only enqueue block assets when needed.
519	519	*
520	520	* @param string $type Slug of the block.
521		- * @param array $script_dependencies Script dependencies. Will be merged with automatically
	521	+ * @param string[] $script_dependencies Script dependencies. Will be merged with automatically
522	522	* detected script dependencies from the webpack build.
523	523	*
524	524	* @return void
		@@ -866,10 +866,10 @@ discard block
		block discarded – undo
866	866	* @since 8.3.0
867	867	*
868	868	* @param string $url URL saved as an attribute in block.
869		- * @param array $allowed Array of allowed hosts for that block, or regexes to check against.
	869	+ * @param string[] $allowed Array of allowed hosts for that block, or regexes to check against.
870	870	* @param bool $is_regex Array of regexes matching the URL that could be used in block.
871	871	*
872		- * @return bool\|string
	872	+ * @return false\|string
873	873	*/
874	874	public static function validate_block_embed_url( $url, $allowed = array(), $is_regex = false ) {
875	875	if (

		@@ -807,7 +807,7 @@ discard block
		block discarded – undo
807	807	* This is ported over from the manage module, which has been deprecated and baked in here.
808	808	*
809	809	* @param $domains
810		- * @return array
	810	+ * @return string[]
811	811	*/
812	812	function allow_wpcom_domain( $domains ) {
813	813	if ( empty( $domains ) ) {
		@@ -1222,7 +1222,7 @@ discard block
		block discarded – undo
1222	1222	/**
1223	1223	* Does the network allow admins to add new users.
1224	1224	*
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' );
		@@ -1332,7 +1332,7 @@ discard block
		block discarded – undo
1332	1332	*
1333	1333	* @param bool $option
1334	1334	*
1335		- * @return boolean
	1335	+ * @return string
1336	1336	*/
1337	1337	public function is_main_network_option( $option ) {
1338	1338	// return '1' or ''
		@@ -1343,7 +1343,7 @@ discard block
		block discarded – undo
1343	1343	* Return true if we are with multi-site or multi-network false if we are dealing with single site.
1344	1344	*
1345	1345	* @param string $option
1346		- * @return boolean
	1346	+ * @return string
1347	1347	*/
1348	1348	public function is_multisite( $option ) {
1349	1349	return (string) (bool) is_multisite();
		@@ -1406,7 +1406,7 @@ discard block
		block discarded – undo
1406	1406	/**
1407	1407	* Returns true if the site has file write access false otherwise.
1408	1408	*
1409		- * @return string ( '1' \| '0' )
	1409	+ * @return integer ( '1' \| '0' )
1410	1410	**/
1411	1411	public static function file_system_write_access() {
1412	1412	if ( ! function_exists( 'get_filesystem_method' ) ) {
		@@ -2142,7 +2142,7 @@ discard block
		block discarded – undo
2142	2142	* @param int $user_id The user id.
2143	2143	* @param string $token The user token.
2144	2144	* @param bool $is_master_user Whether the user is the master user.
2145		- * @return bool
	2145	+ * @return boolean\|null
2146	2146	*/
2147	2147	public static function update_user_token( $user_id, $token, $is_master_user ) {
2148	2148	_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
		@@ -2585,7 +2585,7 @@ discard block
		block discarded – undo
2585	2585	*
2586	2586	* @param string $tag Tag as it appears in each module heading.
2587	2587	*
2588		- * @return mixed
	2588	+ * @return string
2589	2589	*/
2590	2590	public static function translate_module_tag( $tag ) {
2591	2591	return jetpack_get_module_i18n_tag( $tag );
		@@ -2757,8 +2757,8 @@ discard block
		block discarded – undo
2757	2757	* Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2758	2758	* is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2759	2759	*
2760		- * @param $string
2761		- * @return mixed
	2760	+ * @param string $string
	2761	+ * @return string\|null
2762	2762	*/
2763	2763	public static function alias_directories( $string ) {
2764	2764	// ABSPATH has a trailing slash.
		@@ -2769,6 +2769,10 @@ discard block
		block discarded – undo
2769	2769	return $string;
2770	2770	}
2771	2771
	2772	+ /**
	2773	+ * @param boolean $redirect
	2774	+ * @param boolean $send_state_messages
	2775	+ */
2772	2776	public static function activate_default_modules(
2773	2777	$min_version = false,
2774	2778	$max_version = false,
		@@ -3052,6 +3056,9 @@ discard block
		block discarded – undo
3052	3056	return self::update_active_modules( $new );
3053	3057	}
3054	3058
	3059	+ /**
	3060	+ * @param string $module
	3061	+ */
3055	3062	public static function enable_module_configurable( $module ) {
3056	3063	$module = self::get_module_slug( $module );
3057	3064	add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
		@@ -3080,6 +3087,10 @@ discard block
		block discarded – undo
3080	3087	}
3081	3088
3082	3089	/* Installation */
	3090	+
	3091	+ /**
	3092	+ * @param string $message
	3093	+ */
3083	3094	public static function bail_on_activation( $message, $deactivate = true ) {
3084	3095	?>
3085	3096	<!doctype html>
		@@ -3829,7 +3840,7 @@ discard block
		block discarded – undo
3829	3840	* Add help to the Jetpack page
3830	3841	*
3831	3842	* @since Jetpack (1.2.3)
3832		- * @return false if not the Jetpack page
	3843	+ * @return false\|null if not the Jetpack page
3833	3844	*/
3834	3845	function admin_help() {
3835	3846	$current_screen = get_current_screen();
		@@ -5126,7 +5137,7 @@ discard block
		block discarded – undo
5126	5137	* @param String $action The action name.
5127	5138	* @param Integer $user_id The user identifier.
5128	5139	* @param Integer $exp Expiration time in seconds.
5129		- * @return array
	5140	+ * @return boolean
5130	5141	*/
5131	5142	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5132	5143	return self::connection()->generate_secrets( $action, $user_id, $exp );
		@@ -5433,7 +5444,6 @@ discard block
		block discarded – undo
5433	5444	/**
5434	5445	* Report authentication status to the WP REST API.
5435	5446	*
5436		- * @param WP_Error\|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5437	5447	* @return WP_Error\|boolean\|null {@see WP_JSON_Server::check_authentication}
5438	5448	*/
5439	5449	public function wp_rest_authentication_errors( $value ) {
		@@ -5535,6 +5545,7 @@ discard block
		block discarded – undo
5535	5545	* @param string $key
5536	5546	* @param string $value
5537	5547	* @param bool $restate private
	5548	+ * @return string
5538	5549	*/
5539	5550	public static function state( $key = null, $value = null, $restate = false ) {
5540	5551	static $state = array();
		@@ -5593,6 +5604,9 @@ discard block
		block discarded – undo
5593	5604	self::state( null, null, true );
5594	5605	}
5595	5606
	5607	+ /**
	5608	+ * @param string $file
	5609	+ */
5596	5610	public static function check_privacy( $file ) {
5597	5611	static $is_site_publicly_accessible = null;
5598	5612
		@@ -5673,6 +5687,9 @@ discard block
		block discarded – undo
5673	5687	}
5674	5688	}
5675	5689
	5690	+ /**
	5691	+ * @param string $url
	5692	+ */
5676	5693	public static function staticize_subdomain( $url ) {
5677	5694
5678	5695	// Extract hostname from URL
		@@ -6242,9 +6259,7 @@ discard block
		block discarded – undo
6242	6259	*
6243	6260	* Attached to `style_loader_src` filter.
6244	6261	*
6245		- * @param string $tag The tag that would link to the external asset.
6246	6262	* @param string $handle The registered handle of the script in question.
6247		- * @param string $href The url of the asset in question.
6248	6263	*/
6249	6264	public static function set_suffix_on_min( $src, $handle ) {
6250	6265	if ( false === strpos( $src, '.min.css' ) ) {
		@@ -6435,8 +6450,8 @@ discard block
		block discarded – undo
6435	6450	* - Absolute URLs `http://domain.com/feh.png`
6436	6451	* - Domain root relative URLs `/feh.png`
6437	6452	*
6438		- * @param $css string: The raw CSS -- should be read in directly from the file.
6439		- * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
	6453	+ * @param string $css string: The raw CSS -- should be read in directly from the file.
	6454	+ * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6440	6455	*
6441	6456	* @return mixed\|string
6442	6457	*/
		@@ -6697,7 +6712,7 @@ discard block
		block discarded – undo
6697	6712	/**
6698	6713	* Stores and prints out domains to prefetch for page speed optimization.
6699	6714	*
6700		- * @param mixed $new_urls
	6715	+ * @param string[] $new_urls
6701	6716	*/
6702	6717	public static function dns_prefetch( $new_urls = null ) {
6703	6718	static $prefetch_urls = array();
		@@ -6754,7 +6769,6 @@ discard block
		block discarded – undo
6754	6769	}
6755	6770
6756	6771	/**
6757		- * @param mixed $result Value for the user's option
6758	6772	* @return mixed
6759	6773	*/
6760	6774	function get_user_option_meta_box_order_dashboard( $sorted ) {

		@@ -205,8 +205,7 @@ discard block
		block discarded – undo
205	205	/**
206	206	* Mock a set of constants.
207	207	*
208		- * @param array $args Array of sets with constants and their respective values.
209		- * @return phpmock\Mock The mock object.
	208	+ * @return phpmock\Mock[] The mock object.
210	209	*/
211	210	protected function mock_constants( $constants = array() ) {
212	211	$prepare_constant = function( $constant ) {
		@@ -222,7 +221,7 @@ discard block
		block discarded – undo
222	221	/**
223	222	* Mock $wpdb->get_var() and make it return a certain value.
224	223	*
225		- * @param mixed $return_value Return value of the function.
	224	+ * @param integer $return_value Return value of the function.
226	225	* @return PHPUnit\Framework\MockObject\MockObject The mock object.
227	226	*/
228	227	protected function mock_wpdb_get_var( $return_value = null ) {

		@@ -8,6 +8,9 @@
		block discarded – undo
8	8	* - wp-content/rest-api-plugins/jetpack-endpoints/
9	9	*/
10	10
	11	+/**
	12	+ * @param string $file_pattern
	13	+ */
11	14	function wpcom_rest_api_v2_load_plugin_files( $file_pattern ) {
12	15	$plugins = glob( dirname( __FILE__ ) . '/' . $file_pattern );
13	16

		@@ -181,7 +181,7 @@ discard block
		block discarded – undo
181	181	/**
182	182	* Return a hosting provider using a set of known constants.
183	183	*
184		- * @return mixed A host identifier string or false.
	184	+ * @return string\|false A host identifier string or false.
185	185	*/
186	186	public function get_hosting_provider_by_known_constant() {
187	187	$hosting_provider_constants = array(
		@@ -209,7 +209,7 @@ discard block
		block discarded – undo
209	209	/**
210	210	* Return a hosting provider using a set of known classes.
211	211	*
212		- * @return mixed A host identifier string or false.
	212	+ * @return string\|false A host identifier string or false.
213	213	*/
214	214	public function get_hosting_provider_by_known_class() {
215	215	$hosting_provider = false;
		@@ -226,7 +226,7 @@ discard block
		block discarded – undo
226	226	/**
227	227	* Return a hosting provider using a set of known functions.
228	228	*
229		- * @return mixed A host identifier string or false.
	229	+ * @return string\|false A host identifier string or false.
230	230	*/
231	231	public function get_hosting_provider_by_known_function() {
232	232	$hosting_provider = false;
		@@ -441,7 +441,7 @@ discard block
		block discarded – undo
441	441	*
442	442	* @param string $option Option value from the site.
443	443	* @param callable $url_function Function retrieving the URL to normalize.
444		- * @return mixed\|string URL.
	444	+ * @return callable URL.
445	445	*/
446	446	public static function normalize_www_in_url( $option, $url_function ) {
447	447	$url = wp_parse_url( call_user_func( $url_function ) );

		@@ -35,6 +35,9 @@ discard block
		block discarded – undo
35	35	public $amp_source_origin = null;
36	36
37	37	/**
	38	+ * @param string $method
	39	+ * @param string $url
	40	+ * @param string $post_body
38	41	* @return WPCOM_JSON_API instance
39	42	*/
40	43	static function init( $method = null, $url = null, $post_body = null ) {
		@@ -348,6 +351,9 @@ discard block
		block discarded – undo
348	351	return call_user_func_array( array( $endpoint, 'callback' ), $path_pieces );
349	352	}
350	353
	354	+ /**
	355	+ * @param integer $status_code
	356	+ */
351	357	function output_early( $status_code, $response = null, $content_type = 'application/json' ) {
352	358	$exit = $this->exit;
353	359	$this->exit = false;
		@@ -572,11 +578,18 @@ discard block
		block discarded – undo
572	578	return wp_json_encode( $data );
573	579	}
574	580
	581	+ /**
	582	+ * @param string $needle
	583	+ */
575	584	function ends_with( $haystack, $needle ) {
576	585	return $needle === substr( $haystack, -strlen( $needle ) );
577	586	}
578	587
579	588	// Returns the site's blog_id in the WP.com ecosystem
	589	+
	590	+ /**
	591	+ * @return integer
	592	+ */
580	593	function get_blog_id_for_output() {
581	594	return $this->token_details['blog_id'];
582	595	}
		@@ -599,6 +612,10 @@ discard block
		block discarded – undo
599	612	}
600	613
601	614	// Returns true if the specified blog ID is a restricted blog
	615	+
	616	+ /**
	617	+ * @param integer $blog_id
	618	+ */
602	619	function is_restricted_blog( $blog_id ) {
603	620	/**
604	621	* Filters all REST API access and return a 403 unauthorized response for all Restricted blog IDs.
		@@ -648,7 +665,7 @@ discard block
		block discarded – undo
648	665	/**
649	666	* Counts the number of comments on a site, excluding certain comment types.
650	667	*
651		- * @param $post_id int Post ID.
	668	+ * @param integer $post_id int Post ID.
652	669	* @return array Array of counts, matching the output of https://developer.wordpress.org/reference/functions/get_comment_count/.
653	670	*/
654	671	public function wp_count_comments( $post_id ) {

		@@ -58,7 +58,7 @@
		block discarded – undo
58	58	* Loads an RSS feed using `fetch_feed`.
59	59	*
60	60	* @param string $feed The RSS feed URL to load.
61		- * @return SimplePie\|WP_Error The RSS object or error.
	61	+ * @return string The RSS object or error.
62	62	*/
63	63	private static function load_feed( $feed ) {
64	64	$rss = fetch_feed( esc_url_raw( $feed ) );

Automattic / jetpack

Push — branch-8.4 ( 2b405d...95d4b8 )

Status

Category

Doc Comments +32 added lines, -18 removed lines patch added patch discarded remove patch

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

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

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

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

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

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

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

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