register_block_type

説明

WP_Block_Type|bool register_block_type( string|WP_Block_Type $name [ , array $args = array() ] )
ブロックタイプを登録する。

パラメータ

  • $name
    ブロックタイプ名またはブロックタイプを指定。[5.8.0]block.jsonファイルまたはそのディレクトリのパス名も指定可能。
  • $args
    ブロックタイプのプロパティを連想配列で指定(省略時はarray())。

返り値

ブロックタイプが登録できた場合はそのブロックタイプ(オブジェクト)を返す。それ以外はfalseを返す。


注意

パラメータ$argsに指定する主なプロパティは次の通り。

キー内容
'render_callback'コールバック関数
'attributes'任意の属性値を格納した連想配列
'editor_script'JavaScriptのハンドル名

[5.8.0]パラメータ$nameへblock.jsonファイルパス名またはそのディレクトリのパス名を指定できるようになりました。


使用例

  • ブロックタイプを登録する。
    <?php
    wp_register_script(
    	'script-handle',
    	plugins_url( 'assets/js/step.js', __FILE__ ),
    	array( 'wp-blocks', 'wp-element', 'wp-i18n' )
    );
    
    wp_set_script_translations(
    	'script-handle',
    	'package-domain',
    	plugin_dir_path( __FILE__ ) . 'languages'
    );
    
    register_block_type( 'namespace/block-slug', array(
    	'editor_script' => 'script-handle',
    ) );
    ?>
  • block.jsonファイルがあるディレクトリのパス名を指定してブロックタイプを登録する。
    register_block_type( basename( __DIR__ ) . '/build/blocks/myblock' );

フィルター

実行するフィルターはありません。

アクション

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

ソースファイル

/wp-includes/blocks.php

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



お勧め

個人データのエクスポートメール向けに追加された新フィルター(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つ前の「ニュース」で紹介されていた変更点から確認してみた。