Skip to content

Handbook: Clarify the type of apiVersion in block metadata #33249

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
gziolo merged 1 commit into from
Jul 7, 2021
Merged

Handbook: Clarify the type of apiVersion in block metadata #33249

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
16 changes: 16 additions & 0 deletions docs/reference-guides/block-api/block-metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,22 @@ register_block_type(

This section describes all the properties that can be added to the `block.json` file to define the behavior and metadata of block types.

### API Version

- Type: `number`
- Optional
- Localized: No
- Property: `apiVersion`
- Default: `1`

```json
{ "apiVersion": 2 }
```

The version of the Block API used by the block. The most recent version is `2` and it was introduced in WordPress 5.6.

See the [the API versions documentation](/docs/reference-guides/block-api/block-api-versions.md) for more details.

### Name

- Type: `string`
Expand Down