Changeset 65281

Timestamp:

11/05/2026 05:27:20 PM (37 hours ago)

Author:

westonruter

Message:

Code Quality: Fix the nullCoalesce.property PHPStan error.

Since WP_Query::$max_num_pages is never null, the ?? 1 fallback in paginate_links() never applied, so the property is now read directly.

The property is also documented as a non-negative integer. This exposed that WP_Query::set_found_posts() could compute a negative page count when a found_posts filter returns a negative number, or when a filter injects a LIMIT into a query with a posts_per_page of -1, so that result is now clamped to zero. For the same reason the unreachable isset() fallback in WP_Sitemaps_Posts::get_max_num_pages() is removed, retiring its baseline entry.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/15475.
Follow-up to r48476, r57648, r61454, r65192.

Props bgturner, westonruter.
See #65817.

Location:

trunk

Files:

• phpstan.neon.dist (modified) (1 diff)
• src/wp-includes/class-wp-query.php (modified) (2 diffs)
• src/wp-includes/general-template.php (modified) (1 diff)
• src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php (modified) (1 diff)
• tests/phpstan/baselines/isset.property.neon (modified) (1 diff)
• tests/phpstan/baselines/nullCoalesce.property.neon (deleted)
• tests/phpunit/tests/query/noFoundRows.php (modified) (1 diff)

trunk/phpstan.neon.dist

@@ -45 +45 @@
         - tests/phpstan/baselines/method.unused.neon
         - tests/phpstan/baselines/notIdentical.alwaysTrue.neon
-        - tests/phpstan/baselines/nullCoalesce.property.neon
         - tests/phpstan/baselines/offsetAccess.nonOffsetAccessible.neon
         - tests/phpstan/baselines/offsetAccess.notFound.neon

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

@@ -187 +187 @@
          * @since 2.1.0
          * @var int
+         * @phpstan-var int<0, max>
          */
         public $max_num_pages = 0;
@@ -3733 +3734 @@
 
                 if ( ! empty( $limits ) ) {
-                        $this->max_num_pages = (int) ceil( $this->found_posts / $query_vars['posts_per_page'] );
+                        $this->max_num_pages = max( 0, (int) ceil( $this->found_posts / (int) $query_vars['posts_per_page'] ) );
                 }
         }

trunk/src/wp-includes/general-template.php

@@ -4984 +4984 @@
 
         // Get max pages and current page out of the current query, if available.
-        $total   = $wp_query->max_num_pages ?? 1;
+        $total   = $wp_query->max_num_pages;
         $current = get_query_var( 'paged' ) ? (int) get_query_var( 'paged' ) : 1;
 

trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php

@@ -210 +210 @@
 
                 $min_num_pages = ( 'page' === $post_type && 'posts' === get_option( 'show_on_front' ) ) ? 1 : 0;
-                return isset( $query->max_num_pages ) ? max( $min_num_pages, $query->max_num_pages ) : 1;
+                return max( $min_num_pages, $query->max_num_pages );
         }
 

trunk/tests/phpstan/baselines/isset.property.neon

@@ -180 +180 @@
                         path: ../../../src/wp-includes/rest-api/endpoints/class-wp-rest-font-families-controller.php
                 -
-                        message: '#^Property WP_Query\:\:\$max_num_pages \(int\) in isset\(\) is not nullable\.$#'
-                        identifier: isset.property
-                        count: 1
-                        path: ../../../src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php
-                -
                         message: '#^Property WP_Site\:\:\$domain \(string\) in isset\(\) is not nullable\.$#'
                         identifier: isset.property

trunk/tests/phpunit/tests/query/noFoundRows.php

@@ -103 +103 @@
                 $this->assertSame( 1, $q->found_posts );
         }
+
+        /**
+         * Ensures {@see WP_Query::$max_num_pages} is not negative when the
+         * {@see 'found_posts'} filter returns a negative count.
+         *
+         * @ticket 65817
+         */
+        public function test_max_num_pages_is_not_negative_when_found_posts_is_filtered_negative() {
+                self::factory()->post->create_many( 3 );
+
+                add_filter(
+                        'found_posts',
+                        static function (): int {
+                                return -5;
+                        }
+                );
+
+                $q = new WP_Query(
+                        array(
+                                'post_type'      => 'post',
+                                'posts_per_page' => 2,
+                        )
+                );
+
+                $this->assertSame( -5, $q->found_posts, 'Expected the filtered found_posts value to be kept.' );
+                $this->assertSame( 0, $q->max_num_pages, 'Expected max_num_pages to be clamped to zero.' );
+        }
+
+        /**
+         * Ensures {@see WP_Query::$max_num_pages} is not negative when a
+         * {@see 'post_limits'} filter injects a non-empty `LIMIT` clause on a
+         * `posts_per_page = -1` query, which otherwise never runs the found-rows
+         * calculation and skips the `max_num_pages` division entirely.
+         *
+         * @ticket 65817
+         */
+        public function test_max_num_pages_is_not_negative_when_limits_are_filtered_with_postsperpage_minus1() {
+                self::factory()->post->create_many( 3 );
+
+                add_filter(
+                        'post_limits',
+                        static function (): string {
+                                return 'LIMIT 0, 2';
+                        }
+                );
+
+                $q = new WP_Query(
+                        array(
+                                'post_type'      => 'post',
+                                'posts_per_page' => -1,
+                        )
+                );
+
+                $this->assertIsString( $q->request );
+                $this->assertStringContainsString( 'SQL_CALC_FOUND_ROWS', $q->request, 'Expected the filtered LIMIT to trigger the found-rows query.' );
+                $this->assertSame( 3, $q->found_posts, 'Expected found_posts to reflect all matching rows.' );
+                $this->assertSame( 0, $q->max_num_pages, 'Expected max_num_pages to be clamped to zero.' );
+        }
 }