Query loop / Post template: Enable post format filter #64167
+1,097
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
carolinan
added
[Type] Enhancement
|
Size Change: +514 B (+0.03%) Total Size: 1.78 MB
ℹ️ View Unchanged
|
This comment was marked as resolved.
This comment was marked as resolved.
youknowriad
reviewed
Aug 1, 2024
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
youknowriad
reviewed
Aug 2, 2024
packages/block-library/src/query/edit/inspector-controls/post-format-controls.js
Outdated
Show resolved
Hide resolved
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
youknowriad
reviewed
Aug 5, 2024
youknowriad
reviewed
Aug 5, 2024
carolinan
commented
Aug 13, 2024
lib/compat/wordpress-6.7/class-gutenberg-rest-posts-controller-6-7.php
Outdated
Show resolved
Hide resolved
carolinan
commented
Aug 13, 2024
| * @param WP_REST_Request $request Full details about the request. | ||
| * @return array Updated query arguments. | ||
| */ | ||
| private function prepare_tax_query( array $args, WP_REST_Request $request ) { |
There was a problem hiding this comment.
No changes were made here, the function is only included because it is private in the original class...
carolinan
commented
Aug 13, 2024
| * @param array $query_params Collection schema. | ||
| * @return array Updated schema. | ||
| */ | ||
| private function prepare_taxonomy_limit_schema( array $query_params ) { |
There was a problem hiding this comment.
No changes were made here, the function is only included because it is private in the original class...
carolinan
commented
Aug 13, 2024
carolinan
commented
Aug 13, 2024
|
|
||
| $args = $this->prepare_tax_query( $args, $request ); | ||
|
|
||
| if ( isset( $request['format'] ) ) { |
There was a problem hiding this comment.
This is the only change to get_items.
Post template edit.js: Don't convert the post format to a string. This conversion prevented selecting multiple post formats in the query filter.
Mamaduka
reviewed
Aug 22, 2024
Change the type to a string that matches the format slugs. Each post can only have one format.
carolinan
commented
Aug 22, 2024
Comment on lines
+646
to
+651
| $schema['properties']['format'] = array( | ||
| 'description' => __( 'The format for the post.' ), | ||
| 'type' => 'string', | ||
| 'context' => array( 'view', 'edit' ), | ||
| 'enum' => array_values( get_post_format_slugs() ), | ||
| ); |
There was a problem hiding this comment.
This is the only change to get_item_schema.
There was a problem hiding this comment.
The format property is only included in the schema when the post type supports it above (see case 'post-formats). So why do we need unconditional addition here?
|
Flaky tests detected in 5154069. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/10501791656
|
I could not get this change to work. Maybe it should not even be added, so I am removing it.
|
I'm sorry if this has already been discussed, but maybe we should standardize post-format parameter names between the REST API and the editor. The tags' taxonomy name also has a How about using |
|
There are some issues that I will need to leave for another day (likely Monday)
|
5 tasks
Rename "postFormat" parameter to "format". Simplify the name of the control from PostFormatControls to FormatControls. Simplify the name of the constant that checks if the FormatControls should be used, from showPostFormatControl to showFormatControl.
I think the limitation is in the blocks.php file, gutenberg_filter_query_loop_block_query_vars_post_format, since if the |
Mamaduka
reviewed
Aug 28, 2024
There was a problem hiding this comment.
Thanks for standardizing the naming convention, @carolinan!
Is there a reason to use format instead of formats when an array for post formats is used for querying a post collection? It's not a blocker, but I've seen plural forms used in similar cases.
We should also update get_collection_params and list formats when the post type supports it. The post-status schema could be used as a blueprint for the new value.
| ! empty( $block->context['query']['format'] ) ) { | ||
| // Add the required "post-format-" prefix to each format. | ||
| $formats = array_map( | ||
| function ( $format ) { |
There was a problem hiding this comment.
Suggested change
| function ( $format ) { | |
| static function ( $format ) { |
I think even closures outside classes should be static.
|
|
||
| $args = $this->prepare_tax_query( $args, $request ); | ||
|
|
||
| if ( isset( $request['format'] ) && ! empty( $request['format'] ) ) { |
There was a problem hiding this comment.
Just ! empty check should be enough here.
| if ( ! empty( $formats ) ) { | ||
| // Add the post-format- prefix. | ||
| $terms = array_map( | ||
| function ( $format ) { |
There was a problem hiding this comment.
Suggested change
| function ( $format ) { | |
| static function ( $format ) { |
Micro-optimization: Closures/anon-functions in classes should use static if they're not accessing $this.
Comment on lines
+646
to
+651
| $schema['properties']['format'] = array( | ||
| 'description' => __( 'The format for the post.' ), | ||
| 'type' => 'string', | ||
| 'context' => array( 'view', 'edit' ), | ||
| 'enum' => array_values( get_post_format_slugs() ), | ||
| ); |
There was a problem hiding this comment.
The format property is only included in the schema when the post type supports it above (see case 'post-formats). So why do we need unconditional addition here?
Comment on lines
+56
to
+66
| <SelectControl | ||
| __nextHasNoMarginBottom | ||
| __next40pxDefaultSize | ||
| multiple | ||
| label={ __( 'Formats' ) } | ||
| value={ format } | ||
| options={ formatOptions } | ||
| onChange={ ( value ) => { | ||
| onChange( { format: value } ); | ||
| } } | ||
| /> |
There was a problem hiding this comment.
Is this a temporary placeholder component? Are we planning to switch to the FormTokenField later?
There was a problem hiding this comment.
I don't think this should use the FormTokenField because the options are always the ones supported by the theme.
The number of options is low, and I would like to know if the format is supported or not, without typing the name of the format into an input?
There was a problem hiding this comment.
That should be possible by displaying suggestions (supported formats) on focus. See https://wordpress.github.io/gutenberg/?path=/story/components-formtokenfield--dropdown-selector.
13 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Enables filtering the query loop result by post format.
Partial for #53049
Props @justintadlock @SergeyBiryukov
Why?
This feature is often requested by users, see the linked issue.
How?
Description updated August 22 2024.
This PR attempts to enable filtering the post query by post format, but handles the post format separately from
other taxonomies, as requested by reviewers.
Known limitations and issues include:
REST API changes:
Help is wanted with this part!
A new class
Gutenberg_REST_Posts_Controller_6_7that extendsWP_REST_Posts_Controlleris added to the 6.7 compatibility folder.The intention of this new temporary class is to add 'format' to the Posts controller, so that it can be used to filter the query result per post format.
Updates are made to these class methods: get_item, get_item_schema.
Earlier I also tried updating get_collection_params, but I was not able to make it work, so it is removed for now.
Query loop block:
postFormat, to thequeryblock attribute in the query loop block.PostFormatControlsthat uses a list of post formats in aSelectControl. The SelectControl usesmultipleto indicate to the user that they can select to show multiple formats in the query loop block.Help wanted: Using SelectControl may not be the best choice, I am very open to implementing other design ideas.
Post Template block:
postFormatparameter is passed from the query loop block to the post template block as part of thequery.queryusing the newformatkey (as opposed to using the post format taxonomy).Filtering query_loop_block_query_vars
Filter the query vars (tax_query) for the Query Loop block to support post formats on the front of the site.
Testing Instructions
Enable post formats in a theme by adding the theme support. Example:
Add some test content with different post formats.
Test that there are no regressions with the query loop features, and that all filters work.
The correct posts should show when the post format filter is used.
Screenshots or screencast