<!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>[54234] trunk: Posts, Post types: Cache `get_page_by_title()`.</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/54234">54234</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/54234","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-09-20 01:13:51 +0000 (Tue, 20 Sep 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: Cache `get_page_by_title()`.
Convert `get_page_by_title()` to a `WP_Query` wrapper to take advantage of the object caching built in to the latter.
Add dedicated unit tests for the function `get_page_by_title()`.
Props spacedmonkey, boonebgorges, igmoweb, pcfreak30, pbearne.
Fixes <a href="https://core.trac.wordpress.org/ticket/36905">#36905</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="#trunktestsphpunittestspostgetPageByTitlephp">trunk/tests/phpunit/tests/post/getPageByTitle.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 2022-09-20 01:00:24 UTC (rev 54233)
+++ trunk/src/wp-includes/post.php 2022-09-20 01:13:51 UTC (rev 54234)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5756,8 +5756,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0 The `$post_type` parameter was added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global wpdb $wpdb WordPress database abstraction object.
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @param string $page_title Page title.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which
</span><span class="cx" style="display: block; padding: 0 10px"> * correspond to a WP_Post object, an associative array, or a numeric array,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5766,40 +5764,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_Post|array|null WP_Post (or array) on success, or null on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_page_by_title( $page_title, $output = OBJECT, $post_type = 'page' ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $wpdb;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = array(
+ 'post_title' => $page_title,
+ 'post_type' => $post_type,
+ 'post_status' => get_post_stati(),
+ 'posts_per_page' => 1,
+ 'update_post_term_cache' => false,
+ 'update_post_meta_cache' => false,
+ 'no_found_rows' => true,
+ 'orderby' => 'ID',
+ 'order' => 'ASC',
+ );
+ $query = new WP_Query( $args );
+ $pages = $query->get_posts();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_array( $post_type ) ) {
- $post_type = esc_sql( $post_type );
- $post_type_in_string = "'" . implode( "','", $post_type ) . "'";
- $sql = $wpdb->prepare(
- "
- SELECT ID
- FROM $wpdb->posts
- WHERE post_title = %s
- AND post_type IN ($post_type_in_string)
- ",
- $page_title
- );
- } else {
- $sql = $wpdb->prepare(
- "
- SELECT ID
- FROM $wpdb->posts
- WHERE post_title = %s
- AND post_type = %s
- ",
- $page_title,
- $post_type
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $pages ) ) {
+ return null;
</ins><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">- $page = $wpdb->get_var( $sql );
-
- if ( $page ) {
- return get_post( $page, $output );
- }
-
- return null;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return get_post( $pages[0], $output );
</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="trunktestsphpunittestspostgetPageByTitlephp"></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/getPageByTitle.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/getPageByTitle.php (rev 0)
+++ trunk/tests/phpunit/tests/post/getPageByTitle.php 2022-09-20 01:13:51 UTC (rev 54234)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,236 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group post
+ * @covers ::get_page_by_title
+ */
+class Tests_Post_GetPageByTitle extends WP_UnitTestCase {
+ /**
+ * @ticket 36905
+ */
+ public function test_get_page_by_title_priority() {
+ $attachment = self::factory()->post->create_and_get(
+ array(
+ 'post_title' => 'some-other-page',
+ 'post_type' => 'attachment',
+ )
+ );
+ $page = self::factory()->post->create_and_get(
+ array(
+ 'post_title' => 'some-page',
+ 'post_type' => 'page',
+ )
+ );
+
+ $this->assertEquals( $page, get_page_by_title( 'some-page' ), 'should return a post of the requested type before returning an attachment.' );
+
+ $this->assertEquals( $attachment, get_page_by_title( 'some-other-page', OBJECT, 'attachment' ), "will still select an attachment when a post of the requested type doesn't exist." );
+ }
+
+ /**
+ * @ticket 36905
+ */
+ public function test_should_match_top_level_page() {
+ $page = self::factory()->post->create(
+ array(
+ 'post_type' => 'page',
+ 'post_title' => 'foo',
+ )
+ );
+
+ $found = get_page_by_title( 'foo' );
+
+ $this->assertSame( $page, $found->ID );
+ }
+
+ /**
+ * @ticket 36905
+ */
+ public function test_inherit() {
+ $page = self::factory()->post->create(
+ array(
+ 'post_type' => 'page',
+ 'post_title' => 'foo',
+ 'post_status' => 'inherit',
+ )
+ );
+
+ $found = get_page_by_title( 'foo' );
+
+ $this->assertSame( $page, $found->ID );
+ }
+
+ /**
+ * @ticket 36905
+ */
+ public function test_should_obey_post_type() {
+ register_post_type( 'wptests_pt' );
+
+ $page = self::factory()->post->create(
+ array(
+ 'post_type' => 'wptests_pt',
+ 'post_title' => 'foo',
+ )
+ );
+
+ $found = get_page_by_title( 'foo' );
+ $this->assertNull( $found, 'Should return null, as post type does not match' );
+
+ $found = get_page_by_title( 'foo', OBJECT, 'wptests_pt' );
+ $this->assertSame( $page, $found->ID, 'Should return find post, as post type does do match' );
+ }
+
+
+ /**
+ * @ticket 36905
+ */
+ public function test_should_hit_cache() {
+ $page = self::factory()->post->create(
+ array(
+ 'post_type' => 'page',
+ 'post_title' => 'foo',
+ )
+ );
+
+ // Prime cache.
+ $found = get_page_by_title( 'foo' );
+ $this->assertSame( $page, $found->ID, 'Should return find page.' );
+
+ $num_queries = get_num_queries();
+
+ $found = get_page_by_title( 'foo' );
+ $this->assertSame( $page, $found->ID, 'Should return find page on second run.' );
+ $this->assertSame( $num_queries, get_num_queries(), 'Should not result in another database query.' );
+ }
+
+ /**
+ * @ticket 36905
+ */
+ public function test_bad_title_should_be_cached() {
+ // Prime cache.
+ $found = get_page_by_title( 'foo' );
+ $this->assertNull( $found, 'Should return not find a page.' );
+
+ $num_queries = get_num_queries();
+
+ $found = get_page_by_title( 'foo' );
+ $this->assertNull( $found, 'Should return not find a page on second run.' );
+ $this->assertSame( $num_queries, get_num_queries(), 'Should not result in another database query.' );
+ }
+
+ /**
+ * @ticket 36905
+ */
+ public function test_bad_title_served_from_cache_should_not_fall_back_on_current_post() {
+ global $post;
+
+ // Fake the global.
+ $post = self::factory()->post->create_and_get();
+
+ // Prime cache.
+ $found = get_page_by_title( 'foo' );
+ $this->assertNull( $found, 'Should return not find a page.' );
+
+ $num_queries = get_num_queries();
+
+ $found = get_page_by_title( 'foo' );
+ $this->assertNull( $found, 'Should return not find a page on second run.' );
+ $this->assertSame( $num_queries, get_num_queries(), 'Should not result in another database query.' );
+ }
+
+ /**
+ * @ticket 36905
+ */
+ public function test_cache_should_not_match_post_in_different_post_type_with_same_title() {
+ register_post_type( 'wptests_pt' );
+
+ $p1 = self::factory()->post->create(
+ array(
+ 'post_type' => 'page',
+ 'post_title' => 'foo',
+ )
+ );
+
+ $p2 = self::factory()->post->create(
+ array(
+ 'post_type' => 'wptests_pt',
+ 'post_title' => 'foo',
+ )
+ );
+
+ // Prime cache for the page.
+ $found = get_page_by_title( 'foo' );
+ $this->assertSame( $p1, $found->ID, 'Should find a page.' );
+
+ $num_queries = get_num_queries();
+
+ $found = get_page_by_title( 'foo', OBJECT, 'wptests_pt' );
+ $this->assertSame( $p2, $found->ID, 'Should find a post with post type wptests_pt.' );
+ $num_queries ++;
+ $this->assertSame( $num_queries, get_num_queries(), 'Should result in another database query.' );
+ }
+
+ /**
+ * @ticket 36905
+ */
+ public function test_cache_should_be_invalidated_when_post_title_is_edited() {
+ $page = self::factory()->post->create(
+ array(
+ 'post_type' => 'page',
+ 'post_title' => 'foo',
+ )
+ );
+
+ // Prime cache.
+ $found = get_page_by_title( 'foo' );
+ $this->assertSame( $page, $found->ID, 'Should find a page.' );
+
+ wp_update_post(
+ array(
+ 'ID' => $page,
+ 'post_title' => 'bar',
+ )
+ );
+
+ $num_queries = get_num_queries();
+
+ $found = get_page_by_title( 'bar' );
+ $this->assertSame( $page, $found->ID, 'Should find a page with the new title.' );
+ $num_queries++;
+ $this->assertSame( $num_queries, get_num_queries(), 'Should result in another database query.' );
+ }
+
+ /**
+ * @ticket 36905
+ */
+ public function test_output_param_should_be_obeyed_for_cached_value() {
+ $page = self::factory()->post->create(
+ array(
+ 'post_type' => 'page',
+ 'post_title' => 'foo',
+ )
+ );
+
+ // Prime cache.
+ $found = get_page_by_title( 'foo' );
+
+ $num_queries = get_num_queries();
+ $this->assertSame( $page, $found->ID, 'Should find a page.' );
+
+ $object = get_page_by_title( 'foo', OBJECT );
+ $this->assertIsObject( $object, 'Should be an object.' );
+ $this->assertSame( $page, $object->ID, 'Should match post id.' );
+ $this->assertSame( $num_queries, get_num_queries(), 'Should not result in another database query.' );
+
+ $array_n = get_page_by_title( 'foo', ARRAY_N );
+ $num_queries++; // Add one database query for loading of post metadata.
+ $this->assertIsArray( $array_n, 'Should be numbric array.' );
+ $this->assertSame( $page, $array_n[0], 'Should match post id.' );
+ $this->assertSame( $num_queries, get_num_queries(), 'Should not result in another database query.' );
+
+ $array_a = get_page_by_title( 'foo', ARRAY_A );
+ $this->assertIsArray( $array_a, 'Should be associative array.' );
+ $this->assertSame( $page, $array_a['ID'], 'Should match post id.' );
+ $this->assertSame( $num_queries, get_num_queries(), 'Should not result in another database query.' );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/post/getPageByTitle.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>