Automattic / jetpack

modules/shortcodes/class.filter-embedded-html-objects.php

Doc Comments +1 added lines, -1 removed lines

@@ -231,7 +231,7 @@
 	/**
 	 * Filter and replace HTML element.
 	 *
-	 * @param array  $matches Array of matches.
+	 * @param string[]  $matches Array of matches.
 	 * @param string $orig_html Original html. Returned if no results are found via $matches processing.
 	 */
 	private static function dispatch( $matches, $orig_html = null ) {

packages/sync/src/modules/class-module.php

Doc Comments +4 added lines, -4 removed lines

@@ -67,7 +67,7 @@ 
 	 *
 	 * @param string $object_type Type of the sync object.
 	 * @param int    $id          ID of the sync object.
-	 * @return mixed Object, or false if the object is invalid.
+	 * @return boolean Object, or false if the object is invalid.
 	 */
 	public function get_object_by_id( $object_type, $id ) {
 		return false;
@@ -166,8 +166,8 @@ 
 	 * @access protected
 	 *
 	 * @param array $action_names     Action names we're interested in.
-	 * @param array $actions_to_count Unfiltered list of actions we want to count.
-	 * @return array Number of actions that we're interested in.
+	 * @param string[] $actions_to_count Unfiltered list of actions we want to count.
+	 * @return integer Number of actions that we're interested in.
 	 */
 	protected function count_actions( $action_names, $actions_to_count ) {
 		return count( array_intersect( $action_names, $actions_to_count ) );
@@ -266,7 +266,7 @@ 
 	/**
 	 * Given the Module Full Sync Configuration and Status return the next chunk of items to send.
 	 *
-	 * @param array $config This module Full Sync configuration.
+	 * @param string $config This module Full Sync configuration.
 	 * @param array $status This module Full Sync status.
 	 * @param int   $chunk_size Chunk size.
 	 *

class.jetpack.php

Doc Comments +32 added lines, -18 removed lines

@@ -807,7 +807,7 @@ 
 	 * 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 @@ 
 	/**
 	 * 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 @@ 
 	 *
 	 * @param  bool $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1343,7 +1343,7 @@ 
 	 * 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 @@ 
 	/**
 	 * 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 @@ 
 	 * @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 @@ 
 	 *
 	 * @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 @@ 
 	 * 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 @@ 
 		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 @@ 
 		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 @@ 
 	}
 
 	/* Installation */
+
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 		?>
 <!doctype html>
@@ -3829,7 +3840,7 @@ 
 	 * 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 @@ 
 	 * @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 @@ 
 	/**
 	 * 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 @@ 
 	 * @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 @@ 
 		self::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5673,6 +5687,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $url
+	 */
 	public static function staticize_subdomain( $url ) {
 
 		// Extract hostname from URL
@@ -6242,9 +6259,7 @@ 
 	 *
 	 * 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 @@ 
 	 *  - 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 @@ 
 	/**
 	 * 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 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {

packages/status/tests/php/test_Status.php

Doc Comments +2 added lines, -3 removed lines

@@ -205,8 +205,7 @@ 
 	/**
 	 * 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 @@ 
 	/**
 	 * 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 ) {

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

Doc Comments +3 added lines

@@ -8,6 +8,9 @@
  *  - 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 );
 

packages/sync/src/class-functions.php

Doc Comments +4 added lines, -4 removed lines

@@ -181,7 +181,7 @@ 
 	/**
 	 * 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 @@ 
 	/**
 	 * 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 @@ 
 	/**
 	 * 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 @@ 
 	 *
 	 * @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 ) );

packages/sync/src/class-listener.php

Doc Comments +2 added lines, -2 removed lines

@@ -157,7 +157,7 @@ 
 	 * 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 @@ 
 	 * 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() ) {

class.json-api.php

Doc Comments +18 added lines, -1 removed lines

@@ -35,6 +35,9 @@ 
 	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 @@ 
 		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 @@ 
 		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 @@ 
 	}
 
 	// 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 @@ 
 	/**
 	 * 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 ) {

class.json-api-endpoints.php

Doc Comments +6 added lines, -1 removed lines

@@ -1540,6 +1540,7 @@ 
 	 * 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 @@ 
 		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 @@ 
 	 * 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 );