-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add: Ability to use creation patterns for other post types besides pa…
…ge (#41791) Co-authored-by: Miguel Fonseca <[email protected]>
- Loading branch information
1 parent
be111df
commit 7df592e
Showing
8 changed files
with
480 additions
and
202 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| <?php | ||
| /** | ||
| * Block patterns registration from within a theme | ||
| * | ||
| * @package gutenberg | ||
| */ | ||
|
|
||
| /** | ||
| * Register any patterns that the active theme may provide under its | ||
| * `./patterns/` directory. Each pattern is defined as a PHP file and defines | ||
| * its metadata using plugin-style headers. The minimum required definition is: | ||
| * | ||
| * /** | ||
| * * Title: My Pattern | ||
| * * Slug: my-theme/my-pattern | ||
| * * | ||
| * | ||
| * The output of the PHP source corresponds to the content of the pattern, e.g.: | ||
| * | ||
| * <main><p><?php echo "Hello"; ?></p></main> | ||
| * | ||
| * If applicable, this will collect from both parent and child theme. | ||
| * | ||
| * Other settable fields include: | ||
| * | ||
| * - Description | ||
| * - Viewport Width | ||
| * - Categories (comma-separated values) | ||
| * - Keywords (comma-separated values) | ||
| * - Block Types (comma-separated values) | ||
| * - Post Types (comma-separated values) | ||
| * - Inserter (yes/no) | ||
| * | ||
| * @since 6.0.0 | ||
| * @access private | ||
| */ | ||
| function gutenberg_register_theme_block_patterns() { | ||
| $default_headers = array( | ||
| 'title' => 'Title', | ||
| 'slug' => 'Slug', | ||
| 'description' => 'Description', | ||
| 'viewportWidth' => 'Viewport Width', | ||
| 'categories' => 'Categories', | ||
| 'keywords' => 'Keywords', | ||
| 'blockTypes' => 'Block Types', | ||
| 'postTypes' => 'Post Types', | ||
| 'inserter' => 'Inserter', | ||
| ); | ||
|
|
||
| /* | ||
| * Register patterns for the active theme. If the theme is a child theme, | ||
| * let it override any patterns from the parent theme that shares the same slug. | ||
| */ | ||
| $themes = array(); | ||
| $stylesheet = get_stylesheet(); | ||
| $template = get_template(); | ||
| if ( $stylesheet !== $template ) { | ||
| $themes[] = wp_get_theme( $stylesheet ); | ||
| } | ||
| $themes[] = wp_get_theme( $template ); | ||
|
|
||
| foreach ( $themes as $theme ) { | ||
| $dirpath = $theme->get_stylesheet_directory() . '/patterns/'; | ||
| if ( ! is_dir( $dirpath ) || ! is_readable( $dirpath ) ) { | ||
| continue; | ||
| } | ||
| if ( file_exists( $dirpath ) ) { | ||
| $files = glob( $dirpath . '*.php' ); | ||
| if ( $files ) { | ||
| foreach ( $files as $file ) { | ||
| $pattern_data = get_file_data( $file, $default_headers ); | ||
|
|
||
| if ( empty( $pattern_data['slug'] ) ) { | ||
| _doing_it_wrong( | ||
| '_register_theme_block_patterns', | ||
| sprintf( | ||
| /* translators: %s: file name. */ | ||
| __( 'Could not register file "%s" as a block pattern ("Slug" field missing)', 'gutenberg' ), | ||
| $file | ||
| ), | ||
| '6.0.0' | ||
| ); | ||
| continue; | ||
| } | ||
|
|
||
| if ( ! preg_match( '/^[A-z0-9\/_-]+$/', $pattern_data['slug'] ) ) { | ||
| _doing_it_wrong( | ||
| '_register_theme_block_patterns', | ||
| sprintf( | ||
| /* translators: %1s: file name; %2s: slug value found. */ | ||
| __( 'Could not register file "%1$s" as a block pattern (invalid slug "%2$s")', 'gutenberg' ), | ||
| $file, | ||
| $pattern_data['slug'] | ||
| ), | ||
| '6.0.0' | ||
| ); | ||
| } | ||
|
|
||
| if ( WP_Block_Patterns_Registry::get_instance()->is_registered( $pattern_data['slug'] ) ) { | ||
| continue; | ||
| } | ||
|
|
||
| // Title is a required property. | ||
| if ( ! $pattern_data['title'] ) { | ||
| _doing_it_wrong( | ||
| '_register_theme_block_patterns', | ||
| sprintf( | ||
| /* translators: %1s: file name; %2s: slug value found. */ | ||
| __( 'Could not register file "%s" as a block pattern ("Title" field missing)', 'gutenberg' ), | ||
| $file | ||
| ), | ||
| '6.0.0' | ||
| ); | ||
| continue; | ||
| } | ||
|
|
||
| // For properties of type array, parse data as comma-separated. | ||
| foreach ( array( 'categories', 'keywords', 'blockTypes', 'postTypes' ) as $property ) { | ||
| if ( ! empty( $pattern_data[ $property ] ) ) { | ||
| $pattern_data[ $property ] = array_filter( | ||
| preg_split( | ||
| '/[\s,]+/', | ||
| (string) $pattern_data[ $property ] | ||
| ) | ||
| ); | ||
| } else { | ||
| unset( $pattern_data[ $property ] ); | ||
| } | ||
| } | ||
|
|
||
| // Parse properties of type int. | ||
| foreach ( array( 'viewportWidth' ) as $property ) { | ||
| if ( ! empty( $pattern_data[ $property ] ) ) { | ||
| $pattern_data[ $property ] = (int) $pattern_data[ $property ]; | ||
| } else { | ||
| unset( $pattern_data[ $property ] ); | ||
| } | ||
| } | ||
|
|
||
| // Parse properties of type bool. | ||
| foreach ( array( 'inserter' ) as $property ) { | ||
| if ( ! empty( $pattern_data[ $property ] ) ) { | ||
| $pattern_data[ $property ] = in_array( | ||
| strtolower( $pattern_data[ $property ] ), | ||
| array( 'yes', 'true' ), | ||
| true | ||
| ); | ||
| } else { | ||
| unset( $pattern_data[ $property ] ); | ||
| } | ||
| } | ||
|
|
||
| // Translate the pattern metadata. | ||
| $text_domain = $theme->get( 'TextDomain' ); | ||
| //phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.NonSingularStringLiteralContext, WordPress.WP.I18n.NonSingularStringLiteralDomain, WordPress.WP.I18n.LowLevelTranslationFunction | ||
| $pattern_data['title'] = translate_with_gettext_context( $pattern_data['title'], 'Pattern title', $text_domain ); | ||
| if ( ! empty( $pattern_data['description'] ) ) { | ||
| //phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.NonSingularStringLiteralContext, WordPress.WP.I18n.NonSingularStringLiteralDomain, WordPress.WP.I18n.LowLevelTranslationFunction | ||
| $pattern_data['description'] = translate_with_gettext_context( $pattern_data['description'], 'Pattern description', $text_domain ); | ||
| } | ||
|
|
||
| // The actual pattern content is the output of the file. | ||
| ob_start(); | ||
| include $file; | ||
| $pattern_data['content'] = ob_get_clean(); | ||
| if ( ! $pattern_data['content'] ) { | ||
| continue; | ||
| } | ||
|
|
||
| register_block_pattern( $pattern_data['slug'], $pattern_data ); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| remove_action( 'init', '_register_theme_block_patterns' ); | ||
| add_action( 'init', 'gutenberg_register_theme_block_patterns' ); |
Oops, something went wrong.