<!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>[46548] trunk: Customize: Ensure that `WP_Customize_Manager::import_theme_starter_content()` properly handles starter content with (nested) arrays as values.</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 { white-space: pre-line; 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/46548">46548</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/46548","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-10-15 16:41:51 +0000 (Tue, 15 Oct 2019)</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'>Customize: Ensure that `WP_Customize_Manager::import_theme_starter_content()` properly handles starter content with (nested) arrays as values.
Previously, searching for symbol references to replace with post or attachment IDs in array values resulted in a PHP warning.
Props timph, JarretC, SergeyBiryukov.
Fixes <a href="https://core.trac.wordpress.org/ticket/45484">#45484</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 2019-10-15 16:36:42 UTC (rev 46547)
+++ trunk/src/wp-includes/class-wp-customize-manager.php 2019-10-15 16:41:51 UTC (rev 46548)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1517,7 +1517,27 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Options.
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $options as $name => $value ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( preg_match( '/^{{(?P<symbol>.+)}}$/', $value, $matches ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Serialize the value to check for post symbols.
+ $value = maybe_serialize( $value );
+
+ if ( is_serialized( $value ) ) {
+ if ( preg_match( '/s:\d+:"{{(?P<symbol>.+)}}"/', $value, $matches ) ) {
+ if ( isset( $posts[ $matches['symbol'] ] ) ) {
+ $symbol_match = $posts[ $matches['symbol'] ]['ID'];
+ } elseif ( isset( $attachment_ids[ $matches['symbol'] ] ) ) {
+ $symbol_match = $attachment_ids[ $matches['symbol'] ];
+ }
+
+ // If we have any symbol matches, update the values.
+ if ( isset( $symbol_match ) ) {
+ // Replace found string matches with post IDs.
+ $value = str_replace( $matches[0], "i:{$symbol_match}", $value );
+ } else {
+ continue;
+ }
+ }
+ } elseif ( preg_match( '/^{{(?P<symbol>.+)}}$/', $value, $matches ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $posts[ $matches['symbol'] ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $value = $posts[ $matches['symbol'] ]['ID'];
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( isset( $attachment_ids[ $matches['symbol'] ] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1527,6 +1547,9 @@
</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">+ // Unserialize values after checking for post symbols, so they can be properly referenced.
+ $value = maybe_unserialize( $value );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $changeset_data[ $name ] ) || ! empty( $changeset_data[ $name ]['starter_content'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->set_post_value( $name, $value );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->pending_starter_content_settings_ids[] = $name;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1535,7 +1558,28 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Theme mods.
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $theme_mods as $name => $value ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( preg_match( '/^{{(?P<symbol>.+)}}$/', $value, $matches ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Serialize the value to check for post symbols.
+ $value = maybe_serialize( $value );
+
+ // Check if value was serialized.
+ if ( is_serialized( $value ) ) {
+ if ( preg_match( '/s:\d+:"{{(?P<symbol>.+)}}"/', $value, $matches ) ) {
+ if ( isset( $posts[ $matches['symbol'] ] ) ) {
+ $symbol_match = $posts[ $matches['symbol'] ]['ID'];
+ } elseif ( isset( $attachment_ids[ $matches['symbol'] ] ) ) {
+ $symbol_match = $attachment_ids[ $matches['symbol'] ];
+ }
+
+ // If we have any symbol matches, update the values.
+ if ( isset( $symbol_match ) ) {
+ // Replace found string matches with post IDs.
+ $value = str_replace( $matches[0], "i:{$symbol_match}", $value );
+ } else {
+ continue;
+ }
+ }
+ } elseif ( preg_match( '/^{{(?P<symbol>.+)}}$/', $value, $matches ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $posts[ $matches['symbol'] ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $value = $posts[ $matches['symbol'] ]['ID'];
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( isset( $attachment_ids[ $matches['symbol'] ] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1545,6 +1589,9 @@
</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">+ // Unserialize values after checking for post symbols, so they can be properly referenced.
+ $value = maybe_unserialize( $value );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Handle header image as special case since setting has a legacy format.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'header_image' === $name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $name = 'header_image_data';
</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 2019-10-15 16:36:42 UTC (rev 46547)
+++ trunk/tests/phpunit/tests/customize/manager.php 2019-10-15 16:41:51 UTC (rev 46548)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -741,7 +741,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Ensure that re-importing doesn't cause auto-drafts to balloon.
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_customize->import_theme_starter_content();
</span><span class="cx" style="display: block; padding: 0 10px"> $changeset_data = $wp_customize->changeset_data();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEqualSets( array_values( $posts_by_name ), $changeset_data['nav_menus_created_posts']['value'] ); // Auto-drafts should not get re-created and amended with each import.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Auto-drafts should not get re-created and amended with each import.
+ $this->assertEqualSets( array_values( $posts_by_name ), $changeset_data['nav_menus_created_posts']['value'] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Test that saving non-starter content on top of the changeset clears the starter_content flag.
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_customize->save_changeset_post(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -755,7 +756,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayNotHasKey( 'starter_content', $changeset_data['blogname'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'starter_content', $changeset_data['blogdescription'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Test that adding blogname starter content is ignored now that it is modified, but updating a non-modified starter content blog description passes.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Test that adding blogname starter content is ignored now that it is modified,
+ * but updating a non-modified starter content blog description passes.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $previous_blogname = $changeset_data['blogname']['value'];
</span><span class="cx" style="display: block; padding: 0 10px"> $previous_blogdescription = $changeset_data['blogdescription']['value'];
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_customize->import_theme_starter_content(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -801,6 +805,80 @@
</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">+ * Test WP_Customize_Manager::import_theme_starter_content() with nested arrays.
+ *
+ * @ticket 45484
+ * @covers WP_Customize_Manager::import_theme_starter_content()
+ */
+ function test_import_theme_starter_content_with_nested_arrays() {
+ wp_set_current_user( self::$admin_user_id );
+
+ $existing_published_home_page_id = $this->factory()->post->create(
+ array(
+ 'post_name' => 'home',
+ 'post_type' => 'page',
+ 'post_status' => 'publish',
+ )
+ );
+
+ global $wp_customize;
+ $wp_customize = new WP_Customize_Manager();
+ $starter_content_config = array(
+ 'posts' => array(
+ 'home',
+ ),
+ 'options' => array(
+ 'array_option' => array(
+ 0,
+ 1,
+ 'home_page_id' => '{{home}}',
+ ),
+ 'nested_array_option' => array(
+ 0,
+ 1,
+ array(
+ 2,
+ 'home_page_id' => '{{home}}',
+ ),
+ ),
+ ),
+ 'theme_mods' => array(
+ 'array_theme_mod' => array(
+ 0,
+ 1,
+ 'home_page_id' => '{{home}}',
+ ),
+ 'nested_array_theme_mod' => array(
+ 0,
+ 1,
+ array(
+ 2,
+ 'home_page_id' => '{{home}}',
+ ),
+ ),
+ ),
+ );
+
+ add_theme_support( 'starter-content', $starter_content_config );
+ $this->assertEmpty( $wp_customize->unsanitized_post_values() );
+ $wp_customize->import_theme_starter_content();
+ $changeset_values = $wp_customize->unsanitized_post_values();
+ $expected_setting_ids = array(
+ 'array_option',
+ 'array_theme_mod',
+ 'nav_menus_created_posts',
+ 'nested_array_option',
+ 'nested_array_theme_mod',
+ );
+ $this->assertEqualSets( $expected_setting_ids, array_keys( $changeset_values ) );
+
+ $this->assertSame( $existing_published_home_page_id, $changeset_values['array_option']['home_page_id'] );
+ $this->assertSame( $existing_published_home_page_id, $changeset_values['nested_array_option'][2]['home_page_id'] );
+ $this->assertSame( $existing_published_home_page_id, $changeset_values['array_theme_mod']['home_page_id'] );
+ $this->assertSame( $existing_published_home_page_id, $changeset_values['nested_array_theme_mod'][2]['home_page_id'] );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Test WP_Customize_Manager::customize_preview_init().
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 30937
</span></span></pre>
</div>
</div>
</body>
</html>