<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[54175] trunk: Editor: Backport `build_query_vars_from_query_block` changes from Gutenberg repository.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/54175">54175</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/54175","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-09-15 11:39:43 +0000 (Thu, 15 Sep 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Editor: Backport `build_query_vars_from_query_block` changes from Gutenberg repository.
This changeset backports changes from the following Gutenberg pull requests:
- [https://github.com/WordPress/gutenberg/pull/43590 gutenberg<a href="https://core.trac.wordpress.org/ticket/43590">#43590</a>] Add a filter to `build_query_vars_from_query_block`
- [https://github.com/WordPress/gutenberg/pull/40933 gutenberg<a href="https://core.trac.wordpress.org/ticket/40933">#40933</a>] Block Library - Query Loop: Add parents filter
Props ntsekouras, bernhard-reiter.
See <a href="https://core.trac.wordpress.org/ticket/56467">#56467</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocksphp">trunk/src/wp-includes/blocks.php</a></li>
<li><a href="#trunktestsphpunittestsblockswpBlockphp">trunk/tests/phpunit/tests/blocks/wpBlock.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblocksphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/blocks.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/blocks.php 2022-09-15 10:53:18 UTC (rev 54174)
+++ trunk/src/wp-includes/blocks.php 2022-09-15 11:39:43 UTC (rev 54175)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1189,6 +1189,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * It's used in Query Loop, Query Pagination Numbers and Query Pagination Next blocks.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.1.0 Added `query_loop_block_query_vars` filter and `parents` support in query.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Block $block Block instance.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $page Current query's page.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1289,8 +1290,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $block->context['query']['search'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $query['s'] = $block->context['query']['search'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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'] ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $query;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * 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 );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestsblockswpBlockphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/blocks/wpBlock.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/wpBlock.php 2022-09-15 10:53:18 UTC (rev 54174)
+++ trunk/tests/phpunit/tests/blocks/wpBlock.php 2022-09-15 11:39:43 UTC (rev 54175)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -437,6 +437,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'categoryIds' => array( 56 ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'orderBy' => 'title',
</span><span class="cx" style="display: block; padding: 0 10px"> 'tagIds' => array( 3, 11, 10 ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'parents' => array( 1, 2 ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> $block = new WP_Block( $parsed_block, $context, $this->registry );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -445,11 +446,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame(
</span><span class="cx" style="display: block; padding: 0 10px"> $query,
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'post_type' => 'page',
- 'order' => 'DESC',
- 'orderby' => 'title',
- 'post__not_in' => array( 1, 2 ),
- 'tax_query' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'post_type' => 'page',
+ 'order' => 'DESC',
+ 'orderby' => 'title',
+ 'post__not_in' => array( 1, 2 ),
+ 'tax_query' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'taxonomy' => 'category',
</span><span class="cx" style="display: block; padding: 0 10px"> 'terms' => array( 56 ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -461,6 +462,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'include_children' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'post_parent__in' => array( 1, 2 ),
</ins><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -585,6 +587,42 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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(),
+ )
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 52991
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_block_has_support() {
</span></span></pre>
</div>
</div>
</body>
</html>