Changeset 53379

Timestamp:

05/10/2022 04:07:10 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Query: Restore late compact() call for the posts_clauses_request filter.

This addresses a backward compatibility break where posts_join_request and other filters were applied, but their results were subsequently discarded and earlier values were used instead.

Follow-up to [52974], [53175].

Props 5um17, johnbillion, peterwilsoncc, hellofromTonya, SergeyBiryukov.
Merges [53370] and [53375] to the 6.0 branch.
Fixes #55699.

Location:

branches/6.0

Files:

• . (modified) (1 prop)
• src/wp-includes/class-wp-query.php (modified) (3 diffs)
• tests/phpunit/tests/query.php (modified) (1 diff)

branches/6.0/src/wp-includes/class-wp-query.php

@@ -2755 +2755 @@
         }
 
-        $clauses = array( 'where', 'groupby', 'join', 'orderby', 'distinct', 'fields', 'limits' );
+        $pieces = array( 'where', 'groupby', 'join', 'orderby', 'distinct', 'fields', 'limits' );
 
         /*
@@ -2857 +2857 @@
              * @param WP_Query $query   The WP_Query instance (passed by reference).
              */
-            $clauses = (array) apply_filters_ref_array( 'posts_clauses', array( compact( $clauses ), &$this ) );
+            $clauses = (array) apply_filters_ref_array( 'posts_clauses', array( compact( $pieces ), &$this ) );
 
             $where    = isset( $clauses['where'] ) ? $clauses['where'] : '';
@@ -2991 +2991 @@
              * @param WP_Query $query  The WP_Query instance (passed by reference).
              */
-            $clauses = (array) apply_filters_ref_array( 'posts_clauses_request', array( $clauses, &$this ) );
+            $clauses = (array) apply_filters_ref_array( 'posts_clauses_request', array( compact( $pieces ), &$this ) );
 
             $where    = isset( $clauses['where'] ) ? $clauses['where'] : '';

branches/6.0/tests/phpunit/tests/query.php

@@ -720 +720 @@
         $this->assertSame( get_queried_object_id(), $user_id );
     }
+
+    /**
+     * Tests that the `posts_clauses` filter receives an array of clauses
+     * with the other `posts_*` filters applied, e.g. `posts_join_paged`.
+     *
+     * @ticket 55699
+     * @covers WP_Query::get_posts
+     */
+    public function test_posts_clauses_filter_should_receive_filtered_clauses() {
+        add_filter(
+            'posts_join_paged',
+            static function() {
+                return '/* posts_join_paged */';
+            }
+        );
+
+        $filter = new MockAction();
+        add_filter( 'posts_clauses', array( $filter, 'filter' ), 10, 2 );
+        $this->go_to( '/' );
+        $filter_args   = $filter->get_args();
+        $posts_clauses = $filter_args[0][0];
+
+        $this->assertArrayHasKey( 'join', $posts_clauses );
+        $this->assertSame( '/* posts_join_paged */', $posts_clauses['join'] );
+    }
+
+    /**
+     * Tests that the `posts_clauses_request` filter receives an array of clauses
+     * with the other `posts_*_request` filters applied, e.g. `posts_join_request`.
+     *
+     * @ticket 55699
+     * @covers WP_Query::get_posts
+     */
+    public function test_posts_clauses_request_filter_should_receive_filtered_clauses() {
+        add_filter(
+            'posts_join_request',
+            static function() {
+                return '/* posts_join_request */';
+            }
+        );
+
+        $filter = new MockAction();
+        add_filter( 'posts_clauses_request', array( $filter, 'filter' ), 10, 2 );
+        $this->go_to( '/' );
+        $filter_args           = $filter->get_args();
+        $posts_clauses_request = $filter_args[0][0];
+
+        $this->assertArrayHasKey( 'join', $posts_clauses_request );
+        $this->assertSame( '/* posts_join_request */', $posts_clauses_request['join'] );
+    }
 }