Fix some docblock types related to the Template Registration API #65187
Conversation
|
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. |
backport-changelog/6.7/7125.md
Outdated
| @@ -2,3 +2,4 @@ https://github.com/WordPress/wordpress-develop/pull/7125 | |||
|
|
|||
| * https://github.com/WordPress/gutenberg/pull/61577 | |||
| * https://github.com/WordPress/gutenberg/pull/64610 | |||
| * https://github.com/WordPress/gutenberg/pull/65187 | |||
There was a problem hiding this comment.
Since these changes are going to land first in core, I don't think we need this entry to mark this PR for backport, do we?
There was a problem hiding this comment.
Thanks, I wasn't sure either. I reverted the change and added the Backport from WordPress Core label so the job passes.
| @@ -33,7 +32,7 @@ function wp_register_block_template( $template_name, $args = array() ) { | |||
| * Unregister a template. | |||
| * | |||
| * @param string $template_name Template name in the form of `plugin_uri//template_name`. | |||
| * @return true|WP_Error True on success, WP_Error on failure or if the template doesn't exist. | |||
| * @return WP_Block_Template|WP_Error True on success, WP_Error on failure or if the template doesn't exist. | |||
There was a problem hiding this comment.
I guess the True on success part need to change here and at the core PR.
There was a problem hiding this comment.
Good catch! Fixed in d5b7efe.
This reverts commit 71ea479.
Aljullu
force-pushed
the
fix/block-template-registration-docblock-fixes
branch
from
6072dcb
to
d5b7efe
Compare
Aljullu
added
Backport from WordPress Core
Co-authored-by: Nik Tsekouras <[email protected]>
What?
This PR applies changes introduced in WordPress/wordpress-develop#7125 during the code review phase. These changes correct incorrect types in PHP function doc blocks.
Kudos to @anton-vlasenko for finding those issues.
Why?
During the refactor in #61577, I missed updating some doc blocks. They were identified during the WP core PR review, so I'm applying the corrections to Gutenberg as well.
How?
The changes are limited to correcting the wrong type data in doc block comments.
Testing Instructions
Since the changes are purely within the doc block comments, no functionality testing is required. Simply verify the accuracy of the updated doc blocks.
Testing Instructions for Keyboard
N/A
Screenshots or screencast
N/A