X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/874d2a2f468a0d1e69aab49b1fe2d9d79d3e1142..af50974463450c98503e763a7836a50e260461a9:/wp-includes/class-wp-customize-setting.php

diff --git a/wp-includes/class-wp-customize-setting.php b/wp-includes/class-wp-customize-setting.php
index a516b218..0207b709 100644
--- a/wp-includes/class-wp-customize-setting.php
+++ b/wp-includes/class-wp-customize-setting.php
@@ -124,16 +124,28 @@ class WP_Customize_Setting {
 			default :
 
 				/**
-				 * Fires when the WP_Customize_Setting::preview() method is called for settings
+				 * Fires when the {@see 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.
+				 * The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
 				 *
 				 * @since 3.4.0
 				 *
-				 * @param WP_Customize_Setting $this WP_Customize_Setting instance.
+				 * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
 				 */
-				do_action( 'customize_preview_' . $this->id, $this );
+				do_action( "customize_preview_{$this->id}", $this );
+
+				/**
+				 * Fires when the {@see WP_Customize_Setting::preview()} method is called for settings
+				 * not handled as theme_mods or options.
+				 *
+				 * The dynamic portion of the hook name, `$this->type`, refers to the setting type.
+				 *
+				 * @since 4.1.0
+				 *
+				 * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
+				 */
+				do_action( "customize_preview_{$this->type}", $this );
 		}
 	}
 
@@ -156,7 +168,7 @@ class WP_Customize_Setting {
 	 *
 	 * @since 3.4.0
 	 *
-	 * @return bool False if cap check fails or value isn't set.
+	 * @return false|null False if cap check fails or value isn't set.
 	 */
 	public final function save() {
 		$value = $this->post_value();
@@ -167,12 +179,12 @@ class WP_Customize_Setting {
 		/**
 		 * Fires when the WP_Customize_Setting::save() method is called.
 		 *
-		 * The dynamic portion of the hook name, $this->id_data['base'] refers to
+		 * The dynamic portion of the hook name, `$this->id_data['base']` refers to
 		 * the base slug of the setting name.
 		 *
 		 * @since 3.4.0
 		 *
-		 * @param WP_Customize_Setting $this WP_Customize_Setting instance.
+		 * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
 		 */
 		do_action( 'customize_save_' . $this->id_data[ 'base' ], $this );
 
@@ -242,10 +254,10 @@ class WP_Customize_Setting {
 			default :
 
 				/**
-				 * Fires when the WP_Customize_Setting::update() method is called for settings
+				 * Fires when the {@see 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.
+				 * The dynamic portion of the hook name, `$this->type`, refers to the type of setting.
 				 *
 				 * @since 3.4.0
 				 *
@@ -282,7 +294,7 @@ class WP_Customize_Setting {
 	 * @since 3.4.0
 	 *
 	 * @param mixed $value The value to update.
-	 * @return mixed The result of saving the value.
+	 * @return bool|null The result of saving the value.
 	 */
 	protected function _update_option( $value ) {
 		// Handle non-array option.
@@ -317,7 +329,7 @@ class WP_Customize_Setting {
 				/**
 				 * 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 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
@@ -351,12 +363,12 @@ class WP_Customize_Setting {
 		/**
 		 * Filter a Customize setting value for use in JavaScript.
 		 *
-		 * The dynamic portion of the hook name, $this->id, refers to the setting ID.
+		 * 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.
+		 * @param WP_Customize_Setting $this  {@see WP_Customize_Setting} instance.
 		 */
 		$value = apply_filters( "customize_sanitize_js_{$this->id}", $this->value(), $this );
 
@@ -457,7 +469,7 @@ class WP_Customize_Setting {
 	 *
 	 * @param $root
 	 * @param $keys
-	 * @param $default A default value which is used as a fallback. Default is null.
+	 * @param mixed $default A default value which is used as a fallback. Default is null.
 	 * @return mixed The requested value or the default value.
 	 */
 	final protected function multidimensional_get( $root, $keys, $default = null ) {
@@ -544,7 +556,6 @@ final class WP_Customize_Background_Image_Setting extends WP_Customize_Setting {
 
 	/**
 	 * @since 3.4.0
-	 * @uses remove_theme_mod()
 	 *
 	 * @param $value
 	 */