<?php /** * Overrides Core's wp-includes/block-patterns.php to add category descriptions for WP 6.2. * * @package gutenberg */ /** * Registers the block pattern categories. */ function gutenberg_register_core_block_patterns_categories() { register_block_pattern_category( 'banner', array( 'label' => _x( 'Banners', 'Block pattern category', 'gutenberg' ), ) ); register_block_pattern_category( 'buttons', array( 'label' => _x( 'Buttons', 'Block pattern category', 'gutenberg' ), 'description' => __( 'Patterns that contain buttons and call to actions.', 'gutenberg' ), ) ); register_block_pattern_category( 'columns', array( 'label' => _x( 'Columns', 'Block pattern category', 'gutenberg' ), 'description' => __( 'Multi-column patterns with more complex layouts.', 'gutenberg' ), ) ); register_block_pattern_category( 'text', array( 'label' => _x( 'Text', 'Block pattern category', 'gutenberg' ), 'description' => __( 'Patterns containing mostly text.', 'gutenberg' ), ) ); register_block_pattern_category( 'query', array( 'label' => _x( 'Posts', 'Block pattern category', 'gutenberg' ), 'description' => __( 'Display your latest posts in lists, grids or other layouts.', 'gutenberg' ), ) ); register_block_pattern_category( 'featured', array( 'label' => _x( 'Featured', 'Block pattern category', 'gutenberg' ), 'description' => __( 'A set of high quality curated patterns.', 'gutenberg' ), ) ); // Register new core block pattern categories. register_block_pattern_category( 'call-to-action', array( 'label' => _x( 'Call to Action', 'Block pattern category', 'gutenberg' ), 'description' => __( 'Sections whose purpose is to trigger a specific action.', 'gutenberg' ), ) ); register_block_pattern_category( 'team', array( 'label' => _x( 'Team', 'Block pattern category', 'gutenberg' ), 'description' => __( 'A variety of designs to display your team members.', 'gutenberg' ), ) ); register_block_pattern_category( 'testimonials', array( 'label' => _x( 'Testimonials', 'Block pattern category', 'gutenberg' ), 'description' => __( 'Share reviews and feedback about your brand/business.', 'gutenberg' ), ) ); register_block_pattern_category( 'services', array( 'label' => _x( 'Services', 'Block pattern category', 'gutenberg' ), 'description' => __( 'Briefly describe what your business does and how you can help.', 'gutenberg' ), ) ); register_block_pattern_category( 'contact', array( 'label' => _x( 'Contact', 'Block pattern category', 'gutenberg' ), 'description' => __( 'Display your contact information.', 'gutenberg' ), ) ); register_block_pattern_category( 'about', array( 'label' => _x( 'About', 'Block pattern category', 'gutenberg' ), 'description' => __( 'Introduce yourself.', 'gutenberg' ), ) ); register_block_pattern_category( 'portfolio', array( 'label' => _x( 'Portfolio', 'Block pattern category', 'gutenberg' ), 'description' => __( 'Showcase your latest work.', 'gutenberg' ), ) ); register_block_pattern_category( 'gallery', array( 'label' => _x( 'Gallery', 'Block pattern category', 'gutenberg' ), 'description' => __( 'Different layouts for displaying images.', 'gutenberg' ), ) ); register_block_pattern_category( 'media', array( 'label' => _x( 'Media', 'Block pattern category', 'gutenberg' ), 'description' => __( 'Different layouts containing video or audio.', 'gutenberg' ), ) ); register_block_pattern_category( 'posts', array( 'label' => _x( 'Posts', 'Block pattern category', 'gutenberg' ), 'description' => __( 'Display your latest posts in lists, grids or other layouts.', 'gutenberg' ), ) ); // Site building pattern categories. register_block_pattern_category( 'footer', array( 'label' => _x( 'Footers', 'Block pattern category', 'gutenberg' ), 'description' => __( 'A variety of footer designs displaying information and site navigation.', 'gutenberg' ), ) ); register_block_pattern_category( 'header', array( 'label' => _x( 'Headers', 'Block pattern category', 'gutenberg' ), 'description' => __( 'A variety of header designs displaying your site title and navigation.', 'gutenberg' ), ) ); } add_action( 'init', 'gutenberg_register_core_block_patterns_categories' ); /** * 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', 'templateTypes' => 'Template Types', ); /* * 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(); $wp_theme = wp_get_theme(); if ( $wp_theme->parent() ) { $themes[] = $wp_theme->parent(); } $themes[] = $wp_theme; 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', 'templateTypes' ) 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' ); /** * Normalize the pattern from the API (snake_case) to the format expected by `register_block_pattern` (camelCase). * * @since 6.2.0 * * @param array $pattern Pattern as returned from the Pattern Directory API. */ function gutenberg_normalize_remote_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; }