Changeset 48328

Timestamp:

07/05/2020 09:32:26 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Query: Make sure the found_posts property of WP_Query is always an integer, to match the documented type.

This makes the property consistent with similar properties of other classes:

• WP_Comment_Query::$found_comments
• WP_Network_Query::$found_networks
• WP_Site_Query::$found_sites
• WP_User_Query::$total_users

Props birgire, PressLabs.
Fixes #42469.

Location:

trunk

Files:

• src/wp-includes/class-wp-query.php (modified) (2 diffs)
• tests/phpunit/tests/post/query.php (modified) (5 diffs)

trunk/src/wp-includes/class-wp-query.php

@@ -3236 +3236 @@
                          * @since 2.1.0
                          *
-                         * @param string   $found_posts The query to run to find the found posts.
-                         * @param WP_Query $this        The WP_Query instance (passed by reference).
+                         * @param string   $found_posts_query The query to run to find the found posts.
+                         * @param WP_Query $this              The WP_Query instance (passed by reference).
                          */
-                        $this->found_posts = $wpdb->get_var( apply_filters_ref_array( 'found_posts_query', array( 'SELECT FOUND_ROWS()', &$this ) ) );
+                        $found_posts_query = apply_filters_ref_array( 'found_posts_query', array( 'SELECT FOUND_ROWS()', &$this ) );
+
+                        $this->found_posts = (int) $wpdb->get_var( $found_posts_query );
                 } else {
                         if ( is_array( $this->posts ) ) {
@@ -3260 +3262 @@
                  * @param WP_Query $this        The WP_Query instance (passed by reference).
                  */
-                $this->found_posts = apply_filters_ref_array( 'found_posts', array( $this->found_posts, &$this ) );
+                $this->found_posts = (int) apply_filters_ref_array( 'found_posts', array( $this->found_posts, &$this ) );
 
                 if ( ! empty( $limits ) ) {

trunk/tests/phpunit/tests/post/query.php

@@ -653 +653 @@
 
                 add_filter( 'split_the_query', '__return_true' );
+
                 $q = new WP_Query(
                         array(
@@ -659 +660 @@
                         )
                 );
+
                 remove_filter( 'split_the_query', '__return_true' );
 
@@ -678 +680 @@
                 // ! $split_the_query
                 add_filter( 'split_the_query', '__return_false' );
+
                 $q = new WP_Query(
                         array(
@@ -684 +687 @@
                         )
                 );
+
                 remove_filter( 'split_the_query', '__return_false' );
 
@@ -722 +726 @@
         }
 
+        /**
+         * @ticket 42469
+         */
+        public function test_found_posts_should_be_integer_not_string() {
+                $this->post_id = self::factory()->post->create();
+
+                $q = new WP_Query(
+                        array(
+                                'posts_per_page' => 1,
+                        )
+                );
+
+                $this->assertInternalType( 'int', $q->found_posts );
+        }
+
+        /**
+         * @ticket 42469
+         */
+        public function test_found_posts_should_be_integer_even_if_found_posts_filter_returns_string_value() {
+                $this->post_id = self::factory()->post->create();
+
+                add_filter( 'found_posts', '__return_empty_string' );
+
+                $q = new WP_Query(
+                        array(
+                                'posts_per_page' => 1,
+                        )
+                );
+
+                remove_filter( 'found_posts', '__return_empty_string' );
+
+                $this->assertInternalType( 'int', $q->found_posts );
+        }
 }