Update 'Add template' screen to prefer template_name label instead of singular_name #60367
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
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: +110 B (0%) Total Size: 1.74 MB
ℹ️ View Unchanged
|
|
Warning: Type of PR label mismatch To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.
Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task. |
ntsekouras
reviewed
Apr 22, 2024
| @@ -98,33 +98,31 @@ const usePublicTaxonomies = () => { | |||
| }, [ taxonomies ] ); | |||
| }; | |||
|
|
|||
| function usePostTypeNeedsUniqueIdentifier( publicPostTypes ) { | |||
There was a problem hiding this comment.
Why not adjust the logic here?
There was a problem hiding this comment.
Until now, the same could be reused in usePostTypeArchiveMenuItems() and usePostTypeMenuItems(), I guess that's why this function existed, instead of having it inline like in useTaxonomiesMenuItems().
With the changes in this PR, though, the same code can no longer be shared between usePostTypeArchiveMenuItems() and usePostTypeMenuItems() and because of that I removed the function and inlined the code in each respective place.
I don't have a strong opinion, so I'm happy to create functions for each one of them if you think that will keep the code cleaner.
ntsekouras
reviewed
Apr 22, 2024
| ); | ||
| const needsUniqueIdentifier = useCallback( | ||
| ( { labels, slug } ) => { | ||
| if ( [ 'post', 'page' ].includes( slug ) ) { |
There was a problem hiding this comment.
Why do we need this extra check?
There was a problem hiding this comment.
Hmm, good catch! I don't think it's necessary because templateName !== slug will always resolve to false for post and page. I guess it was a leftover from when I was coding, I removed it in 71d5748.
Aljullu
force-pushed
the
fix/60283-template_name-in-add-template
branch
from
48f049c
to
71d5748
Compare
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.
Fixes #60283.
Related PR on WordPress: WordPress/wordpress-develop#6344.
What?
This PR makes it so the Add template screen displays the
template_namelabel for CPT and custom taxonomy templates, instead of relying onsingular_name.Why?
This way, we allow plugins to add user-friendly names to templates related to their CPT/custom taxonomies.
How?
This PR makes it so
template_nametakes priority oversingular_namewhen possible. It also accounts for the cases of:template_namebeing missing, in which case we fall back tosingular_name, as it used to work.template_namebeing duplicate, in which case the CPT/custom taxonomy slug is displayed.Testing Instructions
template_nameto the post type and taxonomy:add_action( 'init', function () { register_post_type( 'recipe', array( 'labels' => array( 'name' => 'Recipes', 'singular_name' => 'Recipe', + 'template_name' => 'Single recipe', ), 'public' => true, 'show_in_rest' => true, ) ); register_taxonomy( 'recipe_cat', 'recipe', array( 'label' => 'Categories', 'labels' => array( 'name' => 'Recipe categories', 'singular_name' => 'Category', + 'template_name' => 'Recipes by category', ), 'show_in_rest' => true, ) ); } );