Skip to content
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

[Block Library - Post Terms]: Add dynamic variations of custom taxonomies #39837

Merged
merged 3 commits into from
May 11, 2022

Conversation

ntsekouras
Copy link
Contributor

What?

Resolves: #32924

This PR defines Post Terms block variations dynamically and registers them server side, available since 5.8.

Why?

Now we can display a list of all eligible taxonomies(built ins and custom ones).

Testing Instructions

  1. Register a custom taxonomy
  2. In the editor insert the variation for it like post {your taxonomy name}.
  3. Observe that if terms are set to the post you're testing with, they are displayed properly both in editor and front-end.

Alternatively just install a plugin with custom taxonomies already like WooCommerce and test with the product categories and product tags.

Screenshots or screencast

Screen.Recording.2022-03-29.at.10.38.05.AM.mov

@ntsekouras ntsekouras added [Type] Enhancement A suggestion for improvement. [Package] Block library /packages/block-library [Block] Post Terms Affects the Post Terms Block labels Mar 29, 2022
@ntsekouras ntsekouras self-assigned this Mar 29, 2022
@ntsekouras ntsekouras force-pushed the add/post-terms-dynamic-variations branch from 84cc9ac to d768487 Compare March 29, 2022 07:55
@github-actions
Copy link

github-actions bot commented Mar 29, 2022

Size Change: +3 B (0%)

Total Size: 1.23 MB

Filename Size Change
build/block-library/index.min.js 177 kB +4 B (0%)
build/components/index.min.js 227 kB -1 B (0%)
ℹ️ View Unchanged
Filename Size
build/a11y/index.min.js 993 B
build/annotations/index.min.js 2.77 kB
build/api-fetch/index.min.js 2.27 kB
build/autop/index.min.js 2.15 kB
build/blob/index.min.js 487 B
build/block-directory/index.min.js 6.51 kB
build/block-directory/style-rtl.css 1.01 kB
build/block-directory/style.css 1.01 kB
build/block-editor/default-editor-styles-rtl.css 378 B
build/block-editor/default-editor-styles.css 378 B
build/block-editor/index.min.js 151 kB
build/block-editor/style-rtl.css 15 kB
build/block-editor/style.css 15 kB
build/block-library/blocks/archives/editor-rtl.css 61 B
build/block-library/blocks/archives/editor.css 60 B
build/block-library/blocks/archives/style-rtl.css 65 B
build/block-library/blocks/archives/style.css 65 B
build/block-library/blocks/audio/editor-rtl.css 150 B
build/block-library/blocks/audio/editor.css 150 B
build/block-library/blocks/audio/style-rtl.css 111 B
build/block-library/blocks/audio/style.css 111 B
build/block-library/blocks/audio/theme-rtl.css 125 B
build/block-library/blocks/audio/theme.css 125 B
build/block-library/blocks/avatar/editor-rtl.css 116 B
build/block-library/blocks/avatar/editor.css 116 B
build/block-library/blocks/avatar/style-rtl.css 59 B
build/block-library/blocks/avatar/style.css 59 B
build/block-library/blocks/block/editor-rtl.css 161 B
build/block-library/blocks/block/editor.css 161 B
build/block-library/blocks/button/editor-rtl.css 445 B
build/block-library/blocks/button/editor.css 445 B
build/block-library/blocks/button/style-rtl.css 560 B
build/block-library/blocks/button/style.css 560 B
build/block-library/blocks/buttons/editor-rtl.css 292 B
build/block-library/blocks/buttons/editor.css 292 B
build/block-library/blocks/buttons/style-rtl.css 275 B
build/block-library/blocks/buttons/style.css 275 B
build/block-library/blocks/calendar/style-rtl.css 207 B
build/block-library/blocks/calendar/style.css 207 B
build/block-library/blocks/categories/editor-rtl.css 84 B
build/block-library/blocks/categories/editor.css 83 B
build/block-library/blocks/categories/style-rtl.css 79 B
build/block-library/blocks/categories/style.css 79 B
build/block-library/blocks/code/style-rtl.css 103 B
build/block-library/blocks/code/style.css 103 B
build/block-library/blocks/code/theme-rtl.css 124 B
build/block-library/blocks/code/theme.css 124 B
build/block-library/blocks/columns/editor-rtl.css 108 B
build/block-library/blocks/columns/editor.css 108 B
build/block-library/blocks/columns/style-rtl.css 406 B
build/block-library/blocks/columns/style.css 406 B
build/block-library/blocks/comment-author-avatar/editor-rtl.css 125 B
build/block-library/blocks/comment-author-avatar/editor.css 125 B
build/block-library/blocks/comment-content/style-rtl.css 92 B
build/block-library/blocks/comment-content/style.css 92 B
build/block-library/blocks/comment-template/style-rtl.css 127 B
build/block-library/blocks/comment-template/style.css 127 B
build/block-library/blocks/comments-pagination-numbers/editor-rtl.css 123 B
build/block-library/blocks/comments-pagination-numbers/editor.css 121 B
build/block-library/blocks/comments-pagination/editor-rtl.css 222 B
build/block-library/blocks/comments-pagination/editor.css 209 B
build/block-library/blocks/comments-pagination/style-rtl.css 235 B
build/block-library/blocks/comments-pagination/style.css 231 B
build/block-library/blocks/comments-title/editor-rtl.css 75 B
build/block-library/blocks/comments-title/editor.css 75 B
build/block-library/blocks/comments/editor-rtl.css 95 B
build/block-library/blocks/comments/editor.css 95 B
build/block-library/blocks/cover/editor-rtl.css 546 B
build/block-library/blocks/cover/editor.css 547 B
build/block-library/blocks/cover/style-rtl.css 1.53 kB
build/block-library/blocks/cover/style.css 1.53 kB
build/block-library/blocks/embed/editor-rtl.css 293 B
build/block-library/blocks/embed/editor.css 293 B
build/block-library/blocks/embed/style-rtl.css 417 B
build/block-library/blocks/embed/style.css 417 B
build/block-library/blocks/embed/theme-rtl.css 124 B
build/block-library/blocks/embed/theme.css 124 B
build/block-library/blocks/file/editor-rtl.css 300 B
build/block-library/blocks/file/editor.css 300 B
build/block-library/blocks/file/style-rtl.css 255 B
build/block-library/blocks/file/style.css 255 B
build/block-library/blocks/file/view.min.js 353 B
build/block-library/blocks/freeform/editor-rtl.css 2.44 kB
build/block-library/blocks/freeform/editor.css 2.44 kB
build/block-library/blocks/gallery/editor-rtl.css 961 B
build/block-library/blocks/gallery/editor.css 964 B
build/block-library/blocks/gallery/style-rtl.css 1.51 kB
build/block-library/blocks/gallery/style.css 1.51 kB
build/block-library/blocks/gallery/theme-rtl.css 122 B
build/block-library/blocks/gallery/theme.css 122 B
build/block-library/blocks/group/editor-rtl.css 333 B
build/block-library/blocks/group/editor.css 333 B
build/block-library/blocks/group/style-rtl.css 57 B
build/block-library/blocks/group/style.css 57 B
build/block-library/blocks/group/theme-rtl.css 78 B
build/block-library/blocks/group/theme.css 78 B
build/block-library/blocks/heading/style-rtl.css 76 B
build/block-library/blocks/heading/style.css 76 B
build/block-library/blocks/html/editor-rtl.css 332 B
build/block-library/blocks/html/editor.css 333 B
build/block-library/blocks/image/editor-rtl.css 731 B
build/block-library/blocks/image/editor.css 730 B
build/block-library/blocks/image/style-rtl.css 529 B
build/block-library/blocks/image/style.css 535 B
build/block-library/blocks/image/theme-rtl.css 124 B
build/block-library/blocks/image/theme.css 124 B
build/block-library/blocks/latest-comments/style-rtl.css 284 B
build/block-library/blocks/latest-comments/style.css 284 B
build/block-library/blocks/latest-posts/editor-rtl.css 199 B
build/block-library/blocks/latest-posts/editor.css 198 B
build/block-library/blocks/latest-posts/style-rtl.css 463 B
build/block-library/blocks/latest-posts/style.css 462 B
build/block-library/blocks/list/style-rtl.css 88 B
build/block-library/blocks/list/style.css 88 B
build/block-library/blocks/media-text/editor-rtl.css 266 B
build/block-library/blocks/media-text/editor.css 263 B
build/block-library/blocks/media-text/style-rtl.css 493 B
build/block-library/blocks/media-text/style.css 490 B
build/block-library/blocks/more/editor-rtl.css 431 B
build/block-library/blocks/more/editor.css 431 B
build/block-library/blocks/navigation-link/editor-rtl.css 708 B
build/block-library/blocks/navigation-link/editor.css 706 B
build/block-library/blocks/navigation-link/style-rtl.css 115 B
build/block-library/blocks/navigation-link/style.css 115 B
build/block-library/blocks/navigation-submenu/editor-rtl.css 299 B
build/block-library/blocks/navigation-submenu/editor.css 299 B
build/block-library/blocks/navigation-submenu/view.min.js 375 B
build/block-library/blocks/navigation/editor-rtl.css 2.03 kB
build/block-library/blocks/navigation/editor.css 2.04 kB
build/block-library/blocks/navigation/style-rtl.css 1.95 kB
build/block-library/blocks/navigation/style.css 1.94 kB
build/block-library/blocks/navigation/view-modal.min.js 2.78 kB
build/block-library/blocks/navigation/view.min.js 395 B
build/block-library/blocks/nextpage/editor-rtl.css 395 B
build/block-library/blocks/nextpage/editor.css 395 B
build/block-library/blocks/page-list/editor-rtl.css 363 B
build/block-library/blocks/page-list/editor.css 363 B
build/block-library/blocks/page-list/style-rtl.css 175 B
build/block-library/blocks/page-list/style.css 175 B
build/block-library/blocks/paragraph/editor-rtl.css 157 B
build/block-library/blocks/paragraph/editor.css 157 B
build/block-library/blocks/paragraph/style-rtl.css 260 B
build/block-library/blocks/paragraph/style.css 260 B
build/block-library/blocks/post-author/style-rtl.css 175 B
build/block-library/blocks/post-author/style.css 176 B
build/block-library/blocks/post-comments-form/editor-rtl.css 69 B
build/block-library/blocks/post-comments-form/editor.css 69 B
build/block-library/blocks/post-comments-form/style-rtl.css 521 B
build/block-library/blocks/post-comments-form/style.css 521 B
build/block-library/blocks/post-comments/editor-rtl.css 77 B
build/block-library/blocks/post-comments/editor.css 77 B
build/block-library/blocks/post-comments/style-rtl.css 527 B
build/block-library/blocks/post-comments/style.css 527 B
build/block-library/blocks/post-excerpt/editor-rtl.css 73 B
build/block-library/blocks/post-excerpt/editor.css 73 B
build/block-library/blocks/post-excerpt/style-rtl.css 69 B
build/block-library/blocks/post-excerpt/style.css 69 B
build/block-library/blocks/post-featured-image/editor-rtl.css 721 B
build/block-library/blocks/post-featured-image/editor.css 721 B
build/block-library/blocks/post-featured-image/style-rtl.css 153 B
build/block-library/blocks/post-featured-image/style.css 153 B
build/block-library/blocks/post-template/editor-rtl.css 99 B
build/block-library/blocks/post-template/editor.css 98 B
build/block-library/blocks/post-template/style-rtl.css 323 B
build/block-library/blocks/post-template/style.css 323 B
build/block-library/blocks/post-terms/style-rtl.css 73 B
build/block-library/blocks/post-terms/style.css 73 B
build/block-library/blocks/post-title/style-rtl.css 80 B
build/block-library/blocks/post-title/style.css 80 B
build/block-library/blocks/preformatted/style-rtl.css 103 B
build/block-library/blocks/preformatted/style.css 103 B
build/block-library/blocks/pullquote/editor-rtl.css 198 B
build/block-library/blocks/pullquote/editor.css 198 B
build/block-library/blocks/pullquote/style-rtl.css 370 B
build/block-library/blocks/pullquote/style.css 370 B
build/block-library/blocks/pullquote/theme-rtl.css 167 B
build/block-library/blocks/pullquote/theme.css 167 B
build/block-library/blocks/query-pagination-numbers/editor-rtl.css 122 B
build/block-library/blocks/query-pagination-numbers/editor.css 121 B
build/block-library/blocks/query-pagination/editor-rtl.css 221 B
build/block-library/blocks/query-pagination/editor.css 211 B
build/block-library/blocks/query-pagination/style-rtl.css 234 B
build/block-library/blocks/query-pagination/style.css 231 B
build/block-library/blocks/query/editor-rtl.css 369 B
build/block-library/blocks/query/editor.css 369 B
build/block-library/blocks/quote/style-rtl.css 213 B
build/block-library/blocks/quote/style.css 213 B
build/block-library/blocks/quote/theme-rtl.css 223 B
build/block-library/blocks/quote/theme.css 226 B
build/block-library/blocks/read-more/style-rtl.css 132 B
build/block-library/blocks/read-more/style.css 132 B
build/block-library/blocks/rss/editor-rtl.css 202 B
build/block-library/blocks/rss/editor.css 204 B
build/block-library/blocks/rss/style-rtl.css 289 B
build/block-library/blocks/rss/style.css 288 B
build/block-library/blocks/search/editor-rtl.css 165 B
build/block-library/blocks/search/editor.css 165 B
build/block-library/blocks/search/style-rtl.css 397 B
build/block-library/blocks/search/style.css 398 B
build/block-library/blocks/search/theme-rtl.css 64 B
build/block-library/blocks/search/theme.css 64 B
build/block-library/blocks/separator/editor-rtl.css 140 B
build/block-library/blocks/separator/editor.css 140 B
build/block-library/blocks/separator/style-rtl.css 233 B
build/block-library/blocks/separator/style.css 233 B
build/block-library/blocks/separator/theme-rtl.css 194 B
build/block-library/blocks/separator/theme.css 194 B
build/block-library/blocks/shortcode/editor-rtl.css 474 B
build/block-library/blocks/shortcode/editor.css 474 B
build/block-library/blocks/site-logo/editor-rtl.css 759 B
build/block-library/blocks/site-logo/editor.css 759 B
build/block-library/blocks/site-logo/style-rtl.css 181 B
build/block-library/blocks/site-logo/style.css 181 B
build/block-library/blocks/site-tagline/editor-rtl.css 86 B
build/block-library/blocks/site-tagline/editor.css 86 B
build/block-library/blocks/site-title/editor-rtl.css 84 B
build/block-library/blocks/site-title/editor.css 84 B
build/block-library/blocks/social-link/editor-rtl.css 177 B
build/block-library/blocks/social-link/editor.css 177 B
build/block-library/blocks/social-links/editor-rtl.css 674 B
build/block-library/blocks/social-links/editor.css 673 B
build/block-library/blocks/social-links/style-rtl.css 1.37 kB
build/block-library/blocks/social-links/style.css 1.36 kB
build/block-library/blocks/spacer/editor-rtl.css 332 B
build/block-library/blocks/spacer/editor.css 332 B
build/block-library/blocks/spacer/style-rtl.css 48 B
build/block-library/blocks/spacer/style.css 48 B
build/block-library/blocks/table/editor-rtl.css 504 B
build/block-library/blocks/table/editor.css 504 B
build/block-library/blocks/table/style-rtl.css 625 B
build/block-library/blocks/table/style.css 625 B
build/block-library/blocks/table/theme-rtl.css 188 B
build/block-library/blocks/table/theme.css 188 B
build/block-library/blocks/tag-cloud/style-rtl.css 226 B
build/block-library/blocks/tag-cloud/style.css 227 B
build/block-library/blocks/template-part/editor-rtl.css 149 B
build/block-library/blocks/template-part/editor.css 149 B
build/block-library/blocks/template-part/theme-rtl.css 101 B
build/block-library/blocks/template-part/theme.css 101 B
build/block-library/blocks/text-columns/editor-rtl.css 95 B
build/block-library/blocks/text-columns/editor.css 95 B
build/block-library/blocks/text-columns/style-rtl.css 166 B
build/block-library/blocks/text-columns/style.css 166 B
build/block-library/blocks/verse/style-rtl.css 87 B
build/block-library/blocks/verse/style.css 87 B
build/block-library/blocks/video/editor-rtl.css 571 B
build/block-library/blocks/video/editor.css 572 B
build/block-library/blocks/video/style-rtl.css 173 B
build/block-library/blocks/video/style.css 173 B
build/block-library/blocks/video/theme-rtl.css 124 B
build/block-library/blocks/video/theme.css 124 B
build/block-library/common-rtl.css 993 B
build/block-library/common.css 990 B
build/block-library/editor-rtl.css 10.2 kB
build/block-library/editor.css 10.3 kB
build/block-library/reset-rtl.css 478 B
build/block-library/reset.css 478 B
build/block-library/style-rtl.css 11.5 kB
build/block-library/style.css 11.5 kB
build/block-library/theme-rtl.css 689 B
build/block-library/theme.css 694 B
build/block-serialization-default-parser/index.min.js 1.12 kB
build/block-serialization-spec-parser/index.min.js 2.83 kB
build/blocks/index.min.js 47 kB
build/components/style-rtl.css 15 kB
build/components/style.css 15 kB
build/compose/index.min.js 11.3 kB
build/core-data/index.min.js 14.6 kB
build/customize-widgets/index.min.js 11 kB
build/customize-widgets/style-rtl.css 1.39 kB
build/customize-widgets/style.css 1.39 kB
build/data-controls/index.min.js 663 B
build/data/index.min.js 7.66 kB
build/date/index.min.js 32 kB
build/deprecated/index.min.js 518 B
build/dom-ready/index.min.js 336 B
build/dom/index.min.js 4.58 kB
build/edit-navigation/index.min.js 15.8 kB
build/edit-navigation/style-rtl.css 4.05 kB
build/edit-navigation/style.css 4.05 kB
build/edit-post/classic-rtl.css 546 B
build/edit-post/classic.css 547 B
build/edit-post/index.min.js 30.1 kB
build/edit-post/style-rtl.css 7.02 kB
build/edit-post/style.css 7.02 kB
build/edit-site/index.min.js 47.4 kB
build/edit-site/style-rtl.css 7.95 kB
build/edit-site/style.css 7.93 kB
build/edit-widgets/index.min.js 16.3 kB
build/edit-widgets/style-rtl.css 4.41 kB
build/edit-widgets/style.css 4.4 kB
build/editor/index.min.js 38.4 kB
build/editor/style-rtl.css 3.67 kB
build/editor/style.css 3.67 kB
build/element/index.min.js 4.3 kB
build/escape-html/index.min.js 548 B
build/format-library/index.min.js 6.62 kB
build/format-library/style-rtl.css 571 B
build/format-library/style.css 571 B
build/hooks/index.min.js 1.66 kB
build/html-entities/index.min.js 454 B
build/i18n/index.min.js 3.79 kB
build/is-shallow-equal/index.min.js 535 B
build/keyboard-shortcuts/index.min.js 1.83 kB
build/keycodes/index.min.js 1.41 kB
build/list-reusable-blocks/index.min.js 1.75 kB
build/list-reusable-blocks/style-rtl.css 838 B
build/list-reusable-blocks/style.css 838 B
build/media-utils/index.min.js 2.94 kB
build/notices/index.min.js 957 B
build/nux/index.min.js 2.1 kB
build/nux/style-rtl.css 751 B
build/nux/style.css 749 B
build/plugins/index.min.js 1.98 kB
build/preferences-persistence/index.min.js 2.16 kB
build/preferences/index.min.js 1.32 kB
build/primitives/index.min.js 949 B
build/priority-queue/index.min.js 628 B
build/react-i18n/index.min.js 704 B
build/react-refresh-entry/index.min.js 8.44 kB
build/react-refresh-runtime/index.min.js 7.31 kB
build/redux-routine/index.min.js 2.69 kB
build/reusable-blocks/index.min.js 2.24 kB
build/reusable-blocks/style-rtl.css 256 B
build/reusable-blocks/style.css 256 B
build/rich-text/index.min.js 11.2 kB
build/server-side-render/index.min.js 1.61 kB
build/shortcode/index.min.js 1.52 kB
build/token-list/index.min.js 668 B
build/url/index.min.js 1.99 kB
build/vendors/react-dom.min.js 38.5 kB
build/vendors/react.min.js 4.34 kB
build/viewport/index.min.js 1.08 kB
build/warning/index.min.js 280 B
build/widgets/index.min.js 7.21 kB
build/widgets/style-rtl.css 1.16 kB
build/widgets/style.css 1.16 kB
build/wordcount/index.min.js 1.07 kB

compressed-size-action

@paaljoachim
Copy link
Contributor

This is really helpful! Thank you @ntsekouras

I am using a dev site where I am updating various tutorials that also use the custom post type "Tutorial".

Finding post terms. Or I could also have written Post categories or Post tags.
Screenshot 2022-03-30 at 15 37 13

Post Tutorial Categories:

Screenshot 2022-03-30 at 15 38 30


Post Tutorial Tags:

Screenshot 2022-03-30 at 15 38 38


Adding some text. (backend)
Screenshot 2022-03-30 at 15 50 36

Frontend:
Screenshot 2022-03-30 at 15 49 22

Backend shows the layout just a little different compared to the frontend.

@Mamaduka
Copy link
Member

This works great, Nik.

The Post prefix for all taxonomies feels a little odd to me. What do you think if we only prefix taxonomies registered for posts?

in_array( 'post', $taxonomy->object_type, true )

It would be nice if we could limit variations based on the post-type context in the future.

@ntsekouras
Copy link
Contributor Author

The Post prefix for all taxonomies feels a little odd to me. What do you think if we only prefix taxonomies registered for posts?

For me the post here is the generic one but I don't have something better to suggest.. What I think though is that we need some kind of prefix for every variation and since taxonomies and post types are related many to many, this could get complicated really fast.

--cc @mtias @jasmussen for any thoughts about the names.

@mtias
Copy link
Member

mtias commented Mar 31, 2022

I'd remove the prefix and honor the label name. For posts, "tags" and "categories" would be easier to read.

@ntsekouras
Copy link
Contributor Author

I'd remove the prefix and honor the label name. For posts, "tags" and "categories" would be easier to read.

Without any prefix we will end up with duplicate block names. For example the Categories block which is a list of all categories and Categories from Post Terms that list the current post's categories.

@ntsekouras
Copy link
Contributor Author

I'd remove the prefix and honor the label name. For posts, "tags" and "categories" would be easier to read.

Without any prefix we will end up with duplicate block names. For example the Categories block which is a list of all categories and Categories from Post Terms that list the current post's categories.

Alternatively I guess we could update the other blocks to show Categories lists etc.. It would be good in general to add dynamic variations of those blocks as well for custom taxonomies.

@paaljoachim
Copy link
Contributor

paaljoachim commented Apr 5, 2022

Should we get this into WordPress 6.0?
As it would be helpful to be able to show CPT terms.

@paaljoachim
Copy link
Contributor

@adamziel @gziolo @youknowriad
Let's get some additional thoughts on this PR, and see if it is something that should be merged today for WordPress 6.0.

@jameskoster
Copy link
Contributor

Alternatively I guess we could update the other blocks to show Categories lists etc

Could another option would be to prohibit placing the Categories block inside a Query?

If we're going to include the post type in the block name we should probably update the placeholder content as well, IE this should read 'No product tags':

Screenshot 2022-04-08 at 13 21 05

That said, it would be interesting to eliminate all the prefixes. I've said this before but "Post Title" is kind of odd to see when working with a Product query, or a Page query for that matter.

Like Titles, concepts such as categories and tags are universal, so I'm not sure they ever need prefixes? If we used generic block names they could behave agnostically. IE the Categories and Tags blocks could theoretically adapt based on the selected post type. Whereas with the current implementation, if you swapped the Query to display products instead of posts you'd need to manually remove the Categories block and add the Product Categories one which seems unnecessarily convoluted.

@jasmussen
Copy link
Contributor

That said, it would be interesting to eliminate all the prefixes. I've said this before but "Post Title" is kind of odd to see when working with a Product query, or a Page query for that matter.

Yes, I just ran into something like this recently, such as inserting a Post Title on a Page template, or looking for "Archive Title" in all blocks when in fact the one I should've picked was "Query Title". There are probably some cases were we can't unify all these; indeed there's that curious case on the archive template where you want to show both the title of the archive, and individual item titles inside a query loop. Finally there may be a benefit of being able to style these individually in the Global Styles → Blocks panel, and give them different fonts, sizes, treatments, etc.

So those are some of the thoughts to balance, but definitely agree that there's some simplification to have here.

@jameskoster
Copy link
Contributor

indeed there's that curious case on the archive template where you want to show both the title of the archive, and individual item titles inside a query loop

In that case I think 'Archive title' is okay because it doesn't lean in to any particular post type. It will behave consistently placed in either category.html or taxonomy-product_cat-tshirts.html.

For a while I've thought that a good rule of thumb could be to look at the underlying function name for guidance around these non-custom blocks. IE the_content() = Content. the_archive_title() = Archive Title.

@ntsekouras
Copy link
Contributor Author

Could another option would be to prohibit placing the Categories block inside a Query?

I think it can create confusion because we will end up with different blocks with the same name. Also outside a Query Loop block we will have these different blocks exposed in the inserter - think of a single post content or template.

@jameskoster
Copy link
Contributor

Good point. In that case I like your idea above:

Alternatively I guess we could update the other blocks to show Categories lists etc...

@ntsekouras ntsekouras force-pushed the add/post-terms-dynamic-variations branch from d768487 to f245e83 Compare April 15, 2022 13:03
@ntsekouras
Copy link
Contributor Author

By rebasing I have lost (temporally) the change of icon introduced here: #40096. I'll probably need to add a filter for assigning different icons.

@ntsekouras ntsekouras requested a review from mkaz as a code owner April 15, 2022 13:58
@ntsekouras
Copy link
Contributor Author

I pushed an update that changes:

  1. The title of Categories block to Categories List
  2. The dynamic variations use taxonomy's label as title and the description has Display the assigned ${taxonomy_label} format.
  3. Added a filter to assign icons for categories and tags, but the remaining ones use the block's default icon, which currently is the categories icon.

@Mamaduka
Copy link
Member

Maybe for WP 6.1, we should propose new arguments for taxonomy registration:

  • labels.variation_name - Use for variation registration.
  • show_in_variation - Top level argument. Defaults to show_in_rest, but will allow developers more control.

@ntsekouras ntsekouras force-pushed the add/post-terms-dynamic-variations branch from 62d741c to a142c17 Compare May 6, 2022 08:58
@mtias
Copy link
Member

mtias commented May 9, 2022

Should post types also do this automatically as Query variations? (i.e. a Films query block if I have a Films custom post type, etc)

@ntsekouras
Copy link
Contributor Author

Should post types also do this automatically as Query variations? (i.e. a Films query block if I have a Films custom post type, etc)

Yes, we can do this in a follow up.

Copy link
Contributor

@youknowriad youknowriad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@ntsekouras ntsekouras merged commit 98df6c2 into trunk May 11, 2022
@ntsekouras ntsekouras deleted the add/post-terms-dynamic-variations branch May 11, 2022 11:00
@github-actions github-actions bot added this to the Gutenberg 13.3 milestone May 11, 2022
@femkreations femkreations added the Needs User Documentation Needs new user documentation label Sep 2, 2022
@mburridge mburridge added the Needs Dev Note Requires a developer note for a major WordPress release cycle label Sep 9, 2022
@mburridge
Copy link
Contributor

Added the Needs Dev Note label in case a dev note is needed for 6.1 release.

@ntsekouras
Copy link
Contributor Author

Added the Needs Dev Note label in case a dev note is needed for 6.1 release.

I'm not sure if one is needed.. This PR just creates some dynamic variations of Post Terms block and are available in the editor for users..

@mburridge mburridge removed the Needs Dev Note Requires a developer note for a major WordPress release cycle label Sep 9, 2022
@mburridge
Copy link
Contributor

Okay, thanks @ntsekouras. I've removed the label.

@sabernhardt
Copy link
Contributor

Could we reconsider a prefix for the Post Terms block, perhaps something like "Terms:"?

I think that changing the original "Categories" block to "Categories List" is fine, but I'm concerned about giving its name to another block (at least in English). Selecting a block named "Categories" does something very different now, and that can surprise people who like to add categories lists in their sites. Confusion would be less common than I originally thought because the Post Terms block is not available in the Widget editors, yet it can happen in the Site and Post editors.

And maybe this discussion belongs in a new issue.

@paaljoachim
Copy link
Contributor

paaljoachim commented Sep 24, 2024

I believe this issue would be interesting to know about:
[Block Library - Post Terms]: Add dynamic variations of feeds
#65351

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Post Terms Affects the Post Terms Block Needs User Documentation Needs new user documentation [Package] Block library /packages/block-library [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Post Terms Block: automatically add all public taxonomies as variations