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

Timestamp:

07/26/2012 09:45:33 PM (12 years ago)

Author:

ryan

Message:

phpdoc for Customizer classes and methods. Props bananastalktome. see #21303

File:

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

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

@@ -1 +1 @@
 <?php
 /**
- * Customize Setting Class
+ * Customize Setting Class.
  *
  * @package WordPress
@@ -7 +7 @@
  * @since 3.4.0
  */
-
 class WP_Customize_Setting {
     public $manager;
@@ -29 +28 @@
      * @since 3.4.0
      *
+     * @param WP_Customize_Manager $manager
      * @param string $id An specific ID of the setting. Can be a
      *                   theme mod or option name.
      * @param array $args Setting arguments.
+     * @return WP_Customize_Setting
      */
     function __construct( $manager, $id, $args = array() ) {
@@ -88 +89 @@
      *
      * @since 3.4.0
-     *
-     * @param mixed Old value.
+     * @uses WP_Customize_Setting::multidimensional_replace()
+     *
+     * @param mixed $original Old value.
      * @return mixed New or old value.
      */
@@ -119 +121 @@
      * @since 3.4.0
      *
-     * @param $default mixed A default value which is used as a fallback. Default is null.
-     * @return mixed Either the default value on failure or sanitized value.
+     * @param mixed $default A default value which is used as a fallback. Default is null.
+     * @return mixed The default value on failure, otherwise the sanitized value.
      */
     public final function post_value( $default = null ) {
@@ -139 +141 @@
      * @since 3.4.0
      *
-     * @param $value mixed The value to sanitize.
+     * @param mixed $value The value to sanitize.
      * @return mixed Null if an input isn't valid, otherwise the sanitized value.
      */
@@ -152 +154 @@
      * @since 3.4.0
      *
-     * @param $value mixed The value to update.
+     * @param mixed $value The value to update.
      * @return mixed The result of saving the value.
      */
@@ -173 +175 @@
      * @since 3.4.0
      *
-     * @param $value mixed The value to update.
+     * @param mixed $value The value to update.
      * @return mixed The result of saving the value.
      */
@@ -193 +195 @@
      * @since 3.4.0
      *
-     * @param $value mixed The value to update.
+     * @param mixed $value The value to update.
      * @return mixed The result of saving the value.
      */
@@ -277 +279 @@
      * @param $keys
      * @param bool $create Default is false.
-     * @return null|array
+     * @return null|array Keys are 'root', 'node', and 'key'.
      */
     final protected function multidimensional( &$root, $keys, $create = false ) {
@@ -373 +375 @@
  *
  * Results should be properly handled using another setting or callback.
+ *
+ * @package WordPress
+ * @subpackage Customize
+ * @since 3.4.0
  */
 class WP_Customize_Filter_Setting extends WP_Customize_Setting {
+    
+    /**
+     * @since 3.4.0
+     */
     public function update() {}
 }
@@ -382 +392 @@
  *
  * Results should be properly handled using another setting or callback.
+ *
+ * @package WordPress
+ * @subpackage Customize
+ * @since 3.4.0
  */
 final class WP_Customize_Header_Image_Setting extends WP_Customize_Setting {
     public $id = 'header_image_data';
 
+    /**
+     * @since 3.4.0
+     *
+     * @param $value
+     */
     public function update( $value ) {
         global $custom_image_header;
@@ -401 +420 @@
 }
 
+/**
+ * @package WordPress
+ * @subpackage Customize
+ * @since 3.4.0
+ */
 final class WP_Customize_Background_Image_Setting extends WP_Customize_Setting {
     public $id = 'background_image_thumb';
 
+    /**
+     * @since 3.4.0
+     * @uses remove_theme_mod()
+     *
+     * @param $value
+     */
     public function update( $value ) {
         remove_theme_mod( 'background_image_thumb' );