Changeset 38121 for trunk/src/wp-includes/class-wp-customize-manager.php

Timestamp:

07/20/2016 04:56:21 PM (8 years ago)

Author:

DrewAPicture

Message:

Docs: Fix formatting, tense, verb conjugation, and other syntax for wp-includes/* elements introduced or changed in 4.6.

Part 1/2.

See #37318.

File:

• trunk/src/wp-includes/class-wp-customize-manager.php (modified) (6 diffs)

trunk/src/wp-includes/class-wp-customize-manager.php

@@ -652 +652 @@
 
     /**
-     * Return the sanitized value for a given setting from the request's POST data.
-     *
-     * @since 3.4.0
-     * @since 4.1.1 Introduced `$default` parameter.
-     * @since 4.6.0 Return `$default` when setting post value is invalid.
+     * Returns the sanitized value for a given setting from the request's POST data.
+     *
+     * @since 3.4.0
+     * @since 4.1.1 Introduced the `$default` parameter.
+     * @since 4.6.0 `$default` is now returned early when the setting post value is invalid.
+     * @access public
+     *
      * @see WP_REST_Server::dispatch()
      * @see WP_Rest_Request::sanitize_params()
@@ -988 +990 @@
 
     /**
-     * Validate setting values.
+     * Validates setting values.
      *
      * Sanitization is applied to the values before being passed for validation.
@@ -996 +998 @@
      * @since 4.6.0
      * @access public
+     *
      * @see WP_REST_Request::has_valid_params()
      * @see WP_Customize_Setting::validate()
@@ -1027 +1030 @@
 
     /**
-     * Prepare setting validity for exporting to the client (JS).
+     * Prepares setting validity for exporting to the client (JS).
      *
      * Converts `WP_Error` instance into array suitable for passing into the
@@ -1036 +1039 @@
      *
      * @param true|WP_Error $validity Setting validity.
-     * @return true|array If `$validity` was `WP_Error` then array mapping the error
-     *                    codes to their respective `message` and `data` to pass
-     *                    into the `wp.customize.Notification` JS model.
+     * @return true|array If `$validity` was a WP_Error, the error codes will be array-mapped
+     *                    to their respective `message` and `data` to pass into the
+     *                    `wp.customize.Notification` JS model.
      */
     public function prepare_setting_validity_for_js( $validity ) {
@@ -1081 +1084 @@
          * Fires before save validation happens.
          *
-         * Plugins can add just-in-time `customize_validate_{$setting_id}` filters
+         * Plugins can add just-in-time {@see 'customize_validate_{$this->ID}'} filters
          * at this point to catch any settings registered after `customize_register`.
+         * The dynamic portion of the hook name, `$this->ID` referrs to the setting ID.
          *
          * @since 4.6.0