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



お勧め

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する(2012年3月15日 更新)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。