WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: Improve docblock for `WP_Block_Patterns_Registry::register`. 

This documents the new `filePath` property supported by `WP_Block_Patterns_Registry::register` and also updates the property name to camel case formatting to be consistent with other block pattern properties.

Props thekt12, spacedmonkey, joemcgill.
See #59532.

Built from https://develop.svn.wordpress.org/trunk@57731


git-svn-id: http://core.svn.wordpress.org/trunk@57232 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Joe McGill 2024-02-27 21:05:11 +00:00
parent 845a537170
commit 5f2e2f85f7
3 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
wp-includes/block-patterns.php
View File

@ -391,7 +391,7 @@ function _register_theme_block_patterns() {
continue; continue;
} }
$pattern_data['file_path'] = $file_path; $pattern_data['filePath'] = $file_path;
// Translate the pattern metadata. // Translate the pattern metadata.
// phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText,WordPress.WP.I18n.NonSingularStringLiteralDomain,WordPress.WP.I18n.LowLevelTranslationFunction // phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText,WordPress.WP.I18n.NonSingularStringLiteralDomain,WordPress.WP.I18n.LowLevelTranslationFunction

14
wp-includes/class-wp-block-patterns-registry.php
View File

@ -45,13 +45,16 @@ final class WP_Block_Patterns_Registry {
* @since 5.8.0 Added support for the `blockTypes` property. * @since 5.8.0 Added support for the `blockTypes` property.
* @since 6.1.0 Added support for the `postTypes` property. * @since 6.1.0 Added support for the `postTypes` property.
* @since 6.2.0 Added support for the `templateTypes` property. * @since 6.2.0 Added support for the `templateTypes` property.
* @since 6.5.0 Added support for the `filePath` property.
* *
* @param string $pattern_name Block pattern name including namespace. * @param string $pattern_name Block pattern name including namespace.
* @param array $pattern_properties { * @param array $pattern_properties {
* List of properties for the block pattern. * List of properties for the block pattern.
* *
* @type string $title Required. A human-readable title for the pattern. * @type string $title Required. A human-readable title for the pattern.
* @type string $content Required. Block HTML markup for the pattern. * @type string $content Optional. Block HTML markup for the pattern.
* If not provided, the content will be retrieved from the `filePath` if set.
* If both `content` and `filePath` are not set, the pattern will not be registered.
* @type string $description Optional. Visually hidden text used to describe the pattern * @type string $description Optional. Visually hidden text used to describe the pattern
* in the inserter. A description is optional, but is strongly * in the inserter. A description is optional, but is strongly
* encouraged when the title does not fully describe what the * encouraged when the title does not fully describe what the
@ -79,6 +82,7 @@ final class WP_Block_Patterns_Registry {
* of the post types passed on the array. For all the other post types * of the post types passed on the array. For all the other post types
* not part of the array the pattern is not available at all. * not part of the array the pattern is not available at all.
* @type string[] $templateTypes Optional. An array of template types where the pattern fits. * @type string[] $templateTypes Optional. An array of template types where the pattern fits.
* @type string $filePath Optional. The full path to the file containing the block pattern content.
* } * }
* @return bool True if the pattern was registered with success and false otherwise. * @return bool True if the pattern was registered with success and false otherwise.
*/ */
@ -101,7 +105,7 @@ final class WP_Block_Patterns_Registry {
return false; return false;
} }
if ( ! isset( $pattern_properties['file_path'] ) ) { if ( ! isset( $pattern_properties['filePath'] ) ) {
if ( ! isset( $pattern_properties['content'] ) || ! is_string( $pattern_properties['content'] ) ) { if ( ! isset( $pattern_properties['content'] ) || ! is_string( $pattern_properties['content'] ) ) {
_doing_it_wrong( _doing_it_wrong(
__METHOD__, __METHOD__,
@ -194,11 +198,11 @@ final class WP_Block_Patterns_Registry {
} else { } else {
$patterns = &$this->registered_patterns; $patterns = &$this->registered_patterns;
} }
if ( ! isset( $patterns[ $pattern_name ]['content'] ) && isset( $patterns[ $pattern_name ]['file_path'] ) ) { if ( ! isset( $patterns[ $pattern_name ]['content'] ) && isset( $patterns[ $pattern_name ]['filePath'] ) ) {
ob_start(); ob_start();
include $patterns[ $pattern_name ]['file_path']; include $patterns[ $pattern_name ]['filePath'];
$patterns[ $pattern_name ]['content'] = ob_get_clean(); $patterns[ $pattern_name ]['content'] = ob_get_clean();
unset( $patterns[ $pattern_name ]['file_path'] ); unset( $patterns[ $pattern_name ]['filePath'] );
} }
return $patterns[ $pattern_name ]['content']; return $patterns[ $pattern_name ]['content'];
} }

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.5-beta3-57730'; $wp_version = '6.5-beta3-57731';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.