Skip to content

Add wp_get_theme_data_custom_templates#5031

Closed
oandregal wants to merge 4 commits intoWordPress:trunkfrom
oandregal:add/public-method-for-custom-templates
Closed

Add wp_get_theme_data_custom_templates#5031
oandregal wants to merge 4 commits intoWordPress:trunkfrom
oandregal:add/public-method-for-custom-templates

Conversation

@oandregal
Copy link
Copy Markdown
Member

@oandregal oandregal commented Aug 18, 2023 •
edited
Loading

Part of WordPress/gutenberg#45171
Trac ticket: https://core.trac.wordpress.org/ticket/59137

What

This PR adds a new public function wp_get_theme_data_custom_templates to offer access to metadata stored under customTemplates in theme.json.

Why

There is a no public function to get access to that data, so consumers need to resort to private APIs. This follows the steps of wp_get_global_settings, wp_theme_has_theme_json, wp_get_theme_directory_pattern_slugs, and wp_get_theme_data_template_parts.

How

It creates a new function that uses the private calls and substitutes all the instances of the old one in the codebase.

How to test

TBD.

Commit message

Themes: add `wp_get_theme_data_custom_templates` function.

Adds a new public function, `wp_get_theme_data_custom_templates` that returns the `customTemplates` defined by the active theme from `theme.json`. It also substitutes the usage of private APIs by this new API.

Props johnbillion, audrasjb.
Fixes #59137

@oandregal oandregal self-assigned this Aug 18, 2023
@oandregal oandregal mentioned this pull request Aug 18, 2023
Open
johnbillion
johnbillion requested changes Aug 18, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@johnbillion johnbillion left a comment

Choose a reason for hiding this comment

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

This function is missing a return statement and its @return tag is incorrect. Can you check and correct those please?

@oandregal
Copy link
Copy Markdown
Member Author

oandregal commented Aug 18, 2023

This function is missing a return statement and its @return tag is incorrect. Can you check and correct those please?

Thanks, @johnbillion for catching the issue. Both things addressed.

@audrasjb
Copy link
Copy Markdown
Contributor

audrasjb commented Aug 18, 2023

Ah correct.
The change looks good to me, but we usually add a line break on long docblock sentences to avoid having too much characters on the same line

@oandregal
Copy link
Copy Markdown
Member Author

oandregal commented Aug 18, 2023

The change looks good to me, but we usually add a line break on long docblock sentences to avoid having too much characters on the same line

Added the line break as well.

@oandregal
Copy link
Copy Markdown
Member Author

oandregal commented Aug 18, 2023

Looking for how we do @return in other functions, I've noticed this #5033

@oandregal oandregal mentioned this pull request Aug 18, 2023
Closed
@oandregal
Copy link
Copy Markdown
Member Author

oandregal commented Aug 18, 2023

@johnbillion when you have the time, can you clear up the blocker so I can commit this?

@oandregal
Copy link
Copy Markdown
Member Author

oandregal commented Aug 18, 2023

Committed at https://core.trac.wordpress.org/changeset/56413.

@oandregal oandregal closed this Aug 18, 2023
@oandregal oandregal deleted the add/public-method-for-custom-templates branch August 18, 2023 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@johnbillion johnbillion johnbillion approved these changes

@audrasjb audrasjb audrasjb approved these changes

Assignees

@oandregal oandregal

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@oandregal @audrasjb @johnbillion