-
Notifications
You must be signed in to change notification settings - Fork 3.2k
6.0 Backport to add support for custom taxonomies filtering for Query Loop (from Gutenberg) #2488
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.
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
Changes from all commits
d453c19
3163816
e51fd0c
b081331
cde5c14
fef0000
c658eb8
e22f662
ceedc0a
a3d71fb
a7d1560
d7b77aa
fec3207
6fbf8e5
0af2058
a3e5009
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,7 +12,7 @@ | |
| * Registers the core block patterns and categories. | ||
| * | ||
| * @since 5.5.0 | ||
| * @private | ||
| * @access private | ||
| */ | ||
| function _register_core_block_patterns_and_categories() { | ||
| $should_register_core_patterns = get_theme_support( 'core-block-patterns' ); | ||
|
|
@@ -127,3 +127,205 @@ function _load_remote_featured_patterns() { | |
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Registers patterns from Pattern Directory provided by a theme's | ||
| * `theme.json` file. | ||
| * | ||
| * @since 6.0.0 | ||
| * @access private | ||
| */ | ||
| function _register_remote_theme_patterns() { | ||
| if ( ! get_theme_support( 'core-block-patterns' ) ) { | ||
| return; | ||
| } | ||
|
|
||
| if ( ! apply_filters( 'should_load_remote_block_patterns', true ) ) { | ||
| return; | ||
| } | ||
|
|
||
| if ( ! WP_Theme_JSON_Resolver::theme_has_support() ) { | ||
| return; | ||
| } | ||
|
|
||
| $pattern_settings = WP_Theme_JSON_Resolver::get_theme_data()->get_patterns(); | ||
| if ( empty( $pattern_settings ) ) { | ||
| return; | ||
| } | ||
|
|
||
| $request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' ); | ||
| $request['slug'] = implode( ',', $pattern_settings ); | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I get the following error if I replace $request['slug'] = implode( ',', $pattern_settings );with $request['slug'] = $pattern_settings;: This error doesn't occur if There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think you are right. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've submitted a PR that fixes this issue. |
||
| $response = rest_do_request( $request ); | ||
| if ( $response->is_error() ) { | ||
| return; | ||
| } | ||
| $patterns = $response->get_data(); | ||
| $patterns_registry = WP_Block_Patterns_Registry::get_instance(); | ||
| foreach ( $patterns as $pattern ) { | ||
| $pattern_name = sanitize_title( $pattern['title'] ); | ||
| // Some patterns might be already registered as core patterns with the `core` prefix. | ||
| $is_registered = $patterns_registry->is_registered( $pattern_name ) || $patterns_registry->is_registered( "core/$pattern_name" ); | ||
| if ( ! $is_registered ) { | ||
| register_block_pattern( $pattern_name, (array) $pattern ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Register any patterns that the active theme may provide under its | ||
| * `./patterns/` directory. Each pattern is defined as a PHP file and defines | ||
| * its metadata using plugin-style headers. The minimum required definition is: | ||
| * | ||
| * /** | ||
| * * Title: My Pattern | ||
| * * Slug: my-theme/my-pattern | ||
| * * | ||
| * | ||
| * The output of the PHP source corresponds to the content of the pattern, e.g.: | ||
| * | ||
| * <main><p><?php echo "Hello"; ?></p></main> | ||
| * | ||
| * If applicable, this will collect from both parent and child theme. | ||
| * | ||
| * Other settable fields include: | ||
| * | ||
| * - Description | ||
| * - Viewport Width | ||
| * - Categories (comma-separated values) | ||
| * - Keywords (comma-separated values) | ||
| * - Block Types (comma-separated values) | ||
| * - Inserter (yes/no) | ||
| * | ||
| * @since 6.0.0 | ||
| * @access private | ||
| */ | ||
| function _register_theme_block_patterns() { | ||
| $default_headers = array( | ||
| 'title' => 'Title', | ||
| 'slug' => 'Slug', | ||
| 'description' => 'Description', | ||
| 'viewportWidth' => 'Viewport Width', | ||
| 'categories' => 'Categories', | ||
| 'keywords' => 'Keywords', | ||
| 'blockTypes' => 'Block Types', | ||
| 'inserter' => 'Inserter', | ||
| ); | ||
|
|
||
| /* | ||
| * Register patterns for the active theme. If the theme is a child theme, | ||
| * let it override any patterns from the parent theme that shares the same slug. | ||
| */ | ||
| $themes = array(); | ||
| $stylesheet = get_stylesheet(); | ||
| $template = get_template(); | ||
| if ( $stylesheet !== $template ) { | ||
| $themes[] = wp_get_theme( $stylesheet ); | ||
| } | ||
| $themes[] = wp_get_theme( $template ); | ||
|
|
||
| foreach ( $themes as $theme ) { | ||
hellofromtonya marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| $dirpath = $theme->get_stylesheet_directory() . '/patterns/'; | ||
| if ( file_exists( $dirpath ) ) { | ||
gziolo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| $files = glob( $dirpath . '*.php' ); | ||
| if ( $files ) { | ||
| foreach ( $files as $file ) { | ||
| $pattern_data = get_file_data( $file, $default_headers ); | ||
|
|
||
| if ( empty( $pattern_data['slug'] ) ) { | ||
| trigger_error( | ||
gziolo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| sprintf( | ||
| /* translators: %s: file name. */ | ||
| __( 'Could not register file "%s" as a block pattern ("Slug" field missing)' ), | ||
| $file | ||
| ) | ||
| ); | ||
| continue; | ||
| } | ||
|
|
||
| if ( ! preg_match( '/^[A-z0-9\/_-]+$/', $pattern_data['slug'] ) ) { | ||
| trigger_error( | ||
| sprintf( | ||
| /* translators: %1s: file name; %2s: slug value found. */ | ||
| __( 'Could not register file "%1$s" as a block pattern (invalid slug "%2$s")' ), | ||
| $file, | ||
| $pattern_data['slug'] | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| if ( WP_Block_Patterns_Registry::get_instance()->is_registered( $pattern_data['slug'] ) ) { | ||
| continue; | ||
| } | ||
|
|
||
| // Title is a required property. | ||
| if ( ! $pattern_data['title'] ) { | ||
| trigger_error( | ||
| sprintf( | ||
| /* translators: %1s: file name; %2s: slug value found. */ | ||
| __( 'Could not register file "%s" as a block pattern ("Title" field missing)' ), | ||
| $file | ||
| ) | ||
| ); | ||
| continue; | ||
| } | ||
|
|
||
| // For properties of type array, parse data as comma-separated. | ||
| foreach ( array( 'categories', 'keywords', 'blockTypes' ) as $property ) { | ||
| if ( ! empty( $pattern_data[ $property ] ) ) { | ||
| $pattern_data[ $property ] = array_filter( | ||
| preg_split( | ||
| '/[\s,]+/', | ||
| (string) $pattern_data[ $property ] | ||
| ) | ||
| ); | ||
| } else { | ||
| unset( $pattern_data[ $property ] ); | ||
| } | ||
| } | ||
|
|
||
| // Parse properties of type int. | ||
| foreach ( array( 'viewportWidth' ) as $property ) { | ||
| if ( ! empty( $pattern_data[ $property ] ) ) { | ||
| $pattern_data[ $property ] = (int) $pattern_data[ $property ]; | ||
| } else { | ||
| unset( $pattern_data[ $property ] ); | ||
| } | ||
| } | ||
|
|
||
| // Parse properties of type bool. | ||
| foreach ( array( 'inserter' ) as $property ) { | ||
| if ( ! empty( $pattern_data[ $property ] ) ) { | ||
| $pattern_data[ $property ] = in_array( | ||
| strtolower( $pattern_data[ $property ] ), | ||
| array( 'yes', 'true' ), | ||
| true | ||
| ); | ||
| } else { | ||
| unset( $pattern_data[ $property ] ); | ||
| } | ||
| } | ||
|
|
||
| // Translate the pattern metadata. | ||
| $text_domain = $theme->get( 'TextDomain' ); | ||
| //phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.NonSingularStringLiteralContext, WordPress.WP.I18n.NonSingularStringLiteralDomain, WordPress.WP.I18n.LowLevelTranslationFunction | ||
| $pattern_data['title'] = translate_with_gettext_context( $pattern_data['title'], 'Pattern title', $text_domain ); | ||
| if ( ! empty( $pattern_data['description'] ) ) { | ||
| //phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.NonSingularStringLiteralContext, WordPress.WP.I18n.NonSingularStringLiteralDomain, WordPress.WP.I18n.LowLevelTranslationFunction | ||
| $pattern_data['description'] = translate_with_gettext_context( $pattern_data['description'], 'Pattern description', $text_domain ); | ||
| } | ||
|
|
||
| // The actual pattern content is the output of the file. | ||
| ob_start(); | ||
| include $file; | ||
| $pattern_data['content'] = ob_get_clean(); | ||
| if ( ! $pattern_data['content'] ) { | ||
| continue; | ||
| } | ||
|
|
||
| register_block_pattern( $pattern_data['slug'], $pattern_data ); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| add_action( 'init', '_register_theme_block_patterns' ); | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -939,9 +939,8 @@ function do_blocks( $content ) { | |
| * If do_blocks() needs to remove wpautop() from the `the_content` filter, this re-adds it afterwards, | ||
| * for subsequent `the_content` usage. | ||
| * | ||
| * @access private | ||
| * | ||
| * @since 5.0.0 | ||
| * @access private | ||
| * | ||
| * @param string $content The post content running through this filter. | ||
| * @return string The unmodified content. | ||
|
|
@@ -1126,15 +1125,36 @@ function build_query_vars_from_query_block( $block, $page ) { | |
| $query['offset'] = ( $per_page * ( $page - 1 ) ) + $offset; | ||
| $query['posts_per_page'] = $per_page; | ||
| } | ||
| if ( ! empty( $block->context['query']['categoryIds'] ) ) { | ||
| $term_ids = array_map( 'intval', $block->context['query']['categoryIds'] ); | ||
| $term_ids = array_filter( $term_ids ); | ||
| $query['category__in'] = $term_ids; | ||
| // Migrate `categoryIds` and `tagIds` to `tax_query` for backwards compatibility. | ||
| if ( ! empty( $block->context['query']['categoryIds'] ) || ! empty( $block->context['query']['tagIds'] ) ) { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I can't see why this outer if is needed, the same checks are being done inside it. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just to 'encapsulate' (let's say) the 'migration' code. Also, both old attributes merge into a single one and without the extra if we would have more checks about new value and merge, etc.. I think there is no harm to leave this as is. |
||
| $tax_query = array(); | ||
| if ( ! empty( $block->context['query']['categoryIds'] ) ) { | ||
| $tax_query[] = array( | ||
| 'taxonomy' => 'category', | ||
| 'terms' => array_filter( array_map( 'intval', $block->context['query']['categoryIds'] ) ), | ||
| 'include_children' => false, | ||
| ); | ||
| } | ||
| if ( ! empty( $block->context['query']['tagIds'] ) ) { | ||
| $tax_query[] = array( | ||
| 'taxonomy' => 'post_tag', | ||
| 'terms' => array_filter( array_map( 'intval', $block->context['query']['tagIds'] ) ), | ||
| 'include_children' => false, | ||
| ); | ||
| } | ||
| $query['tax_query'] = $tax_query; | ||
| } | ||
| if ( ! empty( $block->context['query']['tagIds'] ) ) { | ||
| $term_ids = array_map( 'intval', $block->context['query']['tagIds'] ); | ||
| $term_ids = array_filter( $term_ids ); | ||
| $query['tag__in'] = $term_ids; | ||
| if ( ! empty( $block->context['query']['taxQuery'] ) ) { | ||
gziolo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| $query['tax_query'] = array(); | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This looks like it will stomp on any categories and tags in the shim above if the query block has both a legacy value and There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure if it will be possible to have the old and new attributes, as there is the client parsing that migrates the block. So in the case of deprecated blocks, we just fill the new attribute from the old ones.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Thanks, I gather that will come in as part of a package.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Using an else if ( ! empty( $block->context['query']['taxQuery'] ) ) {Not a blocker for the backport, though. |
||
| foreach ( $block->context['query']['taxQuery'] as $taxonomy => $terms ) { | ||
| if ( is_taxonomy_viewable( $taxonomy ) && ! empty( $terms ) ) { | ||
| $query['tax_query'][] = array( | ||
| 'taxonomy' => $taxonomy, | ||
| 'terms' => array_filter( array_map( 'intval', $terms ) ), | ||
| 'include_children' => false, | ||
| ); | ||
| } | ||
| } | ||
| } | ||
| if ( | ||
| isset( $block->context['query']['order'] ) && | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.