summaryrefslogtreecommitdiffstats
path: root/wp-includes/block-patterns.php
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:56:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:56:49 +0000
commita415c29efee45520ae252d2aa28f1083a521cd7b (patch)
treef4ade4b6668ecc0765de7e1424f7c1427ad433ff /wp-includes/block-patterns.php
parentInitial commit. (diff)
downloadwordpress-a415c29efee45520ae252d2aa28f1083a521cd7b.tar.xz
wordpress-a415c29efee45520ae252d2aa28f1083a521cd7b.zip
Adding upstream version 6.4.3+dfsg1.upstream/6.4.3+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'wp-includes/block-patterns.php')
-rw-r--r--wp-includes/block-patterns.php400
1 files changed, 400 insertions, 0 deletions
diff --git a/wp-includes/block-patterns.php b/wp-includes/block-patterns.php
new file mode 100644
index 0000000..66bdfd6
--- /dev/null
+++ b/wp-includes/block-patterns.php
@@ -0,0 +1,400 @@
+<?php
+/**
+ * Register the block patterns and block patterns categories
+ *
+ * @package WordPress
+ * @since 5.5.0
+ */
+
+add_theme_support( 'core-block-patterns' );
+
+/**
+ * Registers the core block patterns and categories.
+ *
+ * @since 5.5.0
+ * @since 6.3.0 Added source to core block patterns.
+ * @access private
+ */
+function _register_core_block_patterns_and_categories() {
+ $should_register_core_patterns = get_theme_support( 'core-block-patterns' );
+
+ if ( $should_register_core_patterns ) {
+ $core_block_patterns = array(
+ 'query-standard-posts',
+ 'query-medium-posts',
+ 'query-small-posts',
+ 'query-grid-posts',
+ 'query-large-title-posts',
+ 'query-offset-posts',
+ 'social-links-shared-background-color',
+ );
+
+ foreach ( $core_block_patterns as $core_block_pattern ) {
+ $pattern = require __DIR__ . '/block-patterns/' . $core_block_pattern . '.php';
+ $pattern['source'] = 'core';
+ register_block_pattern( 'core/' . $core_block_pattern, $pattern );
+ }
+ }
+
+ register_block_pattern_category( 'banner', array( 'label' => _x( 'Banners', 'Block pattern category' ) ) );
+ register_block_pattern_category(
+ 'buttons',
+ array(
+ 'label' => _x( 'Buttons', 'Block pattern category' ),
+ 'description' => __( 'Patterns that contain buttons and call to actions.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'columns',
+ array(
+ 'label' => _x( 'Columns', 'Block pattern category' ),
+ 'description' => __( 'Multi-column patterns with more complex layouts.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'text',
+ array(
+ 'label' => _x( 'Text', 'Block pattern category' ),
+ 'description' => __( 'Patterns containing mostly text.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'query',
+ array(
+ 'label' => _x( 'Posts', 'Block pattern category' ),
+ 'description' => __( 'Display your latest posts in lists, grids or other layouts.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'featured',
+ array(
+ 'label' => _x( 'Featured', 'Block pattern category' ),
+ 'description' => __( 'A set of high quality curated patterns.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'call-to-action',
+ array(
+ 'label' => _x( 'Call to Action', 'Block pattern category' ),
+ 'description' => __( 'Sections whose purpose is to trigger a specific action.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'team',
+ array(
+ 'label' => _x( 'Team', 'Block pattern category' ),
+ 'description' => __( 'A variety of designs to display your team members.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'testimonials',
+ array(
+ 'label' => _x( 'Testimonials', 'Block pattern category' ),
+ 'description' => __( 'Share reviews and feedback about your brand/business.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'services',
+ array(
+ 'label' => _x( 'Services', 'Block pattern category' ),
+ 'description' => __( 'Briefly describe what your business does and how you can help.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'contact',
+ array(
+ 'label' => _x( 'Contact', 'Block pattern category' ),
+ 'description' => __( 'Display your contact information.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'about',
+ array(
+ 'label' => _x( 'About', 'Block pattern category' ),
+ 'description' => __( 'Introduce yourself.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'portfolio',
+ array(
+ 'label' => _x( 'Portfolio', 'Block pattern category' ),
+ 'description' => __( 'Showcase your latest work.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'gallery',
+ array(
+ 'label' => _x( 'Gallery', 'Block pattern category' ),
+ 'description' => __( 'Different layouts for displaying images.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'media',
+ array(
+ 'label' => _x( 'Media', 'Block pattern category' ),
+ 'description' => __( 'Different layouts containing video or audio.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'posts',
+ array(
+ 'label' => _x( 'Posts', 'Block pattern category' ),
+ 'description' => __( 'Display your latest posts in lists, grids or other layouts.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'footer',
+ array(
+ 'label' => _x( 'Footers', 'Block pattern category' ),
+ 'description' => __( 'A variety of footer designs displaying information and site navigation.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'header',
+ array(
+ 'label' => _x( 'Headers', 'Block pattern category' ),
+ 'description' => __( 'A variety of header designs displaying your site title and navigation.' ),
+ )
+ );
+}
+
+/**
+ * Normalize the pattern properties to camelCase.
+ *
+ * The API's format is snake_case, `register_block_pattern()` expects camelCase.
+ *
+ * @since 6.2.0
+ * @access private
+ *
+ * @param array $pattern Pattern as returned from the Pattern Directory API.
+ * @return array Normalized pattern.
+ */
+function wp_normalize_remote_block_pattern( $pattern ) {
+ if ( isset( $pattern['block_types'] ) ) {
+ $pattern['blockTypes'] = $pattern['block_types'];
+ unset( $pattern['block_types'] );
+ }
+
+ if ( isset( $pattern['viewport_width'] ) ) {
+ $pattern['viewportWidth'] = $pattern['viewport_width'];
+ unset( $pattern['viewport_width'] );
+ }
+
+ return (array) $pattern;
+}
+
+/**
+ * Register Core's official patterns from wordpress.org/patterns.
+ *
+ * @since 5.8.0
+ * @since 5.9.0 The $current_screen argument was removed.
+ * @since 6.2.0 Normalize the pattern from the API (snake_case) to the
+ * format expected by `register_block_pattern` (camelCase).
+ * @since 6.3.0 Add 'pattern-directory/core' to the pattern's 'source'.
+ *
+ * @param WP_Screen $deprecated Unused. Formerly the screen that the current request was triggered from.
+ */
+function _load_remote_block_patterns( $deprecated = null ) {
+ if ( ! empty( $deprecated ) ) {
+ _deprecated_argument( __FUNCTION__, '5.9.0' );
+ $current_screen = $deprecated;
+ if ( ! $current_screen->is_block_editor ) {
+ return;
+ }
+ }
+
+ $supports_core_patterns = get_theme_support( 'core-block-patterns' );
+
+ /**
+ * Filter to disable remote block patterns.
+ *
+ * @since 5.8.0
+ *
+ * @param bool $should_load_remote
+ */
+ $should_load_remote = apply_filters( 'should_load_remote_block_patterns', true );
+
+ if ( $supports_core_patterns && $should_load_remote ) {
+ $request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
+ $core_keyword_id = 11; // 11 is the ID for "core".
+ $request->set_param( 'keyword', $core_keyword_id );
+ $response = rest_do_request( $request );
+ if ( $response->is_error() ) {
+ return;
+ }
+ $patterns = $response->get_data();
+
+ foreach ( $patterns as $pattern ) {
+ $pattern['source'] = 'pattern-directory/core';
+ $normalized_pattern = wp_normalize_remote_block_pattern( $pattern );
+ $pattern_name = 'core/' . sanitize_title( $normalized_pattern['title'] );
+ register_block_pattern( $pattern_name, $normalized_pattern );
+ }
+ }
+}
+
+/**
+ * Register `Featured` (category) patterns from wordpress.org/patterns.
+ *
+ * @since 5.9.0
+ * @since 6.2.0 Normalized the pattern from the API (snake_case) to the
+ * format expected by `register_block_pattern()` (camelCase).
+ * @since 6.3.0 Add 'pattern-directory/featured' to the pattern's 'source'.
+ */
+function _load_remote_featured_patterns() {
+ $supports_core_patterns = get_theme_support( 'core-block-patterns' );
+
+ /** This filter is documented in wp-includes/block-patterns.php */
+ $should_load_remote = apply_filters( 'should_load_remote_block_patterns', true );
+
+ if ( ! $should_load_remote || ! $supports_core_patterns ) {
+ return;
+ }
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
+ $featured_cat_id = 26; // This is the `Featured` category id from pattern directory.
+ $request->set_param( 'category', $featured_cat_id );
+ $response = rest_do_request( $request );
+ if ( $response->is_error() ) {
+ return;
+ }
+ $patterns = $response->get_data();
+ $registry = WP_Block_Patterns_Registry::get_instance();
+ foreach ( $patterns as $pattern ) {
+ $pattern['source'] = 'pattern-directory/featured';
+ $normalized_pattern = wp_normalize_remote_block_pattern( $pattern );
+ $pattern_name = sanitize_title( $normalized_pattern['title'] );
+ // Some patterns might be already registered as core patterns with the `core` prefix.
+ $is_registered = $registry->is_registered( $pattern_name ) || $registry->is_registered( "core/$pattern_name" );
+ if ( ! $is_registered ) {
+ register_block_pattern( $pattern_name, $normalized_pattern );
+ }
+ }
+}
+
+/**
+ * Registers patterns from Pattern Directory provided by a theme's
+ * `theme.json` file.
+ *
+ * @since 6.0.0
+ * @since 6.2.0 Normalized the pattern from the API (snake_case) to the
+ * format expected by `register_block_pattern()` (camelCase).
+ * @since 6.3.0 Add 'pattern-directory/theme' to the pattern's 'source'.
+ * @access private
+ */
+function _register_remote_theme_patterns() {
+ /** This filter is documented in wp-includes/block-patterns.php */
+ if ( ! apply_filters( 'should_load_remote_block_patterns', true ) ) {
+ return;
+ }
+
+ if ( ! wp_theme_has_theme_json() ) {
+ return;
+ }
+
+ $pattern_settings = wp_get_theme_directory_pattern_slugs();
+ if ( empty( $pattern_settings ) ) {
+ return;
+ }
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
+ $request['slug'] = $pattern_settings;
+ $response = rest_do_request( $request );
+ if ( $response->is_error() ) {
+ return;
+ }
+ $patterns = $response->get_data();
+ $patterns_registry = WP_Block_Patterns_Registry::get_instance();
+ foreach ( $patterns as $pattern ) {
+ $pattern['source'] = 'pattern-directory/theme';
+ $normalized_pattern = wp_normalize_remote_block_pattern( $pattern );
+ $pattern_name = sanitize_title( $normalized_pattern['title'] );
+ // Some patterns might be already registered as core patterns with the `core` prefix.
+ $is_registered = $patterns_registry->is_registered( $pattern_name ) || $patterns_registry->is_registered( "core/$pattern_name" );
+ if ( ! $is_registered ) {
+ register_block_pattern( $pattern_name, $normalized_pattern );
+ }
+ }
+}
+
+/**
+ * Register any patterns that the active theme may provide under its
+ * `./patterns/` directory.
+ *
+ * @since 6.0.0
+ * @since 6.1.0 The `postTypes` property was added.
+ * @since 6.2.0 The `templateTypes` property was added.
+ * @since 6.4.0 Uses the `WP_Theme::get_block_patterns` method.
+ * @access private
+ */
+function _register_theme_block_patterns() {
+
+ /*
+ * During the bootstrap process, a check for active and valid themes is run.
+ * If no themes are returned, the theme's functions.php file will not be loaded,
+ * which can lead to errors if patterns expect some variables or constants to
+ * already be set at this point, so bail early if that is the case.
+ */
+ if ( empty( wp_get_active_and_valid_themes() ) ) {
+ return;
+ }
+
+ /*
+ * 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();
+ $theme = wp_get_theme();
+ $themes[] = $theme;
+ if ( $theme->parent() ) {
+ $themes[] = $theme->parent();
+ }
+ $registry = WP_Block_Patterns_Registry::get_instance();
+
+ foreach ( $themes as $theme ) {
+ $patterns = $theme->get_block_patterns();
+ $dirpath = $theme->get_stylesheet_directory() . '/patterns/';
+ $text_domain = $theme->get( 'TextDomain' );
+
+ foreach ( $patterns as $file => $pattern_data ) {
+ if ( $registry->is_registered( $pattern_data['slug'] ) ) {
+ continue;
+ }
+
+ $file_path = $dirpath . $file;
+
+ if ( ! file_exists( $file_path ) ) {
+ _doing_it_wrong(
+ __FUNCTION__,
+ sprintf(
+ /* translators: %s: file name. */
+ __( 'Could not register file "%s" as a block pattern as the file does not exist.' ),
+ $file
+ ),
+ '6.4.0'
+ );
+ $theme->delete_pattern_cache();
+ continue;
+ }
+
+ // The actual pattern content is the output of the file.
+ ob_start();
+ include $file_path;
+ $pattern_data['content'] = ob_get_clean();
+ if ( ! $pattern_data['content'] ) {
+ continue;
+ }
+
+ // Translate the pattern metadata.
+ // phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText,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.NonSingularStringLiteralDomain,WordPress.WP.I18n.LowLevelTranslationFunction
+ $pattern_data['description'] = translate_with_gettext_context( $pattern_data['description'], 'Pattern description', $text_domain );
+ }
+
+ register_block_pattern( $pattern_data['slug'], $pattern_data );
+ }
+ }
+}
+add_action( 'init', '_register_theme_block_patterns' );