register_block_script_handle()


WordPressのregister_block_script_handle()関数は、ブロックエディタ用のJavaScriptスクリプトを登録するために使用されます。

構文

register_block_script_handle( string $metadata, string $field_name, int $index = 0 );

引数の説明:

  • $metadata (string) — ブロックのメタデータを含む配列
  • $field_name (string) — スクリプトハンドルを取得するフィールド名
  • $index (int) — 複数のスクリプトがある場合のインデックス

例1: 基本的なスクリプトの登録

ブロックメタデータからスクリプトハンドルを登録します。

register_block_script_handle( $block_metadata, 'script' );

例2: 複数のスクリプトを登録

2番目のスクリプトを登録します。

register_block_script_handle( $block_metadata, 'script', 1 );

例3: カスタムブロックでの使用

カスタムブロックのスクリプトを登録します。

register_block_script_handle( array( 'script' => 'my-custom-script' ), 'script' );

例4: 依存関係のあるスクリプト

依存関係を持つスクリプトを登録します。

wp_register_script( 'my-dependency', 'path/to/dependency.js' );
register_block_script_handle( array( 'script' => 'my-script', 'dependencies' => array( 'my-dependency' ) ), 'script' );

例5: バージョン指定

バージョンを指定してスクリプトを登録します。

register_block_script_handle( array( 'script' => 'my-script', 'version' => '1.0.0' ), 'script' );

例6: 条件付き登録

条件を満たした場合にスクリプトを登録します。

if( is_admin() ) { register_block_script_handle( $block_metadata, 'script' ); }

例7: 翻訳ファイルの登録

翻訳ファイルと共にスクリプトを登録します。

register_block_script_handle( array( 'script' => 'my-script', 'textdomain' => 'my-textdomain' ), 'script' );

注意点

  • この関数はブロックエディタ専用です
  • スクリプトは事前にwp_register_script()で登録する必要があります
  • WordPress 5.0以降で使用可能です

関連機能：