wp_register_border_support()


WordPressのwp_register_border_support()関数は、ブロックエディタでボーダーサポートを登録するために使用されます。この関数は、ブロックのスタイル設定においてボーダーのカスタマイズを可能にします。

構文

wp_register_border_support( string $block_type, array $args = array() );

引数の説明:

  • $block_type(string) — ボーダーサポートを登録するブロックタイプを指定します。
  • $args(array) — ボーダーサポートの設定オプションを指定します。

例1: 基本的なボーダーサポートの登録

この例では、カスタムブロックにボーダーサポートを追加します。

wp_register_border_support( 'core/paragraph', array( 'color' => true, 'width' => true ) );

例2: カスタムブロックでのボーダーサポートの使用

カスタムブロックにボーダーサポートを追加し、色と幅のオプションを有効にします。

wp_register_border_support( 'my-plugin/custom-block', array( 'color' => true, 'width' => true ) );

例3: ボーダーカラーのみを有効にする

ボーダーの色設定のみを有効にします。

wp_register_border_support( 'core/image', array( 'color' => true ) );

例4: ボーダー幅のみを有効にする

ボーダーの幅設定のみを有効にします。

wp_register_border_support( 'core/heading', array( 'width' => true ) );

例5: 複数のブロックタイプにボーダーサポートを追加

複数のブロックタイプにボーダーサポートを一度に追加します。

wp_register_border_support( 'core/paragraph', array( 'color' => true ) ); wp_register_border_support( 'core/image', array( 'width' => true ) );

例6: カスタムブロックでの詳細なボーダー設定

カスタムブロックに詳細なボーダー設定を追加します。

wp_register_border_support( 'my-plugin/custom-block', array( 'color' => true, 'width' => true, 'style' => true ) );

例7: ボーダースタイルのサポートを追加

ボーダーのスタイル設定を有効にします。

wp_register_border_support( 'core/quote', array( 'style' => true ) );

注意点

  • この関数はブロックエディタでのみ機能します。
  • 引数$argsは、ボーダーのカスタマイズオプションを制御します。
  • ボーダーサポートを追加する前に、ブロックタイプが正しく登録されていることを確認してください。

関連機能：