Automattic / jetpack

extensions/blocks/podcast-player/podcast-player.php

Doc Comments +1 added lines, -1 removed lines

@@ -235,7 +235,7 @@
  * @param string $name           Template name, available in `./templates` folder.
  * @param array  $template_props Template properties. Optional.
  * @param bool   $print          Render template. True as default.
- * @return false|string          HTML markup or false.
+ * @return string|null          HTML markup or false.
  */
 function render( $name, $template_props = array(), $print = true ) {
 	if ( ! strpos( $name, '.php' ) ) {

modules/stats.php

Doc Comments +4 added lines, -4 removed lines

@@ -290,7 +290,7 @@ 
  * Get Stats Options.
  *
  * @access public
- * @param mixed $option Option.
+ * @param string $option Option.
  * @return mixed|null.
  */
 function stats_get_option( $option ) {
@@ -744,7 +744,7 @@ 
  * Stats Convert Chart URLs.
  *
  * @access public
- * @param mixed $html HTML.
+ * @param string $html HTML.
  * @return string
  */
 function stats_convert_chart_urls( $html ) {
@@ -1414,7 +1414,7 @@ 
  *
  * @access public
  * @param mixed $get Get.
- * @param mixed $url URL.
+ * @param string $url URL.
  * @return void
  */
 function stats_print_wp_remote_error( $get, $url ) {
@@ -1556,7 +1556,7 @@ 
  * Stats get remote CSV.
  *
  * @access public
- * @param mixed $url URL.
+ * @param string $url URL.
  * @return array
  */
 function stats_get_remote_csv( $url ) {

packages/lazy-images/src/lazy-images.php

Doc Comments +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
 	 *
 	 * @since 5.6.0
 	 *
-	 * @return object The class instance.
+	 * @return Jetpack_Lazy_Images The class instance.
 	 */
 	public static function instance() {
 		if ( is_null( self::$instance ) ) {

packages/connection/src/class-manager.php

Doc Comments +4 added lines, -3 removed lines

@@ -313,7 +313,7 @@ 
 	/**
 	 * Verifies the signature of the current request.
 	 *
-	 * @return false|array
+	 * @return boolean
 	 */
 	public function verify_xml_rpc_signature() {
 		if ( is_null( $this->xmlrpc_verification ) ) {
@@ -1286,6 +1286,7 @@ 
 	 * @param String  $action  The action name.
 	 * @param Integer $user_id The user identifier.
 	 * @param Integer $exp     Expiration time in seconds.
+	 * @return string
 	 */
 	public function generate_secrets( $action, $user_id = false, $exp = 600 ) {
 		if ( false === $user_id ) {
@@ -2242,7 +2243,7 @@ 
 	 *
 	 * @param int|false    $user_id   false: Return the Blog Token. int: Return that user's User Token.
 	 * @param string|false $token_key If provided, check that the token matches the provided input.
-	 * @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.
+	 * @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.
 	 *
 	 * @return object|false
 	 */
@@ -2626,7 +2627,7 @@ 
 	 * Fetches a signed token.
 	 *
 	 * @param object $token the token.
-	 * @return WP_Error|string a signed token
+	 * @return string a signed token
 	 */
 	public function get_signed_token( $token ) {
 		if ( ! isset( $token->secret ) || empty( $token->secret ) ) {

class.jetpack-gutenberg.php

Doc Comments +4 added lines, -4 removed lines

@@ -583,7 +583,7 @@ 
 	 * 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 @@ 
 	 *
 	 * @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 @@ 
 	 * @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 (

packages/sync/src/class-replicastore.php

Doc Comments +1 added lines, -1 removed lines

@@ -325,7 +325,7 @@
 	 * @access protected
 	 *
 	 * @param string $status Comment status.
-	 * @return string|bool New comment_approved value, false if the status doesn't affect it.
+	 * @return string|false New comment_approved value, false if the status doesn't affect it.
 	 */
 	protected function comment_status_to_approval_value( $status ) {
 		switch ( (string) $status ) {

class.jetpack.php

Doc Comments +32 added lines, -17 removed lines

@@ -956,7 +956,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 ) ) {
@@ -1324,7 +1324,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' );
@@ -1434,7 +1434,7 @@ 
 	 *
 	 * @param  bool $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1445,7 +1445,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();
@@ -1508,7 +1508,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' ) ) {
@@ -2237,7 +2237,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' );
@@ -2681,7 +2681,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 );
@@ -2796,8 +2796,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.
@@ -2808,6 +2808,10 @@ 
 		return $string;
 	}
 
+	/**
+	 * @param boolean $redirect
+	 * @param boolean $send_state_messages
+	 */
 	public static function activate_default_modules(
 		$min_version = false,
 		$max_version = false,
@@ -3091,6 +3095,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' );
@@ -3119,6 +3126,10 @@ 
 	}
 
 	/* Installation */
+
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 		?>
 <!doctype html>
@@ -3884,7 +3895,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();
@@ -4588,6 +4599,7 @@ 
 
 	/**
 	 * 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();
@@ -5001,6 +5013,9 @@ 
 		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 );
@@ -5291,7 +5306,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 );
@@ -5547,7 +5562,6 @@ 
 	 * @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 ) {
@@ -5640,6 +5654,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();
@@ -5721,6 +5736,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -6293,9 +6311,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' ) ) {
@@ -6671,8 +6687,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
 	 */
@@ -6971,7 +6987,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {

3rd-party/woocommerce.php

Doc Comments +1 added lines, -1 removed lines

@@ -66,7 +66,7 @@
  * Add a callback for WooCommerce product rendering in infinite scroll.
  *
  * @param array $callbacks Array of render callpacks for IS.
- * @return array
+ * @return string[]
  */
 function jetpack_woocommerce_infinite_scroll_render_callback( $callbacks ) {
 	$callbacks[] = 'jetpack_woocommerce_infinite_scroll_render';

packages/sync/src/replicastore/class-table-checksum.php

Doc Comments +2 added lines, -2 removed lines

@@ -224,7 +224,7 @@ 
 	 *
 	 * @param string $table Table name to validate.
 	 *
-	 * @return mixed|string
+	 * @return string
 	 * @throws Exception Throw an exception on validation failure.
 	 */
 	private function validate_table_name( $table ) {
@@ -482,7 +482,7 @@ 
 	 * @param int|null $range_to   The end of the range.
 	 * @param int|null $limit      How many values to return.
 	 *
-	 * @return array|object|void
+	 * @return boolean
 	 * @throws Exception Throws an exception if validation fails on the internal function calls.
 	 */
 	public function get_range_edges( $range_from = null, $range_to = null, $limit = null ) {