<!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>[53042] trunk: Posts, Post Types: Set post filter in `update_post_cache()`.</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/53042">53042</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/53042","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>2022-04-01 03:16:33 +0000 (Fri, 01 Apr 2022)</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'>Posts, Post Types: Set post filter in `update_post_cache()`.
Ensure the post cache is primed with raw sanitized data. This resolves an inconsistency between how posts retrieved via `get_post()` vs `WP_Query` are cached.
This prevents `sanitize_post( $post, 'raw' )` being run multiple times on a cached post. This can happen over 20 times per post on some page loads so avoiding this will provide a noticeable performance boost.
Props Cybr, SergeyBiryukov, peterwilsoncc, hellofromTonya, costdev.
Fixes <a href="https://core.trac.wordpress.org/ticket/50567">#50567</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswppostphp">trunk/src/wp-includes/class-wp-post.php</a></li>
<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestspostupdatePostCachephp">trunk/tests/phpunit/tests/post/updatePostCache.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswppostphp"></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-post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-post.php 2022-03-31 17:11:36 UTC (rev 53041)
+++ trunk/src/wp-includes/class-wp-post.php 2022-04-01 03:16:33 UTC (rev 53042)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -247,7 +247,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $_post = sanitize_post( $_post, 'raw' );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_add( $_post->ID, $_post, 'posts' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } elseif ( empty( $_post->filter ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( empty( $_post->filter ) || 'raw' !== $_post->filter ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $_post = sanitize_post( $_post, 'raw' );
</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="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 2022-03-31 17:11:36 UTC (rev 53041)
+++ trunk/src/wp-includes/post.php 2022-04-01 03:16:33 UTC (rev 53042)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7374,6 +7374,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $data = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $posts as $post ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $post->filter ) || 'raw' !== $post->filter ) {
+ $post = sanitize_post( $post, 'raw' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> $data[ $post->ID ] = $post;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_add_multiple( $data, 'posts' );
</span></span></pre></div>
<a id="trunktestsphpunittestspostupdatePostCachephp"></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/updatePostCache.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/updatePostCache.php (rev 0)
+++ trunk/tests/phpunit/tests/post/updatePostCache.php 2022-04-01 03:16:33 UTC (rev 53042)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,141 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Test `wp_update_cache()`.
+ *
+ * @package WordPress
+ */
+
+/**
+ * Test class for `wp_update_cache()`.
+ *
+ * @group post
+ * @group query
+ *
+ * @covers ::update_post_cache
+ */
+class Tests_Post_UpdatePostCache extends WP_UnitTestCase {
+
+ /**
+ * Post IDs from the shared fixture.
+ *
+ * @var array
+ */
+ public static $post_ids;
+
+ /**
+ * Set up test resources before the class.
+ *
+ * @param WP_UnitTest_Factory $factory The unit test factory.
+ */
+ public static function wpSetupBeforeClass( WP_UnitTest_Factory $factory ) {
+ self::$post_ids = $factory->post->create_many( 1 );
+ }
+
+ /**
+ * Ensure that `update_post_cache()` returns `null` when
+ * `$posts` is empty.
+ *
+ * @ticket 50567
+ */
+ public function test_should_return_null_with_an_empty_array() {
+ $posts = array();
+ $this->assertNull( update_post_cache( $posts ) );
+ }
+
+ /**
+ * Ensure filter = raw is always set via Query.
+ *
+ * @ticket 50567
+ */
+ public function test_query_caches_post_filter() {
+ $post_id = self::$post_ids[0];
+ $this->go_to( '/' );
+
+ $cached_post = wp_cache_get( $post_id, 'posts' );
+ $this->assertIsObject(
+ $cached_post,
+ 'The cached post is not an object'
+ );
+
+ $this->assertObjectHasAttribute(
+ 'filter',
+ $cached_post,
+ 'The cached post does not have a "filter" property'
+ );
+
+ $this->assertSame(
+ 'raw',
+ $cached_post->filter,
+ 'The filter is not set to "raw"'
+ );
+ }
+
+ /**
+ * Ensure filter = raw is always set via get_post.
+ *
+ * @ticket 50567
+ */
+ public function test_get_post_caches_post_filter() {
+ $post_id = self::$post_ids[0];
+ get_post( $post_id );
+
+ $cached_post = wp_cache_get( $post_id, 'posts' );
+ $this->assertSame( 'raw', $cached_post->filter );
+ }
+
+ /**
+ * Ensure filter = raw is always set via get_post called with a different filter setting.
+ *
+ * @ticket 50567
+ */
+ public function test_get_post_caches_post_filter_is_always_raw() {
+ $post_id = self::$post_ids[0];
+ get_post( $post_id, OBJECT, 'display' );
+
+ $cached_post = wp_cache_get( $post_id, 'posts' );
+ $this->assertIsObject(
+ $cached_post,
+ 'The cached post is not an object'
+ );
+
+ $this->assertObjectHasAttribute(
+ 'filter',
+ $cached_post,
+ 'The cached post does not have a "filter" property'
+ );
+
+ $this->assertSame(
+ 'raw',
+ $cached_post->filter,
+ 'The filter is not set to "raw"'
+ );
+ }
+
+ /**
+ * Ensure filter = raw is always set via get_posts.
+ *
+ * @ticket 50567
+ */
+ public function test_get_posts_caches_post_filter_is_always_raw() {
+ $post_id = self::$post_ids[0];
+ get_posts( array( 'includes' => $post_id ) );
+
+ $cached_post = wp_cache_get( $post_id, 'posts' );
+ $this->assertIsObject(
+ $cached_post,
+ 'The cached post is not an object'
+ );
+
+ $this->assertObjectHasAttribute(
+ 'filter',
+ $cached_post,
+ 'The cached post does not have a "filter" property'
+ );
+
+ $this->assertSame(
+ 'raw',
+ $cached_post->filter,
+ 'The filter is not set to "raw"'
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/post/updatePostCache.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>