Changeset 51027

Timestamp:

05/26/2021 02:16:01 AM (5 years ago)

Author:

peterwilsoncc

Message:

Posts, Post Types: Improve post_exists() query.

Add $status parameter to post_exists() to allow developers to specify a post type, date and status to ensure they hit the wp_posts table's type_status_date index when determining if a post exists.

Props apokalyptik, boonebgorges, brettshumaker, DrewAPicture, MikeHansenMe, peterwilsoncc, whyisjake.
Fixes #34012.

Location:

trunk

Files:

• src/wp-admin/includes/post.php (modified) (4 diffs)
• tests/phpunit/tests/admin/includesPost.php (modified) (1 diff)

trunk/src/wp-admin/includes/post.php

@@ -764 +764 @@
  * @since 2.0.0
  * @since 5.2.0 Added the `$type` parameter.
+ * @since 5.8.0 Added the `$status` parameter.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
@@ -771 +772 @@
  * @param string $date    Optional post date.
  * @param string $type    Optional post type.
+ * @param string $status  Optional post status.
  * @return int Post ID if post exists, 0 otherwise.
  */
-function post_exists( $title, $content = '', $date = '', $type = '' ) {
+function post_exists( $title, $content = '', $date = '', $type = '', $status = '' ) {
         global $wpdb;
 
@@ -780 +782 @@
         $post_date    = wp_unslash( sanitize_post_field( 'post_date', $date, 0, 'db' ) );
         $post_type    = wp_unslash( sanitize_post_field( 'post_type', $type, 0, 'db' ) );
+        $post_status  = wp_unslash( sanitize_post_field( 'post_status', $status, 0, 'db' ) );
 
         $query = "SELECT ID FROM $wpdb->posts WHERE 1=1";
@@ -802 +805 @@
                 $query .= ' AND post_type = %s';
                 $args[] = $post_type;
+        }
+
+        if ( ! empty( $status ) ) {
+                $query .= ' AND post_status = %s';
+                $args[] = $post_status;
         }
 

trunk/tests/phpunit/tests/admin/includesPost.php

@@ -904 +904 @@
                 $this->assertSame( 0, post_exists( $title, null, null, 'post' ) );
         }
+
+        /**
+         * Test the status support in post_exists()
+         *
+         * @ticket 34012
+         */
+        public function test_post_exists_should_support_post_status() {
+                $title       = 'Foo Bar';
+                $post_type   = 'post';
+                $post_status = 'publish';
+                $post_id     = self::factory()->post->create(
+                        array(
+                                'post_title'  => $title,
+                                'post_type'   => $post_type,
+                                'post_status' => $post_status,
+                        )
+                );
+                $this->assertSame( $post_id, post_exists( $title, null, null, null, $post_status ) );
+        }
+
+
+        /**
+         * Test the type and status query in post_exists()
+         *
+         * @ticket 34012
+         */
+        public function test_post_exists_should_support_post_type_status_combined() {
+                $title       = 'Foo Bar';
+                $post_type   = 'post';
+                $post_status = 'publish';
+                $post_id     = self::factory()->post->create(
+                        array(
+                                'post_title'  => $title,
+                                'post_type'   => $post_type,
+                                'post_status' => $post_status,
+                        )
+                );
+                $this->assertSame( $post_id, post_exists( $title, null, null, $post_type, $post_status ) );
+        }
+
+        /**
+         * Test that post_exists() doesn't find an existing draft post when looking for publish
+         *
+         * @ticket 34012
+         */
+        public function test_post_exists_should_only_match_correct_post_status() {
+                $title       = 'Foo Bar';
+                $post_type   = 'post';
+                $post_status = 'draft';
+                $post_id     = self::factory()->post->create(
+                        array(
+                                'post_title'  => $title,
+                                'post_type'   => $post_type,
+                                'post_status' => $post_status,
+                        )
+                );
+                $this->assertSame( 0, post_exists( $title, null, null, null, 'publish' ) );
+        }
+
+        /**
+         * Test the status support in post_exists()
+         *
+         * @ticket 34012
+         */
+        public function test_post_exists_should_not_match_invalid_post_type_and_status_combined() {
+                $title       = 'Foo Bar';
+                $post_type   = 'post';
+                $post_status = 'publish';
+                $post_id     = self::factory()->post->create(
+                        array(
+                                'post_title'  => $title,
+                                'post_type'   => $post_type,
+                                'post_status' => $post_status,
+                        )
+                );
+
+                $this->assertSame( 0, post_exists( $title, null, null, $post_type, 'draft' ) );
+                $this->assertSame( 0, post_exists( $title, null, null, 'wp_tests', $post_status ) );
+        }
 }