register_block_type_from_metadata

（5.5.0以降）
register_block_type_from_metadata - block.jsonファイルからブロックタイプを登録する

説明

WP_Block_Type | false register_block_type_from_metadata( string $file_or_folder [ , array $args = array() ] )
block.jsonファイルからブロックタイプを登録する。

パラメータ

  • $file_or_folder
    block.jsonファイルかそのディレクトリのパス名を指定。
  • $args
    ブロック定義を格納した連想配列を指定（省略時はarray()）。以下は連想配列キーの抜粋。
    キー内容
    render_callbackサーバーサイドでブロックをレンダリングするコールバック関数
    textdomain[5.7.0]サポート
    variations[5.9.0]サポート
    viewScript[5.9.0]サポート
    render[6.1.0]サポート。サーバーサイドでブロックをレンダリングするコールバック関数のPHPファイルの相対パス名
    selectors[6.3.0]サポート
    blockHooks[6.4.0]サポート
    allowedBlocks[6.5.0]サポート
    viewScriptModule[6.5.0]サポート
    viewStyle[6.5.0]サポート

返り値

ブロックタイプを登録できた場合はそのWP_Block_Typeオブジェクトを返す。登録できなかった場合はfalseを返す。

注意

ブロック定義を記載したblock.jsonファイルを読み込み、ブロックタイプを登録する。ブロックタイプの諸設定はパラメータ$argsにより、キー単位で上書きできる。

[5.8.0]本関数は register_block_typeから呼び出されるようになった。

バージョンによりパラメータ$argsがサポートするキーが変わっている。

使用例

  • block.jsonファイルからブロックタイプを登録する
    register_block_type_from_metadata( $block_path, $attr );

フィルター

[5.7.0]block.jsonファイルの読み込み後'block_type_metadata'フィルターを呼び出す。パラメータ$metadataにはblock.jsonファイルをデコードした連想配列（キー'file'にはblock.jsonファイルのパス名追加済み）が格納されている。 
$metadata = apply_filters( 'block_type_metadata', $metadata );
[5.7.0]ブロックタイプを登録する前に'block_type_metadata_settings'フィルターを呼び出す。パラメータ$settingsにはブロックタイプの設定内容を示す連想配列が、$metadataにはblock.jsonファイルをデコードした連想配列が格納されている。 
$settings = apply_filters( 'block_type_metadata_settings', $settings, $metadata );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/blocks.php

最終更新 : 2024年05月17日 11:58

関連

参考

Code Reference: register_block_type_from_metadata

お勧め

個人データのエクスポートメール向けに追加された新フィルター（2020年4月2日 更新）

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群（2018年5月27日 更新）

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで（2011年7月14日 更新）

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる！？（2020年2月25日 更新）

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。