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



お勧め

標準で使用できる数少ないショートコード[caption]とは(2018年5月27日 更新)

画像をアップロードして「投稿に追加」ボタンをクリックすると、投稿記事内にリンク付きのimgタグか、ショートコードのが挿入される。ここではそれらの書式を整理する。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

カスタムブロックを作っていると、ブロック自身の「サイズ」を指定するUIを持たせることがある。そんなときにちょっとモヤっとするのが、「マージン」や「パディング」の設定しているパネルのタイトルが「サイズ」なこと。この「サイズ」の原文は「Dimensions」であり、個人的にもう少しスッキリするワードに変更してみた。

管理画面でツールバー(Admin bar)を非表示にする(2013年3月5日 更新)

WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。