<!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>[49985] trunk: Media: Ensure `get_post_status()` returns correct result for attachments.</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/49985">49985</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/49985","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-01-20 04:39:24 +0000 (Wed, 20 Jan 2021)</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'>Media: Ensure `get_post_status()` returns correct result for attachments.
Prevent `get_post_status()` returning `false` for attachments if the parent post has been deleted. The returned attachment post status is now passed through the `get_post_status` filter.
Add tests for `get_post_status()`.
Props peterwilsoncc, timothyblynjacobs for review.
Fixes <a href="https://core.trac.wordpress.org/ticket/52326">#52326</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestspostgetPostStatusphp">trunk/tests/phpunit/tests/post/getPostStatus.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludespostphp"></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/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post.php 2021-01-19 16:46:50 UTC (rev 49984)
+++ trunk/src/wp-includes/post.php 2021-01-20 04:39:24 UTC (rev 49985)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -901,25 +901,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- if ( 'attachment' === $post->post_type ) {
- if ( 'private' === $post->post_status ) {
- return 'private';
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_status = $post->post_status;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Unattached attachments are assumed to be published.
- if ( ( 'inherit' === $post->post_status ) && ( 0 == $post->post_parent ) ) {
- return 'publish';
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (
+ 'attachment' === $post->post_type &&
+ 'inherit' === $post_status
+ ) {
+ // Attachment permitted statuses: 'inherit', , see wp_insert_post().
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Inherit status from the parent.
- if ( $post->post_parent && ( $post->ID != $post->post_parent ) ) {
- $parent_post_status = get_post_status( $post->post_parent );
- if ( 'trash' === $parent_post_status ) {
- return get_post_meta( $post->post_parent, '_wp_trash_meta_status', true );
- } else {
- return $parent_post_status;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (
+ 0 === $post->post_parent ||
+ ! get_post( $post->post_parent ) ||
+ $post->ID === $post->post_parent
+ ) {
+ // Unattached attachments with inherit status are assumed to be published.
+ $post_status = 'publish';
+ } elseif ( 'trash' === get_post_status( $post->post_parent ) ) {
+ // Get parent status prior to trashing.
+ $post_status = get_post_meta( $post->post_parent, '_wp_trash_meta_status', true );
+ if ( ! $post_status ) {
+ // Assume publish as above.
+ $post_status = 'publish';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ $post_status = get_post_status( $post->post_parent );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif (
+ 'attachment' === $post->post_type &&
+ ! in_array( $post_status, array( 'private', 'trash', 'auto-draft' ), true )
+ ) {
+ /*
+ * Ensure uninherited attachments have a permitted status either 'private', 'trash', 'auto-draft'.
+ * This is to match the logic in wp_insert_post().
+ *
+ * Note: 'inherit' is excluded from this check as it is resolved to the parent post's
+ * status in the logic block above.
+ */
+ $post_status = 'publish';
</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">@@ -926,11 +944,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the post status.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.7.0 The attachment post type is now passed through this filter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $post_status The post status.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post The post object.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return apply_filters( 'get_post_status', $post->post_status, $post );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( 'get_post_status', $post_status, $post );
</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="trunktestsphpunittestspostgetPostStatusphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/post/getPostStatus.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/getPostStatus.php (rev 0)
+++ trunk/tests/phpunit/tests/post/getPostStatus.php 2021-01-20 04:39:24 UTC (rev 49985)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,167 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group post
+ */
+class Tests_Post_GetPostStatus extends WP_UnitTestCase {
+
+ /**
+ * Array of post IDs.
+ *
+ * @var int[]
+ */
+ public static $post_ids;
+
+ /**
+ * Create shared fixtures.
+ */
+ public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
+ $post_statuses = array( 'publish', 'future', 'draft', 'auto-draft', 'trash', 'private', 'delete' );
+ foreach ( $post_statuses as $post_status ) {
+ $date = '';
+ $actual_status = $post_status;
+ if ( 'future' === $post_status ) {
+ $date = strftime( '%Y-%m-%d %H:%M:%S', strtotime( '+1 year' ) );
+ } elseif ( in_array( $post_status, array( 'trash', 'delete' ), true ) ) {
+ $actual_status = 'publish';
+ }
+
+ self::$post_ids[ $post_status ] = $factory->post->create(
+ array(
+ 'post_status' => $actual_status,
+ 'post_date' => $date,
+ 'post_name' => "$post_status-post",
+ )
+ );
+
+ // Attachments without parent or media.
+ self::$post_ids[ "$post_status-attachment-no-parent" ] = $factory->attachment->create_object(
+ array(
+ 'post_status' => $actual_status,
+ 'post_name' => "$post_status-attachment-no-parent",
+ 'post_date' => $date,
+ )
+ );
+
+ // Attachments without media.
+ self::$post_ids[ "$post_status-attachment" ] = $factory->attachment->create_object(
+ array(
+ 'post_parent' => self::$post_ids[ $post_status ],
+ 'post_status' => 'inherit',
+ 'post_name' => "$post_status-attachment",
+ 'post_date' => $date,
+ )
+ );
+ }
+
+ // Attachment with incorrect parent ID.
+ self::$post_ids['badly-parented-attachment'] = $factory->attachment->create_object(
+ array(
+ 'post_parent' => PHP_INT_MAX, // Impossibly large number.
+ 'post_status' => 'inherit',
+ 'post_name' => "$post_status-attachment",
+ 'post_date' => $date,
+ )
+ );
+
+ // Trash the trash post and attachment.
+ wp_trash_post( self::$post_ids['trash'] );
+ wp_trash_post( self::$post_ids['trash-attachment-no-parent'] );
+
+ // Force delete parent and unattached post objects.
+ wp_delete_post( self::$post_ids['delete'], true );
+ wp_delete_post( self::$post_ids['delete-attachment-no-parent'], true );
+ }
+
+ /**
+ * Ensure `get_post_status()` resolves correctly for posts and attachments.
+ *
+ * @ticket 52326
+ * @dataProvider data_get_post_status_resolves
+ *
+ * @param string $post_key The post key in self::$post_ids.
+ * @param string $expected The expected get_post_status() return value.
+ */
+ public function test_get_post_status_resolves( $post_key, $expected ) {
+ $this->assertSame( $expected, get_post_status( self::$post_ids[ $post_key ] ) );
+ }
+
+ /**
+ * Data provider for test_get_post_status_resolves().
+ *
+ * @return array[] {
+ * @type string $post_key The post key in self::$post_ids.
+ * @type string $expected The expected get_post_status() return value.
+ * }
+ */
+ public function data_get_post_status_resolves() {
+ return array(
+ array( 'publish', 'publish' ),
+ array( 'future', 'future' ),
+ array( 'draft', 'draft' ),
+ array( 'auto-draft', 'auto-draft' ),
+ array( 'trash', 'trash' ),
+ array( 'private', 'private' ),
+ array( 'delete', false ),
+
+ // Attachment with `inherit` status from parent.
+ array( 'publish-attachment', 'publish' ),
+ array( 'future-attachment', 'future' ),
+ array( 'draft-attachment', 'draft' ),
+ array( 'auto-draft-attachment', 'auto-draft' ),
+ array( 'trash-attachment', 'publish' ),
+ array( 'private-attachment', 'private' ),
+ array( 'delete-attachment', 'publish' ),
+
+ // Attachment with native status (rather than inheriting from parent).
+ array( 'publish-attachment-no-parent', 'publish' ),
+ array( 'future-attachment-no-parent', 'publish' ), // Attachments can't have future status.
+ array( 'draft-attachment-no-parent', 'publish' ), // Attachments can't have draft status.
+ array( 'auto-draft-attachment-no-parent', 'auto-draft' ),
+ array( 'trash-attachment-no-parent', 'trash' ),
+ array( 'private-attachment-no-parent', 'private' ),
+ array( 'delete-attachment-no-parent', false ),
+
+ // Attachment attempting to inherit from an invalid parent number.
+ array( 'badly-parented-attachment', 'publish' ),
+ );
+ }
+
+ /**
+ * Ensure post status resolves after trashing parent posts.
+ *
+ * @ticket 52326
+ * @dataProvider data_get_post_status_after_trashing
+ *
+ * @param string $post_to_test The post key in self::$post_ids.
+ * @param string $post_to_trash The post key to trash then delete in self::$post_ids.
+ * @param string $expected The expected result after trashing the post.
+ */
+ public function test_get_post_status_after_trashing( $post_to_test, $post_to_trash, $expected ) {
+ wp_trash_post( self::$post_ids[ $post_to_trash ] );
+ $this->assertSame( $expected, get_post_status( self::$post_ids[ $post_to_test ] ) );
+
+ // Now delete the post, expect publish.
+ wp_delete_post( self::$post_ids[ $post_to_trash ], true );
+ $this->assertSame( 'publish', get_post_status( self::$post_ids[ $post_to_test ] ) );
+ }
+
+ /**
+ * Data provider for test_get_post_status_after_trashing().
+ * @return array[] {
+ * @type string $post_to_test The post key in self::$post_ids.
+ * @type string $post_to_trash The post key to trash then delete in self::$post_ids.
+ * @type string $expected The expected result after trashing the post.
+ * }
+ */
+ public function data_get_post_status_after_trashing() {
+ return array(
+ array( 'publish-attachment', 'publish', 'publish' ),
+ array( 'future-attachment', 'future', 'future' ),
+ array( 'draft-attachment', 'draft', 'draft' ),
+ array( 'auto-draft-attachment', 'auto-draft', 'auto-draft' ),
+ array( 'private-attachment', 'private', 'private' ),
+ array( 'delete-attachment', 'publish', 'publish' ),
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/post/getPostStatus.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>