<!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>[35781] trunk: Customizer: Return added instances for panels, sections, controls, and settings when calling `WP_Customize_Manager::add_*()` methods.</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/35781">35781</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/35781","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 18:09:42 +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: Return added instances for panels, sections, controls, and settings when calling `WP_Customize_Manager::add_*()` methods.
Add missing phpDoc.
Props fusillicode, jubstuff.
Fixes <a href="https://core.trac.wordpress.org/ticket/34596">#34596</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 17:51:21 UTC (rev 35780)
+++ trunk/src/wp-includes/class-wp-customize-manager.php 2015-12-06 18:09:42 UTC (rev 35781)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1037,10 +1037,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Add a customize setting.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.5.0 Return added WP_Customize_Setting instance.
+ * @access public
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_Customize_Setting|string $id Customize Setting object, or ID.
- * @param array $args Setting arguments; passed to WP_Customize_Setting
- * constructor.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param WP_Customize_Setting|string $id Customize Setting object, or ID.
+ * @param array $args Setting arguments; passed to WP_Customize_Setting
+ * constructor.
+ * @return WP_Customize_Setting The instance of the setting that was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add_setting( $id, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $id instanceof WP_Customize_Setting ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1048,7 +1051,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $setting = new WP_Customize_Setting( $this, $id, $args );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->settings[ $setting->id ] = $setting;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $setting;
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1061,6 +1066,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * even though they are not directly created statically with code.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.2.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @access public
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $setting_ids The setting IDs to add.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array The WP_Customize_Setting objects added.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1141,10 +1147,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Add a customize panel.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.5.0 Return added WP_Customize_Panel instance.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Customize_Panel|string $id Customize Panel object, or Panel ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Optional. Panel arguments. Default empty array.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @return WP_Customize_Panel The instance of the panel that was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add_panel( $id, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $id instanceof WP_Customize_Panel ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1154,6 +1163,7 @@
</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"> $this->panels[ $panel->id ] = $panel;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $panel;
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1216,9 +1226,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Add a customize section.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.5.0 Return added WP_Customize_Section instance.
+ * @access public
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Customize_Section|string $id Customize Section object, or Section ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Section arguments.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @return WP_Customize_Section The instance of the section that was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add_section( $id, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $id instanceof WP_Customize_Section ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1226,7 +1240,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $section = new WP_Customize_Section( $this, $id, $args );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->sections[ $section->id ] = $section;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $section;
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1286,10 +1302,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Add a customize control.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.5.0 Return added WP_Customize_Control instance.
+ * @access public
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Customize_Control|string $id Customize Control object, or ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Control arguments; passed to WP_Customize_Control
</span><span class="cx" style="display: block; padding: 0 10px"> * constructor.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_Customize_Control The instance of the control that was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add_control( $id, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $id instanceof WP_Customize_Control ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1297,7 +1316,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $control = new WP_Customize_Control( $this, $id, $args );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->controls[ $control->id ] = $control;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $control;
</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"> /**
</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 17:51:21 UTC (rev 35780)
+++ trunk/tests/phpunit/tests/customize/manager.php 2015-12-06 18:09:42 UTC (rev 35781)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -492,4 +492,113 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $sorted_control_ids = wp_list_pluck( $manager->get_section( $section_id )->controls, 'id' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $added_control_ids, $sorted_control_ids );
</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 34596
+ */
+ function test_add_section_return_instance() {
+ $manager = new WP_Customize_Manager();
+ wp_set_current_user( self::factory()->user->create( array( 'role' => 'administrator' ) ) );
+
+ $section_id = 'foo-section';
+ $result_section = $manager->add_section( $section_id, array(
+ 'title' => 'Section',
+ 'priority' => 1,
+ ) );
+
+ $this->assertInstanceOf( 'WP_Customize_Section', $result_section );
+ $this->assertEquals( $section_id, $result_section->id );
+
+ $section = new WP_Customize_Section( $manager, $section_id, array(
+ 'title' => 'Section 2',
+ 'priority' => 2,
+ ) );
+ $result_section = $manager->add_section( $section );
+
+ $this->assertInstanceOf( 'WP_Customize_Section', $result_section );
+ $this->assertEquals( $section_id, $result_section->id );
+ $this->assertEquals( $section, $result_section );
+ }
+
+ /**
+ * @ticket 34596
+ */
+ function test_add_setting_return_instance() {
+ $manager = new WP_Customize_Manager();
+ wp_set_current_user( self::factory()->user->create( array( 'role' => 'administrator' ) ) );
+
+ $setting_id = 'foo-setting';
+ $result_setting = $manager->add_setting( $setting_id );
+
+ $this->assertInstanceOf( 'WP_Customize_Setting', $result_setting );
+ $this->assertEquals( $setting_id, $result_setting->id );
+
+ $setting = new WP_Customize_Setting( $manager, $setting_id );
+ $result_setting = $manager->add_setting( $setting );
+
+ $this->assertInstanceOf( 'WP_Customize_Setting', $result_setting );
+ $this->assertEquals( $setting, $result_setting );
+ $this->assertEquals( $setting_id, $result_setting->id );
+ }
+
+ /**
+ * @ticket 34596
+ */
+ function test_add_panel_return_instance() {
+ $manager = new WP_Customize_Manager();
+ wp_set_current_user( self::factory()->user->create( array( 'role' => 'administrator' ) ) );
+
+ $panel_id = 'foo-panel';
+ $result_panel = $manager->add_panel( $panel_id, array(
+ 'title' => 'Test Panel',
+ 'priority' => 2,
+ ) );
+
+ $this->assertInstanceOf( 'WP_Customize_Panel', $result_panel );
+ $this->assertEquals( $panel_id, $result_panel->id );
+
+ $panel = new WP_Customize_Panel( $manager, $panel_id, array(
+ 'title' => 'Test Panel 2',
+ ) );
+ $result_panel = $manager->add_panel( $panel );
+
+ $this->assertInstanceOf( 'WP_Customize_Panel', $result_panel );
+ $this->assertEquals( $panel, $result_panel );
+ $this->assertEquals( $panel_id, $result_panel->id );
+ }
+
+ /**
+ * @ticket 34596
+ */
+ function test_add_control_return_instance() {
+ $manager = new WP_Customize_Manager();
+ $section_id = 'foo-section';
+ wp_set_current_user( self::factory()->user->create( array( 'role' => 'administrator' ) ) );
+ $manager->add_section( $section_id, array(
+ 'title' => 'Section',
+ 'priority' => 1,
+ ) );
+
+ $control_id = 'foo-control';
+ $manager->add_setting( $control_id );
+
+ $result_control = $manager->add_control( $control_id, array(
+ 'section' => $section_id,
+ 'priority' => 1,
+ 'setting' => $control_id,
+ ) );
+ $this->assertInstanceOf( 'WP_Customize_Control', $result_control );
+ $this->assertEquals( $control_id, $result_control->id );
+
+ $control = new WP_Customize_Control( $manager, $control_id, array(
+ 'section' => $section_id,
+ 'priority' => 1,
+ 'setting' => $control_id,
+ ) );
+ $result_control = $manager->add_control( $control );
+
+ $this->assertInstanceOf( 'WP_Customize_Control', $result_control );
+ $this->assertEquals( $control, $result_control );
+ $this->assertEquals( $control_id, $result_control->id );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>