Skip to content

Pattern Overrides: Remove obsolete documentation #74749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ockham merged 1 commit into from
Jan 20, 2026
Merged

Pattern Overrides: Remove obsolete documentation #74749

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 0 additions & 73 deletions docs/reference-guides/block-api/block-bindings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,79 +251,6 @@ add_filter(

This filter also affects which blocks and attributes are available for Pattern Overrides, as both features share the same underlying supported attributes configuration.

### Accessing Pattern Override values in dynamic blocks

When creating a dynamic block that supports Pattern Overrides, you can access the override values within your `render_callback` function. The Pattern block (`core/block`) provides override values to nested blocks via the `pattern/overrides` context.

**Step 1: Register your block with the required context and supported attributes**

```php
add_action( 'init', function() {
// Register supported attributes for pattern overrides
add_filter(
'block_bindings_supported_attributes_my-plugin/my-block',
function ( $supported_attributes ) {
$supported_attributes[] = 'title';
$supported_attributes[] = 'description';
return $supported_attributes;
}
);

register_block_type( 'my-plugin/my-block', array(
'attributes' => array(
'title' => array( 'type' => 'string', 'default' => '' ),
'description' => array( 'type' => 'string', 'default' => '' ),
'metadata' => array( 'type' => 'object' ),
),
// Declare that you need the pattern/overrides context
'uses_context' => array( 'pattern/overrides' ),
'render_callback' => 'my_block_render_callback',
) );
} );
```

**Step 2: Access override values in your render callback**

The override values are stored in `$block->context['pattern/overrides']` as an associative array. The keys are block metadata names (assigned when enabling overrides), and the values are arrays of attribute overrides.

```php
function my_block_render_callback( $attributes, $content, $block ) {
// Get the block's metadata name (set when enabling overrides)
$block_name = $attributes['metadata']['name'] ?? null;

// Get the pattern overrides from context
$overrides = array();
if ( $block_name && isset( $block->context['pattern/overrides'][ $block_name ] ) ) {
$overrides = $block->context['pattern/overrides'][ $block_name ];
}

// Get attribute values, preferring overrides when available
// Note: An empty string in overrides means "reset to default"
$title = $attributes['title'];
if ( isset( $overrides['title'] ) && $overrides['title'] !== '' ) {
$title = $overrides['title'];
}

$description = $attributes['description'];
if ( isset( $overrides['description'] ) && $overrides['description'] !== '' ) {
$description = $overrides['description'];
}

return sprintf(
'<div class="my-block"><h3>%s</h3><p>%s</p></div>',
esc_html( $title ),
esc_html( $description )
);
}
```

**Key points to keep in mind:**

- **`uses_context`**: Your block must declare `pattern/overrides` in its `uses_context` to receive override data from parent Pattern blocks.
- **Block metadata name**: Each overridable block instance has a unique name stored in `$attributes['metadata']['name']`. This name is assigned when the user enables overrides on the block in the editor.
- **Empty string convention**: An empty string (`""`) in the overrides represents a reset to the default value. Your code should handle this appropriately.
- **Fallback behavior**: Always provide fallback values from `$attributes` in case the block is not inside a pattern or overrides are not set.

## Registering a custom source

Registering a source requires defining at least `name`, a `label` and a `callback` function that gets a value from the source and passes it back to a block attribute.
Expand Down
Loading