<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[27432] trunk/src/wp-includes/class-wp-customize-setting.php: Inline documentation for hooks in wp-includes/class-wp-customize-setting.php.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/27432">27432</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-03-06 14:03:23 +0000 (Thu, 06 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for hooks in wp-includes/class-wp-customize-setting.php.
Props kpdesign for the cleanup.
Fixes <a href="http://core.trac.wordpress.org/ticket/27295">#27295</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpcustomizesettingphp">trunk/src/wp-includes/class-wp-customize-setting.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpcustomizesettingphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/class-wp-customize-setting.php (27431 => 27432)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/class-wp-customize-setting.php 2014-03-06 13:50:32 UTC (rev 27431)
+++ trunk/src/wp-includes/class-wp-customize-setting.php 2014-03-06 14:03:23 UTC (rev 27432)
</span><span class="lines">@@ -122,6 +122,15 @@
</span><span class="cx"> }
</span><span class="cx"> break;
</span><span class="cx"> default :
</span><ins>+
+ /**
+ * 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
+ */
</ins><span class="cx"> do_action( 'customize_preview_' . $this->id );
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="lines">@@ -153,6 +162,15 @@
</span><span class="cx"> if ( ! $this->check_capabilities() || ! isset( $value ) )
</span><span class="cx"> return false;
</span><span class="cx">
</span><ins>+ /**
+ * 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
+ */
</ins><span class="cx"> do_action( 'customize_save_' . $this->id_data[ 'base' ] );
</span><span class="cx">
</span><span class="cx"> $this->update( $value );
</span><span class="lines">@@ -190,6 +208,15 @@
</span><span class="cx"> */
</span><span class="cx"> public function sanitize( $value ) {
</span><span class="cx"> $value = wp_unslash( $value );
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( "customize_sanitize_{$this->id}", $value, $this );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -210,6 +237,17 @@
</span><span class="cx"> return $this->_update_option( $value );
</span><span class="cx"> break;
</span><span class="cx"> default :
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> return do_action( 'customize_update_' . $this->type, $value );
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="lines">@@ -271,6 +309,20 @@
</span><span class="cx"> $function = 'get_option';
</span><span class="cx"> break;
</span><span class="cx"> default :
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> return apply_filters( 'customize_value_' . $this->id_data[ 'base' ], $this->default );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -291,6 +343,17 @@
</span><span class="cx"> * @return mixed The requested escaped value.
</span><span class="cx"> */
</span><span class="cx"> public function js_value() {
</span><ins>+
+ /**
+ * 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.
+ */
</ins><span class="cx"> $value = apply_filters( "customize_sanitize_js_{$this->id}", $this->value(), $this );
</span><span class="cx">
</span><span class="cx"> if ( is_string( $value ) )
</span></span></pre>
</div>
</div>
</body>
</html>