vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-28 14:20:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Query: Use WP_Query in get_page_by_path.

Browse Source 
Replace raw database queries in `get_page_by_path` with a call to `WP_Query` class. This has a number of benefits, including improved caching and priming of post caches. To maintain backwards compatibility, this function calls `WP_Query` to gets all matching posts of all post statuses.  

Props spacedmonkey, peterwilsoncc, costdev, 
Fixes #56689.

git-svn-id: https://develop.svn.wordpress.org/trunk@55169 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Jonny Harris
2023-01-31 16:54:22 +00:00
parent 620760e1c1
commit 4ca85e7528
2 changed files with 118 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
src/wp-includes/post.php
View File

@@ -5660,8 +5660,6 @@ function get_page( $page, $output = OBJECT, $filter = 'raw' ) {
*
* @since 2.1.0
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $page_path Page path.
* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which
* correspond to a WP_Post object, an associative array, or a numeric array,
@@ -5670,30 +5668,11 @@ function get_page( $page, $output = OBJECT, $filter = 'raw' ) {
* @return WP_Post|array|null WP_Post (or array) on success, or null on failure.
*/
function get_page_by_path( $page_path, $output = OBJECT, $post_type = 'page' ) {
global $wpdb;
$last_changed = wp_cache_get_last_changed( 'posts' );
$hash = md5( $page_path . serialize( $post_type ) );
$cache_key = "get_page_by_path:$hash:$last_changed";
$cached = wp_cache_get( $cache_key, 'posts' );
if ( false !== $cached ) {
// Special case: '0' is a bad `$page_path`.
if ( '0' === $cached || 0 === $cached ) {
return;
} else {
return get_post( $cached, $output );
}
}
$page_path = rawurlencode( urldecode( $page_path ) );
$page_path = str_replace( '%2F', '/', $page_path );
$page_path = str_replace( '%20', ' ', $page_path );
$parts = explode( '/', trim( $page_path, '/' ) );
$parts = array_map( 'sanitize_title_for_query', $parts );
$escaped_parts = esc_sql( $parts );
$in_string = "'" . implode( "','", $escaped_parts ) . "'";
$page_path = rawurlencode( urldecode( $page_path ) );
$page_path = str_replace( '%2F', '/', $page_path );
$page_path = str_replace( '%20', ' ', $page_path );
$parts = explode( '/', trim( $page_path, '/' ) );
$parts = array_map( 'sanitize_title_for_query', $parts );
if ( is_array( $post_type ) ) {
$post_types = $post_type;
@@ -5701,21 +5680,29 @@ function get_page_by_path( $page_path, $output = OBJECT, $post_type = 'page' ) {
$post_types = array( $post_type, 'attachment' );
}
$post_types = esc_sql( $post_types );
$post_type_in_string = "'" . implode( "','", $post_types ) . "'";
$sql = "
SELECT ID, post_name, post_parent, post_type
FROM $wpdb->posts
WHERE post_name IN ($in_string)
AND post_type IN ($post_type_in_string)
";
$args = array(
'post_name__in' => $parts,
'post_type' => $post_types,
'post_status' => 'all',
'posts_per_page' => -1,
'update_post_term_cache' => false,
'update_post_meta_cache' => false,
'no_found_rows' => true,
'orderby' => 'none',
);
$pages = $wpdb->get_results( $sql, OBJECT_K );
$query = new WP_Query( $args );
$posts = $query->get_posts();
$pages = array();
foreach ( $posts as $post ) {
$pages[ $post->ID ] = $post;
}
$revparts = array_reverse( $parts );
$foundid = 0;
foreach ( (array) $pages as $page ) {
foreach ( $pages as $page ) {
if ( $page->post_name == $revparts[0] ) {
$count = 0;
$p = $page;
@@ -5742,9 +5729,6 @@ function get_page_by_path( $page_path, $output = OBJECT, $post_type = 'page' ) {
}
}
// We cache misses as well as hits.
wp_cache_set( $cache_key, $foundid, 'posts' );
if ( $foundid ) {
return get_post( $foundid, $output );
}

95
tests/phpunit/tests/post/getPageByPath.php
View File

@@ -103,6 +103,101 @@ class Tests_Post_GetPageByPath extends WP_UnitTestCase {
$this->assertSame( $p3, $found->ID );
}
/**
* @ticket 56689
*
* @covers ::get_page_by_path
*/
public function test_should_match_nested_page_query_count() {
$p1 = self::factory()->post->create(
array(
'post_type' => 'page',
'post_name' => 'foo',
)
);
$p2 = self::factory()->post->create(
array(
'post_type' => 'page',
'post_name' => 'bar',
'post_parent' => $p1,
)
);
$p3 = self::factory()->post->create(
array(
'post_type' => 'page',
'post_name' => 'baz',
'post_parent' => $p2,
)
);
$queries_before = get_num_queries();
$found = get_page_by_path( 'foo/bar/baz' );
$queries_after = get_num_queries();
$cached_post = wp_cache_get( $p1, 'posts' );
$this->assertSame( 1, $queries_after - $queries_before, 'Only one query should run' );
$this->assertSame( $p3, $found->ID, 'Check to see if the result is correct' );
$this->assertIsObject( $cached_post, 'The cached post is not an object' );
}
/**
* @ticket 56689
*
* @covers ::get_page_by_path
*/
public function test_should_match_nested_page_query_count_status() {
$p1 = self::factory()->post->create(
array(
'post_type' => 'page',
'post_name' => 'foo',
'post_status' => 'draft',
)
);
$p2 = self::factory()->post->create(
array(
'post_type' => 'page',
'post_name' => 'bar',
'post_parent' => $p1,
)
);
$p3 = self::factory()->post->create(
array(
'post_type' => 'page',
'post_name' => 'baz',
'post_parent' => $p2,
)
);
$queries_before = get_num_queries();
$found = get_page_by_path( 'foo/bar/baz' );
$queries_after = get_num_queries();
$cached_post = wp_cache_get( $p1, 'posts' );
$this->assertSame( 1, $queries_after - $queries_before, 'Only one query should run' );
$this->assertSame( $p3, $found->ID, 'Check to see if the result is correct' );
$this->assertIsObject( $cached_post, 'The cached post is not an object' );
}
/**
* @ticket 56689
*
* @covers ::get_page_by_path
*/
public function test_should_return_null_for_invalid_path() {
$queries_before = get_num_queries();
$get_1 = get_page_by_path( 'should/return/null/for/an/invalid/path' );
$get_2 = get_page_by_path( 'should/return/null/for/an/invalid/path' );
$queries_after = get_num_queries();
$this->assertNull( $get_1, 'Invalid path should return null.' );
$this->assertSame( 1, $queries_after - $queries_before, 'Only one query should run.' );
$this->assertSame( $get_1, $get_2, 'The cached result should be the same as the uncached result.' );
}
public function test_should_not_make_partial_match() {
$p1 = self::factory()->post->create(
array(