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



お勧め

フィードにサムネイル画像を追加する(2022年11月7日 更新)

WordPressが出力するの標準のフィードには、各投稿のサムネイル画像の情報が含まれていない。ネットで検索してみるといくつかの方法があることがわかったので、その中から2つ試してみた。

ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた(2019年11月5日 更新)

管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。

スマートフォン向けの振り分けを自前で行う(2012年1月23日 更新)

PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

5.5の機能強化:コメントフォームのちょっとした改良(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2、3と公開が続いている。「WordPress 5.5 Beta 3(以降Beta 3)」のソースコードを見ていくと、コメントフォームを表示する comment_form関数が機能拡張されていた。