Skip to content

Backport build_query_vars_from_query_block changes #3223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ntsekouras wants to merge 1 commit into from
Closed

Backport build_query_vars_from_query_block changes #3223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion src/wp-includes/blocks.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1094,6 +1094,7 @@ function wp_migrate_old_typography_shape( $metadata ) {
* It's used in Query Loop, Query Pagination Numbers and Query Pagination Next blocks.
*
* @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.
* @param int $page Current query's page.
Expand Down Expand Up @@ -1194,8 +1195,32 @@ function build_query_vars_from_query_block( $block, $page ) {
if ( ! empty( $block->context['query']['search'] ) ) {
$query['s'] = $block->context['query']['search'];
}
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'] ) );
}
}
return $query;

/**
* 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 );
}

/**
Expand Down
48 changes: 43 additions & 5 deletions tests/phpunit/tests/blocks/wpBlock.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,7 @@ public function test_build_query_vars_from_query_block() {
'categoryIds' => array( 56 ),
'orderBy' => 'title',
'tagIds' => array( 3, 11, 10 ),
'parents' => array( 1, 2 ),
),
);
$block = new WP_Block( $parsed_block, $context, $this->registry );
Expand All @@ -445,11 +446,11 @@ public function test_build_query_vars_from_query_block() {
$this->assertSame(
$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',
'terms' => array( 56 ),
Expand All @@ -461,6 +462,7 @@ public function test_build_query_vars_from_query_block() {
'include_children' => false,
),
),
'post_parent__in' => array( 1, 2 ),
)
);
}
Expand Down Expand Up @@ -584,6 +586,42 @@ public function test_build_query_vars_from_query_block_page_with_offset() {
);
}

/**
* @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(),
)
);
}

/**
* @ticket 52991
*/
Expand Down