<!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>[41824] trunk: Customize: Introduce `WP_Customize_Manager::trash_changeset_post()` to reduce duplication and ensure proper changeset trashing logic.</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/41824">41824</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/41824","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-10-11 05:41:14 +0000 (Wed, 11 Oct 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: Introduce `WP_Customize_Manager::trash_changeset_post()` to reduce duplication and ensure proper changeset trashing logic.
Trashing a changeset via `wp_trash_post()` does not have the desired result since it mutates `post_content` (via Kses) and the `post_name` (even though it is a UUID).
Props dlh.
See <a href="https://core.trac.wordpress.org/ticket/39896">#39896</a>, <a href="https://core.trac.wordpress.org/ticket/42030">#42030</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/42175">#42175</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="#trunksrcwpincludesthemephp">trunk/src/wp-includes/theme.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 2017-10-11 05:27:05 UTC (rev 41823)
+++ trunk/src/wp-includes/class-wp-customize-manager.php 2017-10-11 05:41:14 UTC (rev 41824)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2831,6 +2831,79 @@
</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">+ * Trash or delete a changeset post.
+ *
+ * The following re-formulates the logic from `wp_trash_post()` as done in
+ * `wp_publish_post()`. The reason for bypassing `wp_trash_post()` is that it
+ * will mutate the the `post_content` and the `post_name` when they should be
+ * untouched.
+ *
+ * @since 4.9.0
+ * @global wpdb $wpdb WordPress database abstraction object.
+ * @see wp_trash_post()
+ *
+ * @param int|WP_Post $post The changeset post.
+ * @return mixed A WP_Post object for the trashed post or an empty value on failure.
+ */
+ public function trash_changeset_post( $post ) {
+ global $wpdb;
+
+ $post = get_post( $post );
+
+ if ( ! ( $post instanceof WP_Post ) ) {
+ return $post;
+ }
+ $post_id = $post->ID;
+
+ if ( ! EMPTY_TRASH_DAYS ) {
+ return wp_delete_post( $post_id, true );
+ }
+
+ if ( 'trash' === get_post_status( $post ) ) {
+ return false;
+ }
+
+ /** This filter is documented in wp-includes/post.php */
+ $check = apply_filters( 'pre_trash_post', null, $post );
+ if ( null !== $check ) {
+ return $check;
+ }
+
+ /** This action is documented in wp-includes/post.php */
+ do_action( 'wp_trash_post', $post_id );
+
+ add_post_meta( $post_id, '_wp_trash_meta_status', $post->post_status );
+ add_post_meta( $post_id, '_wp_trash_meta_time', time() );
+
+ $old_status = $post->post_status;
+ $new_status = 'trash';
+ $wpdb->update( $wpdb->posts, array( 'post_status' => $new_status ), array( 'ID' => $post->ID ) );
+ clean_post_cache( $post->ID );
+
+ $post->post_status = $new_status;
+ wp_transition_post_status( $new_status, $old_status, $post );
+
+ /** This action is documented in wp-includes/post.php */
+ do_action( 'edit_post', $post->ID, $post );
+
+ /** This action is documented in wp-includes/post.php */
+ do_action( "save_post_{$post->post_type}", $post->ID, $post, true );
+
+ /** This action is documented in wp-includes/post.php */
+ do_action( 'save_post', $post->ID, $post, true );
+
+ /** This action is documented in wp-includes/post.php */
+ do_action( 'wp_insert_post', $post->ID, $post, true );
+
+ wp_trash_post_comments( $post_id );
+
+ /** This action is documented in wp-includes/post.php */
+ do_action( 'trashed_post', $post_id );
+
+ return $post;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Handle request to trash a changeset.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2876,7 +2949,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $r = wp_trash_post( $changeset_post_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $r = $this->trash_changeset_post( $changeset_post_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! ( $r instanceof WP_Post ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_send_json_error( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'code' => 'changeset_trash_failure',
</span></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-10-11 05:27:05 UTC (rev 41823)
+++ trunk/src/wp-includes/theme.php 2017-10-11 05:41:14 UTC (rev 41824)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2909,47 +2909,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * and thus garbage collected.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! wp_revisions_enabled( $changeset_post ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $post = $changeset_post;
- $post_id = $changeset_post->ID;
-
- /*
- * The following re-formulates the logic from wp_trash_post() as done in
- * wp_publish_post(). The reason for bypassing wp_trash_post() is that it
- * will mutate the post_content and the post_name when they should be
- * untouched.
- */
- if ( ! EMPTY_TRASH_DAYS ) {
- wp_delete_post( $post_id, true );
- } else {
- /** This action is documented in wp-includes/post.php */
- do_action( 'wp_trash_post', $post_id );
-
- add_post_meta( $post_id, '_wp_trash_meta_status', $post->post_status );
- add_post_meta( $post_id, '_wp_trash_meta_time', time() );
-
- $old_status = $post->post_status;
- $new_status = 'trash';
- $wpdb->update( $wpdb->posts, array( 'post_status' => $new_status ), array( 'ID' => $post->ID ) );
- clean_post_cache( $post->ID );
-
- $post->post_status = $new_status;
- wp_transition_post_status( $new_status, $old_status, $post );
-
- /** This action is documented in wp-includes/post.php */
- do_action( 'edit_post', $post->ID, $post );
-
- /** This action is documented in wp-includes/post.php */
- do_action( "save_post_{$post->post_type}", $post->ID, $post, true );
-
- /** This action is documented in wp-includes/post.php */
- do_action( 'save_post', $post->ID, $post, true );
-
- /** This action is documented in wp-includes/post.php */
- do_action( 'wp_insert_post', $post->ID, $post, true );
-
- /** This action is documented in wp-includes/post.php */
- do_action( 'trashed_post', $post_id );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_customize->trash_changeset_post( $changeset_post->ID );
</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 2017-10-11 05:27:05 UTC (rev 41823)
+++ trunk/tests/phpunit/tests/customize/manager.php 2017-10-11 05:41:14 UTC (rev 41824)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1710,6 +1710,35 @@
</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 that trash_changeset_post() trashes a changeset post with its name and content preserved.
+ *
+ * @covers WP_Customize_Manager::trash_changeset_post
+ */
+ public function test_trash_changeset_post_preserves_properties() {
+ $args = array(
+ 'post_type' => 'customize_changeset',
+ 'post_content' => wp_json_encode( array(
+ 'blogname' => array(
+ 'value' => 'Test',
+ ),
+ ) ),
+ 'post_name' => wp_generate_uuid4(),
+ 'post_status' => 'draft',
+ );
+
+ $post_id = wp_insert_post( $args );
+
+ $manager = $this->create_test_manager( $args['post_name'] );
+ $manager->trash_changeset_post( $post_id );
+
+ $post = get_post( $post_id );
+
+ $this->assertSame( 'trash', get_post_status( $post_id ) );
+ $this->assertSame( $args['post_name'], $post->post_name );
+ $this->assertSame( $args['post_content'], $post->post_content );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Register scratchpad setting.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Customize_Manager $wp_customize Manager.
</span></span></pre>
</div>
</div>
</body>
</html>