_register_block_bindings_pattern_overrides_source()


WordPressの_register_block_bindings_pattern_overrides_source()関数は、ブロックバインディングのパターンオーバーライドソースを登録するために使用されます。この関数は、カスタムブロックバインディングの動作をカスタマイズする際に役立ちます。

構文

_register_block_bindings_pattern_overrides_source( string $source_name, array $source_properties );

引数の説明:

  • $source_name(string) — ソースの名前を指定します。この名前は一意である必要があります。
  • $source_properties(array) — ソースのプロパティを指定します。これには、コールバック関数やその他の設定が含まれます。

例1: 基本的なソースの登録

この例では、カスタムブロックバインディングのソースを登録します。

_register_block_bindings_pattern_overrides_source( 'my_custom_source', array( 'callback' => 'my_custom_callback_function' ) );

例2: コールバック関数の定義

この例では、コールバック関数を定義し、ソースに紐付けます。

function my_custom_callback_function( $attributes ) { return 'Custom Output'; } _register_block_bindings_pattern_overrides_source( 'my_custom_source', array( 'callback' => 'my_custom_callback_function' ) );

例3: ソースのプロパティを追加

この例では、ソースに追加のプロパティを設定します。

_register_block_bindings_pattern_overrides_source( 'my_custom_source', array( 'callback' => 'my_custom_callback_function', 'label' => 'My Custom Source' ) );

例4: ソースの削除

この例では、登録されたソースを削除します。

unregister_block_bindings_pattern_overrides_source( 'my_custom_source' );

例5: 複数のソースを登録

この例では、複数のソースを一度に登録します。

_register_block_bindings_pattern_overrides_source( 'source_one', array( 'callback' => 'callback_one' ) ); _register_block_bindings_pattern_overrides_source( 'source_two', array( 'callback' => 'callback_two' ) );

例6: ソースのコールバックに引数を渡す

この例では、コールバック関数に引数を渡します。

function my_callback_with_args( $attributes, $args ) { return $args['custom_arg']; } _register_block_bindings_pattern_overrides_source( 'my_source', array( 'callback' => 'my_callback_with_args', 'args' => array( 'custom_arg' => 'Hello World' ) ) );

例7: ソースのラベルを動的に設定

この例では、ソースのラベルを動的に設定します。

_register_block_bindings_pattern_overrides_source( 'dynamic_label_source', array( 'callback' => 'my_callback', 'label' => __( 'Dynamic Label', 'textdomain' ) ) );

例8: ソースの優先度を設定

この例では、ソースの優先度を設定します。

_register_block_bindings_pattern_overrides_source( 'priority_source', array( 'callback' => 'my_callback', 'priority' => 10 ) );

注意点

  • ソース名は一意である必要があります。重複するとエラーが発生する可能性があります。
  • コールバック関数は、適切な出力を返すように設計する必要があります。
  • ソースの登録は、プラグインやテーマの初期化時に実行することを推奨します。

関連機能：