<!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>[35810] trunk: Customizer: Apply `customize_dynamic_setting_class` and `customize_dynamic_setting_args` filters in calls to `WP_Customize_Manager::add_setting( $id, $args )`.</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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/35810">35810</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/35810","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-12-06 23:21:46 +0000 (Sun, 06 Dec 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Customizer: Apply `customize_dynamic_setting_class` and `customize_dynamic_setting_args` filters in calls to `WP_Customize_Manager::add_setting( $id, $args )`.
Ensure that plugin filters apply as expected for any settings registered statically without passing in an explicit class instance to `WP_Customize_Manager::add_setting()`.
Fixes <a href="https://core.trac.wordpress.org/ticket/34597">#34597</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpcustomizemanagerphp">trunk/src/wp-includes/class-wp-customize-manager.php</a></li>
<li><a href="#trunktestsphpunittestscustomizemanagerphp">trunk/tests/phpunit/tests/customize/manager.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpcustomizemanagerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-customize-manager.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-manager.php 2015-12-06 22:22:44 UTC (rev 35809)
+++ trunk/src/wp-includes/class-wp-customize-manager.php 2015-12-06 23:21:46 UTC (rev 35810)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1049,7 +1049,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $id instanceof WP_Customize_Setting ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $setting = $id;
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $setting = new WP_Customize_Setting( $this, $id, $args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $class = 'WP_Customize_Setting';
+
+ /** This filter is documented in wp-includes/class-wp-customize-manager.php */
+ $args = apply_filters( 'customize_dynamic_setting_args', $args, $id );
+
+ /** This filter is documented in wp-includes/class-wp-customize-manager.php */
+ $class = apply_filters( 'customize_dynamic_setting_class', $class, $id, $args );
+
+ $setting = new $class( $this, $id, $args );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->settings[ $setting->id ] = $setting;
</span></span></pre></div>
<a id="trunktestsphpunittestscustomizemanagerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/customize/manager.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/customize/manager.php 2015-12-06 22:22:44 UTC (rev 35809)
+++ trunk/tests/phpunit/tests/customize/manager.php 2015-12-06 23:21:46 UTC (rev 35810)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -245,7 +245,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function filter_customize_dynamic_setting_args_for_test_dynamic_settings( $setting_args, $setting_id ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( false, $setting_args, 'Expected $setting_args to be false by default.' );
</del><span class="cx" style="display: block; padding: 0 10px"> $this->assertInternalType( 'string', $setting_id );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( in_array( $setting_id, array( 'foo', 'bar' ) ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $setting_args = array( 'default' => "dynamic_{$setting_id}_default" );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -542,6 +541,56 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 34597
+ */
+ function test_add_setting_honoring_dynamic() {
+ $manager = new WP_Customize_Manager();
+
+ $setting_id = 'dynamic';
+ $setting = $manager->add_setting( $setting_id );
+ $this->assertEquals( 'WP_Customize_Setting', get_class( $setting ) );
+ $this->assertObjectNotHasAttribute( 'custom', $setting );
+ $manager->remove_setting( $setting_id );
+
+ add_filter( 'customize_dynamic_setting_class', array( $this, 'return_dynamic_customize_setting_class' ), 10, 3 );
+ add_filter( 'customize_dynamic_setting_args', array( $this, 'return_dynamic_customize_setting_args' ), 10, 2 );
+ $setting = $manager->add_setting( $setting_id );
+ $this->assertEquals( 'Test_Dynamic_Customize_Setting', get_class( $setting ) );
+ $this->assertObjectHasAttribute( 'custom', $setting );
+ $this->assertEquals( 'foo', $setting->custom );
+ }
+
+ /**
+ * Return 'Test_Dynamic_Customize_Setting' in 'customize_dynamic_setting_class.
+ *
+ * @param string $class Setting class.
+ * @param array $args Setting args.
+ * @param string $id Setting ID.
+ * @return string Setting class.
+ */
+ function return_dynamic_customize_setting_class( $class, $id, $args ) {
+ unset( $args );
+ if ( 0 === strpos( $id, 'dynamic' ) ) {
+ $class = 'Test_Dynamic_Customize_Setting';
+ }
+ return $class;
+ }
+
+ /**
+ * Return 'Test_Dynamic_Customize_Setting' in 'customize_dynamic_setting_class.
+ *
+ * @param array $args Setting args.
+ * @param string $id Setting ID.
+ * @return string Setting args.
+ */
+ function return_dynamic_customize_setting_args( $args, $id ) {
+ if ( 0 === strpos( $id, 'dynamic' ) ) {
+ $args['custom'] = 'foo';
+ }
+ return $args;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 34596
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_add_panel_return_instance() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -602,3 +651,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $control_id, $result_control->id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+require_once ABSPATH . WPINC . '/class-wp-customize-setting.php';
+
+/**
+ * Class Test_Dynamic_Customize_Setting
+ *
+ * @see Tests_WP_Customize_Manager::test_add_setting_honoring_dynamic()
+ */
+class Test_Dynamic_Customize_Setting extends WP_Customize_Setting {
+ public $type = 'dynamic';
+ public $custom;
+}
</ins></span></pre>
</div>
</div>
</body>
</html>