<!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>[40676] trunk: Customize: Keep alive auto-drafts created for page/post stubs when parent changeset is updated, and delete when changeset is garbage-collected.</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/40676">40676</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/40676","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>2017-05-16 05:36:25 +0000 (Tue, 16 May 2017)</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: Keep alive auto-drafts created for page/post stubs when parent changeset is updated, and delete when changeset is garbage-collected.
Props utkarshpatel, westonruter.
See <a href="https://core.trac.wordpress.org/ticket/31089">#31089</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/39715">#39715</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesdefaultfiltersphp">trunk/src/wp-includes/default-filters.php</a></li>
<li><a href="#trunksrcwpincludesnavmenuphp">trunk/src/wp-includes/nav-menu.php</a></li>
<li><a href="#trunksrcwpincludesthemephp">trunk/src/wp-includes/theme.php</a></li>
<li><a href="#trunktestsphpunittestspostnavmenuphp">trunk/tests/phpunit/tests/post/nav-menu.php</a></li>
<li><a href="#trunktestsphpunitteststhemephp">trunk/tests/phpunit/tests/theme.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesdefaultfiltersphp"></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/default-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/default-filters.php 2017-05-16 00:10:42 UTC (rev 40675)
+++ trunk/src/wp-includes/default-filters.php 2017-05-16 05:36:25 UTC (rev 40676)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -325,6 +325,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'delete_post', '_wp_delete_post_menu_item' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'delete_term', '_wp_delete_tax_menu_item', 10, 3 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'transition_post_status', '_wp_auto_add_pages_to_menu', 10, 3 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_action( 'delete_post', '_wp_delete_customize_changeset_dependent_auto_drafts' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Post Thumbnail CSS class filtering
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'begin_fetch_post_thumbnail_html', '_wp_post_thumbnail_class_filter_add' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -400,6 +401,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'transition_post_status', '_wp_customize_publish_changeset', 10, 3 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'admin_enqueue_scripts', '_wp_customize_loader_settings' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'delete_attachment', '_delete_attachment_theme_mod' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_action( 'transition_post_status', '_wp_keep_alive_customize_changeset_dependent_auto_drafts', 20, 3 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Calendar widget cache
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'save_post', 'delete_get_calendar_cache' );
</span></span></pre></div>
<a id="trunksrcwpincludesnavmenuphp"></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/nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/nav-menu.php 2017-05-16 00:10:42 UTC (rev 40675)
+++ trunk/src/wp-includes/nav-menu.php 2017-05-16 05:36:25 UTC (rev 40676)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -978,3 +978,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_update_nav_menu_item( $menu_id, 0, $args );
</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">+
+/**
+ * Delete auto-draft posts associated with the supplied changeset.
+ *
+ * @since 4.8.0
+ * @access private
+ *
+ * @param int $post_id Post ID for the customize_changeset.
+ */
+function _wp_delete_customize_changeset_dependent_auto_drafts( $post_id ) {
+ $post = get_post( $post_id );
+
+ if ( ! $post || 'customize_changeset' !== $post->post_type ) {
+ return;
+ }
+
+ $data = json_decode( $post->post_content, true );
+ if ( empty( $data['nav_menus_created_posts']['value'] ) ) {
+ return;
+ }
+ remove_action( 'delete_post', '_wp_delete_customize_changeset_dependent_auto_drafts' );
+ foreach ( $data['nav_menus_created_posts']['value'] as $post_id ) {
+ if ( ! empty( $post_id ) && 'auto-draft' === get_post_status( $post_id ) ) {
+ wp_delete_post( $post_id, true );
+ }
+ }
+ add_action( 'delete_post', '_wp_delete_customize_changeset_dependent_auto_drafts' );
+}
</ins></span></pre></div>
<a id="trunksrcwpincludesthemephp"></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/theme.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/theme.php 2017-05-16 00:10:42 UTC (rev 40675)
+++ trunk/src/wp-includes/theme.php 2017-05-16 05:36:25 UTC (rev 40676)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3059,3 +3059,65 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return ( $wp_customize instanceof WP_Customize_Manager ) && $wp_customize->is_preview();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Make sure that auto-draft posts get their post_date bumped to prevent premature garbage-collection.
+ *
+ * When a changeset is updated but remains an auto-draft, ensure the post_date
+ * for the auto-draft posts remains the same so that it will be
+ * garbage-collected at the same time by `wp_delete_auto_drafts()`. Otherwise,
+ * if the changeset is updated to be a draft then update the posts
+ * to have a far-future post_date so that they will never be garbage collected
+ * unless the changeset post itself is deleted.
+ *
+ * @since 4.8.0
+ * @access private
+ * @see wp_delete_auto_drafts()
+ *
+ * @param string $new_status Transition to this post status.
+ * @param string $old_status Previous post status.
+ * @param \WP_Post $post Post data.
+ * @global wpdb $wpdb
+ */
+function _wp_keep_alive_customize_changeset_dependent_auto_drafts( $new_status, $old_status, $post ) {
+ global $wpdb;
+ unset( $old_status );
+
+ // Short-circuit if not a changeset or if the changeset was published.
+ if ( 'customize_changeset' !== $post->post_type || 'publish' === $new_status ) {
+ return;
+ }
+
+ if ( 'auto-draft' === $new_status ) {
+ /*
+ * Keep the post date for the post matching the changeset
+ * so that it will not be garbage-collected before the changeset.
+ */
+ $new_post_date = $post->post_date;
+ } else {
+ /*
+ * Since the changeset no longer has an auto-draft (and it is not published)
+ * it is now a persistent changeset, a long-lived draft, and so any
+ * associated auto-draft posts should have their dates
+ * pushed out very far into the future to prevent them from ever
+ * being garbage-collected.
+ */
+ $new_post_date = gmdate( 'Y-m-d H:i:d', strtotime( '+100 years' ) );
+ }
+
+ $data = json_decode( $post->post_content, true );
+ if ( empty( $data['nav_menus_created_posts']['value'] ) ) {
+ return;
+ }
+ foreach ( $data['nav_menus_created_posts']['value'] as $post_id ) {
+ if ( empty( $post_id ) || 'auto-draft' !== get_post_status( $post_id ) ) {
+ continue;
+ }
+ $wpdb->update(
+ $wpdb->posts,
+ array( 'post_date' => $new_post_date ), // Note wp_delete_auto_drafts() only looks at this this date.
+ array( 'ID' => $post_id )
+ );
+ clean_post_cache( $post_id );
+ }
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestspostnavmenuphp"></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/post/nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/nav-menu.php 2017-05-16 00:10:42 UTC (rev 40675)
+++ trunk/tests/phpunit/tests/post/nav-menu.php 2017-05-16 05:36:25 UTC (rev 40676)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -523,4 +523,34 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotContains( 'menu-item-home', $classes );
</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_delete_customize_changeset_dependent_auto_drafts.
+ *
+ * @covers _wp_delete_customize_changeset_dependent_auto_drafts()
+ */
+ function test_wp_delete_customize_changeset_dependent_auto_drafts() {
+ $nav_created_post_ids = $this->factory()->post->create_many(2, array(
+ 'post_status' => 'auto-draft',
+ ) );
+ $data = array(
+ 'nav_menus_created_posts' => array(
+ 'value' => $nav_created_post_ids,
+ ),
+ );
+ wp_set_current_user( self::factory()->user->create( array(
+ 'role' => 'administrator',
+ ) ) );
+ require_once ABSPATH . WPINC . '/class-wp-customize-manager.php';
+ $wp_customize = new WP_Customize_Manager();
+ do_action( 'customize_register', $wp_customize );
+ $wp_customize->save_changeset_post( array(
+ 'data' => $data,
+ ) );
+ $this->assertInstanceOf( 'WP_Post', get_post( $nav_created_post_ids[0] ) );
+ $this->assertInstanceOf( 'WP_Post', get_post( $nav_created_post_ids[1] ) );
+ wp_delete_post( $wp_customize->changeset_post_id(), true );
+ $this->assertNotInstanceOf( 'WP_Post', get_post( $nav_created_post_ids[0] ) );
+ $this->assertNotInstanceOf( 'WP_Post', get_post( $nav_created_post_ids[1] ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunitteststhemephp"></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/theme.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/theme.php 2017-05-16 00:10:42 UTC (rev 40675)
+++ trunk/tests/phpunit/tests/theme.php 2017-05-16 05:36:25 UTC (rev 40676)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -309,4 +309,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals($template, get_template());
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals($style, get_stylesheet());
</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_keep_alive_customize_changeset_dependent_auto_drafts.
+ *
+ * @covers _wp_keep_alive_customize_changeset_dependent_auto_drafts()
+ */
+ function test_wp_keep_alive_customize_changeset_dependent_auto_drafts() {
+ $nav_created_post_ids = $this->factory()->post->create_many(2, array(
+ 'post_status' => 'auto-draft',
+ ) );
+ $data = array(
+ 'nav_menus_created_posts' => array(
+ 'value' => $nav_created_post_ids,
+ ),
+ );
+ wp_set_current_user( self::factory()->user->create( array( 'role' => 'administrator' ) ) );
+ require_once ABSPATH . WPINC . '/class-wp-customize-manager.php';
+ $wp_customize = new WP_Customize_Manager();
+ do_action( 'customize_register', $wp_customize );
+ $wp_customize->save_changeset_post( array(
+ 'data' => $data,
+ ) );
+ $this->assertEquals( get_post( $nav_created_post_ids[0] )->post_date, get_post( $wp_customize->changeset_post_id() )->post_date );
+ $this->assertEquals( get_post( $nav_created_post_ids[1] )->post_date, get_post( $wp_customize->changeset_post_id() )->post_date );
+ $wp_customize->save_changeset_post( array(
+ 'status' => 'draft',
+ 'data' => $data,
+ ) );
+ $expected_year = date( 'Y' ) + 100;
+ $this->assertEquals( $expected_year, date( 'Y', strtotime( get_post( $nav_created_post_ids[0] )->post_date ) ) );
+ $this->assertEquals( $expected_year, date( 'Y', strtotime( get_post( $nav_created_post_ids[1] )->post_date ) ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>