wp_register_spacing_support()


WordPressのwp_register_spacing_support()関数は、ブロックエディタでスペーシングサポートを登録するために使用されます。この関数は、テーマやプラグインでスペーシングオプションを有効にする際に役立ちます。

構文

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

引数の説明:

  • $block_type(string) — スペーシングサポートを適用するブロックタイプを指定します。
  • $args(array) — スペーシングサポートの設定オプションを含む配列。

例1: 基本的なスペーシングサポートの登録

この例では、core/paragraphブロックにスペーシングサポートを追加します。

wp_register_spacing_support( 'core/paragraph' );

例2: カスタムブロックにスペーシングサポートを追加

カスタムブロックmy-plugin/custom-blockにスペーシングサポートを追加します。

wp_register_spacing_support( 'my-plugin/custom-block' );

例3: マージンとパディングのサポートを有効化

core/groupブロックにマージンとパディングのサポートを追加します。

wp_register_spacing_support( 'core/group', array( 'margin' => true, 'padding' => true ) );

例4: カスタムブロックに特定のスペーシングオプションを追加

my-plugin/custom-blockにマージンのみをサポートします。

wp_register_spacing_support( 'my-plugin/custom-block', array( 'margin' => true ) );

例5: 複数のブロックにスペーシングサポートを追加

複数のブロックにスペーシングサポートを一度に追加します。

wp_register_spacing_support( 'core/paragraph' ); wp_register_spacing_support( 'core/heading' );

例6: テーマ内でのスペーシングサポートの登録

テーマのfunctions.phpでスペーシングサポートを登録します。

add_action( 'init', function() { wp_register_spacing_support( 'core/image' ); } );

例7: プラグイン内でのスペーシングサポートの登録

プラグイン内でcore/quoteブロックにスペーシングサポートを追加します。

add_action( 'init', function() { wp_register_spacing_support( 'core/quote' ); } );

注意点

  • この関数はWordPress 5.9以降で利用可能です。
  • スペーシングサポートを追加する前に、ブロックが存在することを確認してください。
  • 引数$argsはオプションですが、必要に応じて使用してください。

関連機能：