Automattic / jetpack

modules/contact-form/grunion-contact-form.php

Doc Comments +44 added lines, -2 removed lines

@@ -283,6 +283,9 @@ 
 		return Grunion_Contact_Form::parse( $atts, do_blocks( $content ) );
 	}
 
+	/**
+	 * @param string $type
+	 */
 	public static function block_attributes_to_shortcode_attributes( $atts, $type ) {
 		$atts['type'] = $type;
 		if ( isset( $atts['className'] ) ) {
@@ -1878,7 +1881,6 @@ 
 	 *
 	 * @see ::style()
 	 * @internal
-	 * @param bool $style
 	 */
 	static function _style_on() {
 		return self::style( true );
@@ -2023,6 +2025,7 @@ 
 	 *
 	 * @param int                         $feedback_id
 	 * @param object Grunion_Contact_Form $form
+	 * @param Grunion_Contact_Form $form
 	 *
 	 * @return string $message
 	 */
@@ -2135,7 +2138,7 @@ 
 	 *
 	 * @param array       $attributes Key => Value pairs as parsed by shortcode_parse_atts()
 	 * @param string|null $content The shortcode's inner content: [contact-field]$content[/contact-field]
-	 * @return HTML for the contact form field
+	 * @return string for the contact form field
 	 */
 	static function parse_contact_field( $attributes, $content ) {
 		// Don't try to parse contact form fields if not inside a contact form
@@ -3158,6 +3161,9 @@ 
 
 	}
 
+	/**
+	 * @param string $type
+	 */
 	function render_input_field( $type, $id, $value, $class, $placeholder, $required ) {
 		return "<input 
 					type='". esc_attr( $type ) ."' 
@@ -3169,24 +3175,40 @@ 
 				/>\n";
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_email_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'email', $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'email', $id, $value, $class, $placeholder, $required );
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_telephone_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'telephone', $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'tel', $id, $value, $class, $placeholder, $required );
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_url_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'url', $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'url', $id, $value, $class, $placeholder, $required );
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_textarea_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'textarea', 'contact-form-comment-' . $id, $label, $required, $required_field_text );
 		$field .= "<textarea
@@ -3201,6 +3223,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_radio_field( $id, $label, $value, $class, $required, $required_field_text ) {
 		$field = $this->render_label( '', $id, $label, $required, $required_field_text );
 		foreach ( (array) $this->get_attribute( 'options' ) as $optionIndex => $option ) {
@@ -3222,6 +3247,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_checkbox_field( $id, $label, $value, $class, $required, $required_field_text ) {
 		$field = "<label class='grunion-field-label checkbox" . ( $this->is_error() ? ' form-error' : '' ) . "'>";
 			$field .= "\t\t<input type='checkbox' name='" . esc_attr( $id ) . "' value='" . esc_attr__( 'Yes', 'jetpack' ) . "' " . $class . checked( (bool) $value, true, false ) . ' ' . ( $required ? "required aria-required='true'" : '' ) . "/> \n";
@@ -3231,6 +3259,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_checkbox_multiple_field( $id, $label, $value, $class, $required, $required_field_text  ) {
 		$field = $this->render_label( '', $id, $label, $required, $required_field_text );
 		foreach ( (array) $this->get_attribute( 'options' ) as $optionIndex => $option ) {
@@ -3246,6 +3277,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_select_field( $id, $label, $value, $class, $required, $required_field_text ) {
 		$field = $this->render_label( 'select', $id, $label, $required, $required_field_text );
 		$field  .= "\t<select name='" . esc_attr( $id ) . "' id='" . esc_attr( $id ) . "' " . $class . ( $required ? "required aria-required='true'" : '' ) . ">\n";
@@ -3263,6 +3297,10 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_date_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'date', $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'text', $id, $value, $class, $placeholder, $required );
@@ -3282,6 +3320,10 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_default_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder, $type ) {
 		$field = $this->render_label( $type, $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'text', $id, $value, $class, $placeholder, $required );

class.jetpack-gutenberg.php

Doc Comments +5 added lines, -6 removed lines

@@ -11,7 +11,7 @@ 
  *
  * @param string $slug Slug of the block
  * @param array  $args Arguments that are passed into the register_block_type.
- * @param array  $avalibility Arguments that tells us what kind of avalibility the block has
+ * @param array  $availability Arguments that tells us what kind of avalibility the block has
  *
  * @see register_block_type
  *
@@ -27,7 +27,7 @@ 
  * Helper function to register a Jetpack Gutenberg plugin
  *
  * @param string $slug Slug of the plugin.
- * @param array  $avalibility Arguments that tells us what kind of avalibility the plugin has
+ * @param array  $availability Arguments that tells us what kind of avalibility the plugin has
  *
  * @see register_block_type
  *
@@ -134,7 +134,6 @@ 
 	/**
 	 * Add a block to the list of blocks to be registered.
 	 *
-	 * @param string $slug Slug of the block.
 	 * @param array  $args Arguments that are passed into the register_block_type.
 	 * @param array $availability array containing if a block is available and the reason when it is not.
 	 *
@@ -254,7 +253,7 @@ 
 	/**
 	 * Checks for a given .json file in the blocks folder.
 	 *
-	 * @param $preset The name of the .json file to look for.
+	 * @param string $preset The name of the .json file to look for.
 	 *
 	 * @return bool True if the file is found.
 	 */
@@ -265,7 +264,7 @@ 
 	/**
 	 * Decodes JSON loaded from a preset file in the blocks folder
 	 *
-	 * @param $preset The name of the .json file to load.
+	 * @param string $preset The name of the .json file to load.
 	 *
 	 * @return mixed Returns an object if the file is present, or false if a valid .json file is not present.
 	 */
@@ -369,7 +368,7 @@ 
 	 * Only enqueue block assets when needed.
 	 *
 	 * @param string $type slug of the block.
-	 * @param array $script_dependencies An array of view-side Javascript dependencies to be enqueued.
+	 * @param string[] $script_dependencies An array of view-side Javascript dependencies to be enqueued.
 	 *
 	 * @return void
 	 */

class.jetpack.php

Doc Comments +45 added lines, -16 removed lines

@@ -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' );
@@ -1327,7 +1327,7 @@ 
 	 * database which could be set to anything as opposed to what this function returns.
 	 * @param  bool  $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1338,7 +1338,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();
@@ -1400,7 +1400,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' ) ) {
@@ -2256,6 +2256,7 @@ 
 	 * @param int $user_id
 	 * @param string $token
 	 * return bool
+	 * @param boolean $is_master_user
 	 */
 	public static function update_user_token( $user_id, $token, $is_master_user ) {
 		// not designed for concurrent updates
@@ -2658,6 +2659,7 @@ 
 
 	/**
 	 * Like core's get_file_data implementation, but caches the result.
+	 * @param string $file
 	 */
 	public static function get_file_data( $file, $headers ) {
 		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
@@ -2694,7 +2696,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 );
@@ -2859,8 +2861,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.
@@ -3140,6 +3142,9 @@ 
 		return self::update_active_modules( $new );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function enable_module_configurable( $module ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
@@ -3167,21 +3172,33 @@ 
 		return $url;
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_load( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'jetpack_module_configuration_load_' . $module, $method );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_head( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'jetpack_module_configuration_head_' . $module, $method );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_screen( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_activation_screen( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'display_activate_module_setting_' . $module, $method );
@@ -3189,6 +3206,9 @@ 
 
 /* Installation */
 
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3949,7 +3969,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();
@@ -4845,6 +4865,9 @@ 
 		return $url;
 	}
 
+	/**
+	 * @return string
+	 */
 	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 );
@@ -5056,6 +5079,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -5247,6 +5271,7 @@ 
 	 * Note these tokens are unique per call, NOT static per site for connecting.
 	 *
 	 * @since 2.6
+	 * @param string $action
 	 * @return array
 	 */
 	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
@@ -5780,7 +5805,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 ) {
@@ -5790,6 +5814,10 @@ 
 		return $this->rest_authentication_status;
 	}
 
+	/**
+	 * @param integer $timestamp
+	 * @param string $nonce
+	 */
 	function add_nonce( $timestamp, $nonce ) {
 		global $wpdb;
 		static $nonces_used_this_request = array();
@@ -5935,6 +5963,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();
@@ -5991,6 +6020,9 @@ 
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -6608,9 +6640,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' ) ) {
@@ -6791,8 +6821,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
 	 */
@@ -7021,7 +7051,7 @@ 
 	 *
 	 * @param string $option_name
 	 *
-	 * @return bool
+	 * @return false|null
 	 */
 	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
 		// Bail if Jump Start has already been dismissed
@@ -7062,7 +7092,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();
@@ -7108,7 +7138,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {

modules/theme-tools/compat/jitm-engine.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 	/**
 	 * Add plan highlights to a list
 	 *
-	 * @param $list Message The list to apply to
+	 * @param Message $list Message The list to apply to
 	 * @param $cache Cache The jitm cache
 	 */
 	private static function add_plan_highlights_to_list( $list, $cache ) {

modules/theme-tools/compat/jitm-message.php

Doc Comments +20 added lines, -18 removed lines

@@ -794,7 +794,7 @@ 
 	 *
 	 * @param $external_user_id int The external user id
 	 *
-	 * @return object The rendered rule
+	 * @return \stdClass The rendered rule
 	 */
 	public function post_render( $external_user_id ) {
 		// render guides if there's at least one
@@ -849,7 +849,7 @@ 
 	/**
 	 * Requires a widget to be inactive
 	 *
-	 * @param $widget_slug string The slug of the widget
+	 * @param string $widget_slug string The slug of the widget
 	 *
 	 * @return $this
 	 */
@@ -862,7 +862,7 @@ 
 	/**
 	 * Requires the user or blog owner to be in the gdpr zone
 	 *
-	 * @param $flag bool Whether or not to show in the gdpr zone
+	 * @param boolean $flag bool Whether or not to show in the gdpr zone
 	 *
 	 * @return $this
 	 */
@@ -875,7 +875,7 @@ 
 	/**
 	 * Check if a blog has a specific sticker
 	 *
-	 * @param $sticker string The sticker to check for
+	 * @param string $sticker string The sticker to check for
 	 *
 	 * @return $this
 	 */
@@ -888,8 +888,8 @@ 
 	/**
 	 * Ensure that the browser carries a specific query string
 	 *
-	 * @param $key string The key to check for
-	 * @param $value string A regex to match
+	 * @param string $key string The key to check for
+	 * @param string $value string A regex to match
 	 *
 	 * @return $this
 	 */
@@ -899,6 +899,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param boolean $value
+	 */
 	public function with_backups_possible( $value ) {
 		$this->with_backups = $value;
 
@@ -943,7 +946,7 @@ 
 	/**
 	 * Ensure that a specific theme is active
 	 *
-	 * @param $theme
+	 * @param string $theme
 	 *
 	 * @return $this
 	 */
@@ -956,7 +959,7 @@ 
 	/**
 	 * Only show this JITM when the specified plugin is inactive OR not installed
 	 *
-	 * @param $plugin string The path to the plugin
+	 * @param string $plugin string The path to the plugin
 	 *
 	 * @return $this
 	 */
@@ -970,7 +973,7 @@ 
 	 * Only show this JITM when the specified plugin is active and installed
 	 * Multiple calls are treated as OR: if _any_ of the plugins are active, the rule passes
 	 *
-	 * @param $plugin string The path to the plugin
+	 * @param string $plugin string The path to the plugin
 	 *
 	 * @return $this
 	 */
@@ -983,7 +986,7 @@ 
 	/**
 	 * A rule for a plugin being installed but either active or not active
 	 *
-	 * @param $plugin string The path to the plugin
+	 * @param string $plugin string The path to the plugin
 	 *
 	 * @return $this
 	 */
@@ -996,7 +999,7 @@ 
 	/**
 	 * A rule to check that a specific plugin is not installed
 	 *
-	 * @param $plugin string The path to the plugin
+	 * @param string $plugin string The path to the plugin
 	 *
 	 * @return $this
 	 */
@@ -1009,7 +1012,7 @@ 
 	/**
 	 * Only show if the user is in the specified role
 	 *
-	 * @param $role string The role
+	 * @param string $role string The role
 	 *
 	 * @return $this
 	 */
@@ -1087,7 +1090,7 @@ 
 	 *
 	 * The hook to display the content on, such as `admin-notices`
 	 *
-	 * @param $regex string The message path regex
+	 * @param string $regex string The message path regex
 	 *
 	 * @return $this
 	 */
@@ -1130,7 +1133,7 @@ 
 	/**
 	 * Set's the priority of this specific jitm if there are any conflicts
 	 *
-	 * @param $priority int The priority. Higher numbers result in a higher priority
+	 * @param integer $priority int The priority. Higher numbers result in a higher priority
 	 *
 	 * @return $this
 	 */
@@ -1178,7 +1181,7 @@ 
 	/**
 	 * Set the maximum number of dismissals before this jitm will never be shown again
 	 *
-	 * @param $times int The maximum number of times to show this message
+	 * @param integer $times int The maximum number of times to show this message
 	 *
 	 * @return $this
 	 */
@@ -1244,7 +1247,6 @@ 
 	/**
 	 * Sets the ES query to check against the site profile
 	 *
-	 * @param bool $with_plan
 	 *
 	 * @return $this
 	 */
@@ -1303,7 +1305,7 @@ 
 	 * Limits the JITM to only the provided types.
 	 * Default: [ 'jetpack' ] (non-Atomic)
 	 *
-	 * @param array $site_types - can include 'jetpack', 'atomic'
+	 * @param string[] $site_types - can include 'jetpack', 'atomic'
 	 *
 	 * @return $this
 	 */
@@ -1342,7 +1344,7 @@ 
 	/**
 	 * A rule for a module to be activated
 	 *
-	 * @param $module string Module slug.
+	 * @param string $module string Module slug.
 	 *
 	 * @return $this
 	 */

modules/sso.php

Doc Comments +2 added lines, -3 removed lines

@@ -270,7 +270,7 @@ 
 	 * Validate the require  two step checkbox in Settings > General
 	 *
 	 * @since 2.7
-	 * @return boolean
+	 * @return integer
 	 **/
 	public function validate_jetpack_sso_require_two_step( $input ) {
 		return ( ! empty( $input ) ) ? 1 : 0;
@@ -300,7 +300,7 @@ 
 	 * Validate the match by email check in Settings > General
 	 *
 	 * @since 2.9
-	 * @return boolean
+	 * @return integer
 	 **/
 	public function validate_jetpack_sso_match_by_email( $input ) {
 		return ( ! empty( $input ) ) ? 1 : 0;
@@ -1094,7 +1094,6 @@ 
 	 *
 	 * @since 6.9.0
 	 *
-	 * @param string $jitm_id ID of the JITM being displayed.
 	 *
 	 * @return void
 	 */