Changeset 27432 for trunk/src/wp-includes/class-wp-customize-setting.php

Timestamp:

03/06/2014 02:03:23 PM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-includes/class-wp-customize-setting.php.

Props kpdesign for the cleanup.
Fixes #27295

File:

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

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

@@ -123 +123 @@
                 break;
             default :
+
+                /**
+                 * Fires when the WP_Customize_Setting::preview() method is called for settings
+                 * not handled as theme_mods or options.
+                 *
+                 * The dynamic portion of the hook name, $this->id, refers to the setting ID.
+                 *
+                 * @since 3.4.0
+                 */
                 do_action( 'customize_preview_' . $this->id );
         }
@@ -154 +163 @@
             return false;
 
+        /**
+         * Fires when the WP_Customize_Setting::save() method is called for settings
+         * not handled as theme_mods or options.
+         *
+         * The dynamic portion of the hook name, $this->id_data['base'] refers to
+         * the base slug of the setting name.
+         *
+         * @since 3.4.0
+         */
         do_action( 'customize_save_' . $this->id_data[ 'base' ] );
 
@@ -191 +209 @@
     public function sanitize( $value ) {
         $value = wp_unslash( $value );
+
+        /**
+         * Filter a Customize setting value in un-slashed form.
+         *
+         * @since 3.4.0
+         *
+         * @param mixed                $value Value of the setting.
+         * @param WP_Customize_Setting $this  WP_Customize_Setting instance.
+         */
         return apply_filters( "customize_sanitize_{$this->id}", $value, $this );
     }
@@ -211 +238 @@
                 break;
             default :
+
+                /**
+                 * Fires when the WP_Customize_Setting::update() method is called for settings
+                 * not handled as theme_mods or options.
+                 *
+                 * The dynamic portion of the hook name, $this->type, refers to the type of setting.
+                 *
+                 * @since 3.4.0
+                 *
+                 * @param mixed $value Value of the setting.
+                 */
                 return do_action( 'customize_update_' . $this->type, $value );
         }
@@ -272 +310 @@
                 break;
             default :
+
+                /**
+                 * Filter 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.
+                 *
+                 * For settings handled as theme_mods or options, see those corresponding
+                 * functions for available hooks.
+                 *
+                 * @since 3.4.0
+                 *
+                 * @param mixed $default The setting default value. Default empty.
+                 */
                 return apply_filters( 'customize_value_' . $this->id_data[ 'base' ], $this->default );
         }
@@ -292 +344 @@
      */
     public function js_value() {
+
+        /**
+         * Filter a Customize setting value for use in JavaScript.
+         *
+         * The dynamic portion of the hook name, $this->id, refers to the setting ID.
+         *
+         * @since 3.4.0
+         *
+         * @param mixed                $value The setting value.
+         * @param WP_Customize_Setting $this  WP_Customize_Setting instance.
+         */
         $value = apply_filters( "customize_sanitize_js_{$this->id}", $this->value(), $this );