Add: Ability to use creation patterns for other post types besides page

docs/reference-guides/block-api/block-patterns.md

@@ -3,10 +3,16 @@
 Block Patterns are predefined block layouts, available from the patterns tab of the block inserter. Once inserted into content, the blocks are ready for additional or modified content and configuration.
 
 In this Document:
-* [`register_block_pattern`](#register_block_pattern)
-* [`unregister_block_pattern`](#unregister_block_pattern)
-* [`register_block_pattern_category`](#register_block_pattern_category)
-* [`unregister_block_pattern_category`](#unregister_block_pattern_category)
+- [Patterns](#patterns)
+	- [Block Patterns](#block-patterns)
+		- [register_block_pattern](#register_block_pattern)
+	- [Unregistering Block Patterns](#unregistering-block-patterns)
+		- [unregister_block_pattern](#unregister_block_pattern)
+	- [Block Pattern Categories](#block-pattern-categories)
+		- [register_block_pattern_category](#register_block_pattern_category)
+		- [unregister_block_pattern_category](#unregister_block_pattern_category)
+	- [Block patterns contextual to block types and pattern transformations](#block-patterns-contextual-to-block-types-and-pattern-transformations)
+	- [Semantic block patterns](#semantic-block-patterns)
 
 ## Block Patterns
 
@@ -27,6 +33,7 @@ The properties available for block patterns are:
 -   `keywords` (optional): An array of aliases or keywords that help users discover the pattern while searching.
 -   `viewportWidth` (optional): An integer specifying the intended width of the pattern to allow for a scaled preview of the pattern in the inserter.
 -   `blockTypes` (optional): An array of block types that the pattern is intended to be used with. Each value needs to be the declared block's `name`.
+-   `postTypes` (optional): An array of post types that the pattern is restricted to be used with. The pattern will only be available when editing one of the post types passed on the array, for all the other post types the pattern is not available at all.
 -   `inserter` (optional): By default, all patterns will appear in the inserter. To hide a pattern so that it can only be inserted programmatically, set the `inserter` to `false`.
 
 The following code sample registers a block pattern named 'my-plugin/my-awesome-pattern':

lib/compat/wordpress-6.0/block-patterns.php

@@ -44,168 +44,3 @@ function gutenberg_register_remote_theme_patterns() {
 		}
 	}
 }
-
-/**
- * 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)
- *   - Inserter         (yes/no)
- *
- * @since 6.0.0
- * @access private
- * @internal
- */
-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',
-		'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;
-		}
-		$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' ) 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 );
-			}
-		}
-	}
-}
-add_action( 'init', 'gutenberg_register_theme_block_patterns' );

lib/compat/wordpress-6.1/block-patterns.php

@@ -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' );