Fix template part theme identifier #25995
Merged
Conversation
This file contains hidden or 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
Addison-Stavlo
requested review from
Copons,
david-szabo97,
jeyip,
mcsf,
noahtallen and
vindl
Addison-Stavlo
requested review from
Soean,
TimothyBJacobs,
ajitbohra,
spacedmonkey and
talldan
as code owners
6 tasks
|
Size Change: +2 B (0%) Total Size: 1.19 MB
ℹ️ View Unchanged
|
noahtallen
approved these changes
Oct 9, 2020
Member
noahtallen
left a comment
noahtallen
left a comment
There was a problem hiding this comment.
This seems to be working well for me! 
Contributor
|
Thanks! |
noahtallen
reviewed
Oct 13, 2020
|
|
||
| // Ensure auto-drafts of all theme supplied template parts are created. | ||
| if ( wp_get_theme()->get( 'TextDomain' ) === $request['theme'] ) { | ||
| if ( wp_get_theme()->stylesheet === $request['theme'] ) { |
Member
There was a problem hiding this comment.
should we use wp_get_theme()->get_stylesheet() instead? cc @mcsf
Contributor
There was a problem hiding this comment.
@nosolosw dug into this just yesterday (and himself used get_stylesheet()), so I'll defer to him.
Member
There was a problem hiding this comment.
👋 TLDR: if you look for a theme identifier, stylesheet is the best option. Here's what I know:
- Despite its name,
stylesheetrefers to the name of the theme directory within the theme root (see https://github.com/WordPress/wordpress-develop/blob/master/src/wp-includes/class-wp-theme.php#L206). - For child themes, its value is the child theme directory name, not the parent's. This means that, effectively,
stylesheetcan function as the unique identifier of a theme, unlike other potential candidates such astextdomain(can be empty) ortemplate(points to the parent in a child theme). - If the theme is stored within another directory (eg:
themes/some-dir/my-themeinstead ofthemes/my-theme) it'll returnsome-dir/my-theme, so need to cover for this case if it's problematic. - The
stylesheetname can contain any character that is allowed in the filesystem (eg: spaces, somy themeis a validstylesheetvalue), need to cover for this as well.
Member
There was a problem hiding this comment.
Nice, thanks for that overview! I guess I was curious about the difference between:
$theme_identifier = wp_get_theme()->stylesheet;
// alternatively:
$theme_identifier = wp_get_theme()->get_stylesheet();is there any reason to use one over the other?
Member
There was a problem hiding this comment.
Oh, what a misunderstanding, I'm so embarrassed 😅
Probably the WordPress standards or PHP idioms have some strong opinions on how this should be done, but I don't know if it really matters in this case.
Member
There was a problem hiding this comment.
I think wp_get_theme()->get_stylesheet(); is preferred.
This was referenced Oct 19, 2020
Closed
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.
Description
Update to use the themes
stylesheetproperty instead oftextdomain. It was pointed out (#25923 (comment)) that whiletextdomainshould generally be the same asstylesheet,textdomaincould technically be omitted andstylesheetwill be a more robust solution.How has this been tested?
Smoke test template part seleection:
Screenshots
Types of changes
Checklist: