Template Part Block: Use get_block_template() #55961
Draft
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
ockham
commented
Nov 8, 2023
| * @param array $attributes The block attributes. | ||
| * @param string $template_part_file_path Absolute path to the not found template path. | ||
| */ | ||
| do_action( 'render_block_core_template_part_none', $template_part_id, $attributes, $template_part_file_path ); |
Contributor
Author
There was a problem hiding this comment.
Note that $template_part_file_path is no longer publicly available, as it's encapsulated in the implementation of get_block_template.
ockham
commented
Nov 8, 2023
| * @param string $template_part_file_path Absolute path to the template path. | ||
| * @param string $content The template part content. | ||
| */ | ||
| do_action( 'render_block_core_template_part_file', $template_part_id, $attributes, $template_part_file_path, $content ); |
Contributor
Author
There was a problem hiding this comment.
ockham
commented
Nov 8, 2023
| * @param WP_Post $template_part_post The template part post object. | ||
| * @param string $content The template part content. | ||
| */ | ||
| do_action( 'render_block_core_template_part_post', $template_part_id, $attributes, $template_part_post, $content ); |
Contributor
Author
There was a problem hiding this comment.
Same as https://github.com/WordPress/gutenberg/pull/55961/files#r1386421055, but with $template_part_post.
Mamaduka
reviewed
Nov 9, 2023
| * @param string $template_part_file_path Absolute path to the not found template path. | ||
| */ | ||
| do_action( 'render_block_core_template_part_none', $template_part_id, $attributes, $template_part_file_path ); | ||
| } elseif ( 'custom' === $block_template->source ) { |
Member
There was a problem hiding this comment.
I think checking against wp_id might be more future-proof here.
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.
WIP. Attempt to fix #55956.
What?
Replace template part lookup logic in the Template Part block with
get_block_template.Why?
The Template Part block has been duplicating functionality (by a low-level implementation of template part lookup from the database with a fallback to block theme provided files) that’s also present in various functions in Core’s
block-template-utils.phpfile.This has become a problem at least twice, when we needed Template Part blocks to apply template related filters that are only present in those higher-level methods from
block-template-utils.php, leading to #52892 and #55811, where we’ve replaced some low-level logic with slightly higher-level methods.This solved the problems at hand. However, there's still a risk that the template part lookup code will continue to diverge — e.g. when an enhancement or bugfix is introduced into the methods in
block-template-utils.php, the Template Part block might not receive them.How?
See What section 🙃
Testing Instructions
Verify that Template Part blocks still work as before, both on the frontend and in the editor.
Caveat: This PR doesn't currently work!