Changeset 54175

Timestamp:

09/15/2022 11:39:43 AM (2 years ago)

Author:

audrasjb

Message:

Editor: Backport build_query_vars_from_query_block changes from Gutenberg repository.

This changeset backports changes from the following Gutenberg pull requests:

• ​gutenberg#43590 Add a filter to build_query_vars_from_query_block
• ​gutenberg#40933 Block Library - Query Loop: Add parents filter

Props ntsekouras, bernhard-reiter.
See #56467.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (2 diffs)
• tests/phpunit/tests/blocks/wpBlock.php (modified) (4 diffs)

trunk/src/wp-includes/blocks.php

@@ -1190 +1190 @@
  *
  * @since 5.8.0
+ * @since 6.1.0 Added `query_loop_block_query_vars` filter and `parents` support in query.
  *
  * @param WP_Block $block Block instance.
@@ -1290 +1291 @@
             $query['s'] = $block->context['query']['search'];
         }
-    }
-    return $query;
+        if ( ! empty( $block->context['query']['parents'] ) && is_post_type_hierarchical( $query['post_type'] ) ) {
+            $query['post_parent__in'] = array_filter( array_map( 'intval', $block->context['query']['parents'] ) );
+        }
+    }
+
+    /**
+     * Filters the arguments which will be passed to `WP_Query` for the Query Loop Block.
+     *
+     * Anything to this filter should be compatible with the `WP_Query` API to form
+     * the query context which will be passed down to the Query Loop Block's children.
+     * This can help, for example, to include additional settings or meta queries not
+     * directly supported by the core Query Loop Block, and extend its capabilities.
+     *
+     * Please note that this will only influence the query that will be rendered on the
+     * front-end. The editor preview is not affected by this filter. Also, worth noting
+     * that the editor preview uses the REST API, so, ideally, one should aim to provide
+     * attributes which are also compatible with the REST API, in order to be able to
+     * implement identical queries on both sides.
+     *
+     * @since 6.1.0
+     *
+     * @param array    $query Array containing parameters for `WP_Query` as parsed by the block context.
+     * @param WP_Block $block Block instance.
+     * @param int      $page  Current query's page.
+     */
+    return apply_filters( 'query_loop_block_query_vars', $query, $block, $page );
 }
 

trunk/tests/phpunit/tests/blocks/wpBlock.php

@@ -438 +438 @@
                 'orderBy'     => 'title',
                 'tagIds'      => array( 3, 11, 10 ),
+                'parents'     => array( 1, 2 ),
             ),
         );
@@ -446 +447 @@
             $query,
             array(
-                'post_type'    => 'page',
-                'order'        => 'DESC',
-                'orderby'      => 'title',
-                'post__not_in' => array( 1, 2 ),
-                'tax_query'    => array(
+                'post_type'       => 'page',
+                'order'           => 'DESC',
+                'orderby'         => 'title',
+                'post__not_in'    => array( 1, 2 ),
+                'tax_query'       => array(
                     array(
                         'taxonomy'         => 'category',
@@ -462 +463 @@
                     ),
                 ),
+                'post_parent__in' => array( 1, 2 ),
             )
         );
@@ -581 +583 @@
                 'offset'         => 12,
                 'posts_per_page' => 5,
+            )
+        );
+    }
+
+    /**
+     * @ticket 56467
+     */
+    public function test_query_loop_block_query_vars_filter() {
+        $this->registry->register(
+            'core/example',
+            array( 'uses_context' => array( 'query' ) )
+        );
+
+        $parsed_blocks = parse_blocks( '<!-- wp:example {"ok":true} -->a<!-- wp:example /-->b<!-- /wp:example -->' );
+        $parsed_block  = $parsed_blocks[0];
+        $context       = array(
+            'query' => array(
+                'postType' => 'page',
+                'orderBy'  => 'title',
+            ),
+        );
+        $block         = new WP_Block( $parsed_block, $context, $this->registry );
+        function filterQuery( $query, $block, $page ) {
+            $query['post_type'] = 'book';
+            return $query;
+        }
+        add_filter( 'query_loop_block_query_vars', 'filterQuery', 10, 3 );
+        $query = build_query_vars_from_query_block( $block, 1 );
+        remove_filter( 'query_loop_block_query_vars', 'filterQuery' );
+        $this->assertSame(
+            $query,
+            array(
+                'post_type'    => 'book',
+                'order'        => 'DESC',
+                'orderby'      => 'title',
+                'post__not_in' => array(),
             )
         );