wp-block-patterns

name	wp-block-patterns
description	Create, register, and organize WordPress block patterns. File-based patterns, PHP registration, categories, and synced patterns.
compatibility	WordPress 6.0+ for file-based patterns. WordPress 6.3+ for pattern overrides.

WordPress Block Patterns

When to Use

Use this skill when:

• Creating reusable block layouts for themes
• Building a pattern library
• Registering patterns programmatically
• Working with synced (reusable) patterns
• Setting up pattern categories

Pattern Basics

Block patterns are pre-designed block layouts users can insert with one click. Two types:

1. Unsynced patterns - Independent copies inserted each time
2. Synced patterns - Global patterns that update everywhere when changed

File-Based Patterns (Recommended)

Since WordPress 6.0, create patterns by placing PHP files in your theme's /patterns/ directory.

Directory Structure

your-theme/
├── patterns/
│   ├── hero-section.php
│   ├── pricing-table.php
│   ├── testimonial-grid.php
│   ├── call-to-action.php
│   └── team-members.php
├── style.css
└── theme.json

Pattern File Template

<?php
/**
 * Title: Hero Section
 * Slug: theme-name/hero-section
 * Categories: featured, banner
 * Keywords: hero, banner, header, intro
 * Description: A full-width hero section with heading, text, and buttons.
 * Viewport Width: 1400
 * Block Types: core/post-content
 * Post Types: page, post
 * Inserter: true
 */
?>
<!-- wp:cover {"url":"<?php echo esc_url( get_template_directory_uri() ); ?>/assets/images/hero-bg.jpg","dimRatio":60,"overlayColor":"black","minHeight":600,"align":"full"} -->
<div class="wp-block-cover alignfull" style="min-height:600px">
  <span aria-hidden="true" class="wp-block-cover__background has-black-background-color has-background-dim-60 has-background-dim"></span>
  <div class="wp-block-cover__inner-container">
    <!-- wp:heading {"textAlign":"center","level":1} -->
    <h1 class="wp-block-heading has-text-align-center">Welcome to Our Site</h1>
    <!-- /wp:heading -->
    <!-- wp:paragraph {"align":"center"} -->
    <p class="has-text-align-center">Your compelling tagline goes here.</p>
    <!-- /wp:paragraph -->
    <!-- wp:buttons {"layout":{"type":"flex","justifyContent":"center"}} -->
    <div class="wp-block-buttons">
      <!-- wp:button -->
      <div class="wp-block-button"><a class="wp-block-button__link wp-element-button">Get Started</a></div>
      <!-- /wp:button -->
    </div>
    <!-- /wp:buttons -->
  </div>
</div>
<!-- /wp:cover -->

Required Headers

Header	Required	Description
Title	Yes	Display name in pattern inserter
Slug	Yes	Unique identifier (namespace/pattern-name)

Optional Headers

Header	Description	Example
Categories	Comma-separated categories	featured, hero, banner
Keywords	Search terms	hero, header, intro, welcome
Description	Longer description for accessibility	Full-width hero with...
Viewport Width	Preview width in inserter	1400
Block Types	Show in block transforms	core/post-content, core/group
Post Types	Limit to specific post types	page, post, product
Inserter	Show in inserter	true or false
Template Types	For template patterns	front-page, single

PHP Registration Method

For plugins or dynamic patterns:

function my_register_patterns() {
    register_block_pattern(
        'my-plugin/hero-section',
        array(
            'title'       => __( 'Hero Section', 'my-plugin' ),
            'description' => __( 'A full-width hero with heading and CTA', 'my-plugin' ),
            'categories'  => array( 'featured', 'banner' ),
            'keywords'    => array( 'hero', 'header', 'intro' ),
            'content'     => '<!-- wp:cover {"dimRatio":50} -->...',
            'blockTypes'  => array( 'core/post-content' ),
            'postTypes'   => array( 'page' ),
            'inserter'    => true,
        )
    );
}
add_action( 'init', 'my_register_patterns' );

Loading Content from File

function my_register_patterns() {
    $patterns = array(
        'hero-section',
        'pricing-table',
        'testimonials',
    );

    foreach ( $patterns as $pattern ) {
        $file = plugin_dir_path( __FILE__ ) . "patterns/{$pattern}.html";

        if ( file_exists( $file ) ) {
            register_block_pattern(
                "my-plugin/{$pattern}",
                array(
                    'title'      => ucwords( str_replace( '-', ' ', $pattern ) ),
                    'categories' => array( 'my-plugin-patterns' ),
                    'content'    => file_get_contents( $file ),
                )
            );
        }
    }
}
add_action( 'init', 'my_register_patterns' );

Pattern Categories

Register Custom Category

function my_register_pattern_categories() {
    register_block_pattern_category(
        'my-theme-sections',
        array(
            'label'       => __( 'Theme Sections', 'my-theme' ),
            'description' => __( 'Pre-designed sections for building pages', 'my-theme' ),
        )
    );
}
add_action( 'init', 'my_register_pattern_categories' );

Core Categories

WordPress includes these default categories:

Slug	Label
featured	Featured
text	Text
gallery	Gallery
banner	Banners
header	Headers
footer	Footers
call-to-action	Call to Action
team	Team
testimonials	Testimonials
pricing	Pricing
contact	Contact
about	About
portfolio	Portfolio
services	Services

Unregister Core Categories

function my_unregister_pattern_categories() {
    unregister_block_pattern_category( 'buttons' );
}
add_action( 'init', 'my_unregister_pattern_categories' );

Using Patterns in Templates

In Block Templates (HTML)

<!-- wp:pattern {"slug":"theme-name/hero-section"} /-->

This inserts the pattern content directly (not a reference).

In PHP Templates

<?php echo do_blocks( '<!-- wp:pattern {"slug":"theme-name/hero-section"} /-->' ); ?>

In Block Templates (array format)

$template = array(
    array( 'core/pattern', array( 'slug' => 'theme-name/hero-section' ) ),
    array( 'core/paragraph', array( 'placeholder' => 'Add content...' ) ),
);

Synced Patterns (Reusable Blocks)

Creating Synced Patterns

Users create these from the editor:

1. Select blocks
2. Click "Create pattern"
3. Choose "Synced"

Programmatic Synced Pattern

$pattern_id = wp_insert_post( array(
    'post_type'    => 'wp_block',
    'post_title'   => 'Global CTA',
    'post_content' => '<!-- wp:group -->...',
    'post_status'  => 'publish',
) );

// Add to pattern category
wp_set_object_terms( $pattern_id, 'my-category', 'wp_pattern_category' );

Querying Synced Patterns

$patterns = get_posts( array(
    'post_type'      => 'wp_block',
    'posts_per_page' => -1,
    'post_status'    => 'publish',
) );

foreach ( $patterns as $pattern ) {
    echo $pattern->post_title . ': ' . $pattern->ID . "\n";
}

Pattern Content Best Practices

1. Wrap in Container

Always wrap patterns in a Group or similar container:

<!-- wp:group {"align":"full","layout":{"type":"constrained"}} -->
<div class="wp-block-group alignfull">
  <!-- Pattern content -->
</div>
<!-- /wp:group -->

2. Use Theme Assets

Reference theme assets properly:

<!-- wp:image {"id":0,"sizeSlug":"full"} -->
<figure class="wp-block-image size-full">
  <img src="<?php echo esc_url( get_template_directory_uri() ); ?>/assets/images/placeholder.jpg" alt=""/>
</figure>
<!-- /wp:image -->

3. Translatable Strings

Use translation functions for text:

<!-- wp:heading -->
<h2 class="wp-block-heading"><?php esc_html_e( 'Our Services', 'theme-name' ); ?></h2>
<!-- /wp:heading -->

4. Placeholder Images

Use placeholder images for demo content:

<?php
$placeholder = 'https://images.unsplash.com/photo-placeholder?w=1200&h=600';
// Or use theme asset
$placeholder = get_template_directory_uri() . '/assets/images/placeholder.jpg';
?>
<!-- wp:image {"sizeSlug":"full"} -->
<figure class="wp-block-image size-full">
  <img src="<?php echo esc_url( $placeholder ); ?>" alt="<?php esc_attr_e( 'Placeholder image', 'theme-name' ); ?>"/>
</figure>
<!-- /wp:image -->

5. Use Theme Presets

Reference theme.json presets instead of hardcoded values:

<!-- Good: Uses preset -->
<!-- wp:group {"backgroundColor":"primary","textColor":"white"} -->

<!-- Avoid: Hardcoded values -->
<!-- wp:group {"style":{"color":{"background":"#0073aa","text":"#ffffff"}}} -->

Pattern Variations

Contextual Patterns

Show patterns for specific blocks using Block Types:

<?php
/**
 * Title: Button Group
 * Slug: theme/button-group
 * Block Types: core/buttons
 */
?>
<!-- wp:buttons {"layout":{"type":"flex"}} -->
...
<!-- /wp:buttons -->

This pattern appears when transforming or replacing a Buttons block.

Page-Level Patterns

For full page layouts:

<?php
/**
 * Title: About Page
 * Slug: theme/page-about
 * Categories: page
 * Block Types: core/post-content
 * Post Types: page
 */
?>
<!-- wp:group {"align":"full"} -->
  <!-- Full page layout -->
<!-- /wp:group -->

Content Locking

Template Lock

Prevent editing pattern structure:

<!-- wp:group {"templateLock":"all"} -->
<!-- Locked content - no adding/removing blocks -->
<!-- /wp:group -->

<!-- wp:group {"templateLock":"insert"} -->
<!-- Can modify but not add new blocks -->
<!-- /wp:group -->

<!-- wp:group {"templateLock":"contentOnly"} -->
<!-- Only text/content editable, not structure -->
<!-- /wp:group -->

Content-Only Editing (6.1+)

Mark specific content as editable:

<!-- wp:group {"templateLock":"contentOnly"} -->
<div class="wp-block-group">
  <!-- wp:heading -->
  <h2 class="wp-block-heading">Edit This Title</h2>
  <!-- /wp:heading -->
  <!-- wp:paragraph -->
  <p>And this paragraph.</p>
  <!-- /wp:paragraph -->
</div>
<!-- /wp:group -->

In block.json, mark editable attributes:

{
  "attributes": {
    "content": {
      "type": "string",
      "__experimentalRole": "content"
    }
  }
}

Pattern Overrides (6.3+)

Allow specific block content to be unique per instance:

<!-- wp:group {"metadata":{"name":"Card","patternName":"theme/card"}} -->
<div class="wp-block-group">
  <!-- wp:heading {"metadata":{"bindings":{"content":{"source":"pattern_overrides"}}}} -->
  <h2>Default Title</h2>
  <!-- /wp:heading -->
  <!-- wp:paragraph {"metadata":{"bindings":{"content":{"source":"pattern_overrides"}}}} -->
  <p>Default description text.</p>
  <!-- /wp:paragraph -->
</div>
<!-- /wp:group -->

Hiding Core Patterns

Unregister Specific Pattern

function my_unregister_patterns() {
    unregister_block_pattern( 'core/query-standard-posts' );
}
add_action( 'init', 'my_unregister_patterns', 20 );

Hide All Core Patterns

In theme.json:

{
  "version": 3,
  "settings": {
    "blocks": {
      "core/query": {
        "patterns": []
      }
    }
  }
}

Disable Remote Patterns

Prevent loading from WordPress.org Pattern Directory:

add_filter( 'should_load_remote_block_patterns', '__return_false' );

Complete Pattern Example

Testimonial Section Pattern

patterns/testimonials.php:

<?php
/**
 * Title: Testimonials
 * Slug: theme-name/testimonials
 * Categories: testimonials, featured
 * Keywords: testimonial, review, quote, customer
 * Description: A grid of customer testimonials with photos and quotes.
 * Viewport Width: 1400
 * Block Types: core/post-content
 */

$testimonials = array(
    array(
        'name'    => 'Sarah Johnson',
        'role'    => 'CEO, TechStart',
        'quote'   => 'This product transformed our workflow completely.',
        'image'   => get_template_directory_uri() . '/assets/images/avatar-1.jpg',
    ),
    array(
        'name'    => 'Michael Chen',
        'role'    => 'Developer, AppCo',
        'quote'   => 'The best tool we\'ve used for our team.',
        'image'   => get_template_directory_uri() . '/assets/images/avatar-2.jpg',
    ),
    array(
        'name'    => 'Emily Davis',
        'role'    => 'Designer, CreativeLab',
        'quote'   => 'Intuitive and powerful. Highly recommended.',
        'image'   => get_template_directory_uri() . '/assets/images/avatar-3.jpg',
    ),
);
?>
<!-- wp:group {"align":"full","style":{"spacing":{"padding":{"top":"5rem",:}}},:,:{:,:}} -->
<div {:} -->
  <h2 {:{:{:{:}}}} -->
  <div {:{:{:{:,:,:,:}},:{:}},:} -->
      <div {:{:{:}}} -->
        <p style=></p>
        <!-- /wp:paragraph -->
        <!-- wp:group {:{:,:}} -->
        <div {:,:,:,:,:{:{:}}} -->
          <figure {:{:{:},:{:{:}}}} -->
            <p style=>  ( [] ); </p>
            <!-- /wp:paragraph -->
            <!-- wp:paragraph {:{:{:},:{:}}} -->
            <p 

Resources

• Block Patterns Documentation
• Theme Patterns Guide
• WordPress Pattern Directory
• 10up Patterns Best Practices