Changeset 38121 for trunk/src/wp-includes/class-wp-customize-setting.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-setting.php (modified) (6 diffs)

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

@@ -465 +465 @@
 
     /**
-     * Check user capabilities and theme supports, and then save
+     * Checks user capabilities and theme supports, and then saves
      * the value of the setting.
      *
      * @since 3.4.0
      * @since 4.6.0 Return the result of updating the value.
+     * @access public
      *
      * @return false|void False if cap check fails or value isn't set or is invalid.
@@ -529 +530 @@
 
     /**
-     * Validate an input.
+     * Validates an input.
      *
      * @since 4.6.0
      * @access public
+     *
      * @see WP_REST_Request::has_valid_params()
      *
      * @param mixed $value Value to validate.
-     * @return true|WP_Error
+     * @return true|WP_Error True if the input was validated, otherwise WP_Error.
      */
     public function validate( $value ) {
@@ -549 +551 @@
 
         /**
-         * Validate a Customize setting value.
+         * Validates a Customize setting value.
          *
          * Plugins should amend the `$validity` object via its `WP_Error::add()` method.
+         *
+         * The dynamic portion of the hook name, `$this->ID`, refers to the setting ID.
          *
          * @since 4.6.0
@@ -696 +700 @@
              * Filters a Customize setting value not handled as a theme_mod or option.
              *
-             * The dynamic portion of the hook name, `$this->id_date['base']`, refers to
-             * the base slug of the setting name.
+             * The dynamic portion of the hook name, `$id_base`, refers to
+             * the base slug of the setting name, initialized from `$this->id_data['base']`.
              *
              * For settings handled as theme_mods or options, see those corresponding
@@ -703 +707 @@
              *
              * @since 3.4.0
-             * @since 4.6.0 Added the `$this` setting instance as the second param.
+             * @since 4.6.0 Added the `$this` setting instance as the second parameter.
              *
              * @param mixed                $default The setting default value. Default empty.
@@ -751 +755 @@
 
     /**
-     * Get the data to export to the client via JSON.
+     * Retrieves the data to export to the client via JSON.
      *
      * @since 4.6.0
+     * @access public
      *
      * @return array Array of parameters passed to JavaScript.