Skip to content
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.

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

Docs: Update references to register_block_type_from_metadata #32582

Merged
merged 1 commit into from
Jun 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 10 additions & 8 deletions docs/reference-guides/block-api/block-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ The same file is also used when [submitting block to Block Directory](/docs/gett

## Server-side registration

There is also [`register_block_type_from_metadata`](https://developer.wordpress.org/reference/functions/register_block_type_from_metadata/) function that aims to simplify the block type registration on the server from metadata stored in the `block.json` file.
The [`register_block_type`](https://developer.wordpress.org/reference/functions/register_block_type/) function that aims to simplify the block type registration on the server, can read metadata stored in the `block.json` file.

This function takes two params:
This function takes two params relevant in this context (`$block_type` accepts more types and variants):

- `$path` (`string`) – path to the folder where the `block.json` file is located or full path to the metadata file if named differently.
- `$block_type` (`string`) – path to the folder where the `block.json` file is located or full path to the metadata file if named differently.
- `$args` (`array`) – an optional array of block type arguments. Default value: `[]`. Any arguments may be defined. However, the one described below is supported by default:
- `$render_callback` (`callable`) – callback used to render blocks of this block type.

Expand All @@ -67,7 +67,7 @@ It returns the registered block type (`WP_Block_Type`) on success or `false` on
**Example:**

```php
register_block_type_from_metadata(
register_block_type(
__DIR__ . '/notice',
array(
'render_callback' => 'render_block_core_notice',
Expand Down Expand Up @@ -453,9 +453,9 @@ WordPress string discovery system can automatically translate fields marked in t

### PHP

In PHP, localized properties will be automatically wrapped in `_x` function calls on the backend of WordPress when executing `register_block_type_from_metadata`. These translations get added as an inline script to the plugin's script handle or to the `wp-block-library` script handle in WordPress core.
In PHP, localized properties will be automatically wrapped in `_x` function calls on the backend of WordPress when executing `register_block_type`. These translations get added as an inline script to the plugin's script handle or to the `wp-block-library` script handle in WordPress core.

The way `register_block_type_from_metadata` processes translatable values is roughly equivalent to the following code snippet:
The way `register_block_type` processes translatable values is roughly equivalent to the following code snippet:

```php
<?php
Expand Down Expand Up @@ -503,7 +503,9 @@ The following properties are going to be supported for backward compatibility re
**Example**:

```js
wp.blocks.registerBlockType( 'my-block/name', {
import { registerBlockType } from '@wordpress/blocks';

registerBlockType( 'my-plugin/block-name', {
edit: function () {
// Edit definition goes here.
},
Expand All @@ -516,4 +518,4 @@ wp.blocks.registerBlockType( 'my-block/name', {
} );
```

In the case of [dynamic blocks](/docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md) supported by WordPress, it should be still possible to register `render_callback` property using both [`register_block_type`](https://developer.wordpress.org/reference/functions/register_block_type/) and `register_block_type_from_metadata` functions on the server.
In the case of [dynamic blocks](/docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md) supported by WordPress, it should be still possible to register `render_callback` property using both [`register_block_type`](https://developer.wordpress.org/reference/functions/register_block_type/) function on the server.
2 changes: 1 addition & 1 deletion packages/block-library/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ function render_my_block() {
}

function register_block_my_block() {
register_block_type_from_metadata(
register_block_type(
__DIR__ . '/block-name',
array(
'render_callback' => 'render_my_block',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ import {
} from '@wordpress/icons';

// FALLBACK: this is only used when the server does not understand the variations property in the
// register_block_type_from_metadata call. see navigation-link/index.php.
// register_block_type call. see navigation-link/index.php.
// Delete this file when supported WP ranges understand the `variations` property when passed to
// register_block_type_from_metadata in index.php
// register_block_type in index.php
const fallbackVariations = [
{
name: 'link',
Expand Down
2 changes: 1 addition & 1 deletion packages/block-library/src/navigation-link/hooks.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export function enhanceNavigationLinkVariations( settings, name ) {
}

// Fallback handling may be deleted after supported WP ranges understand the `variations`
// property when passed to register_block_type_from_metadata in index.php
// property when passed to register_block_type in index.php
if ( ! settings.variations ) {
return {
...settings,
Expand Down