wp_apply_alignment_support()


WordPressのwp_apply_alignment_support()関数は、ブロックエディタ内の配置サポートをテーマに追加するために使用されます。この関数はadd_theme_support()と組み合わせて使われ、テーマがブロックの配置オプションをサポートすることを宣言します。

構文

wp_apply_alignment_support( string $block_type, array $args );

引数の説明:

  • $block_type(string)—ブロックタイプの名前
  • $args(array)—配置サポートの引数配列

例1:基本的な配置サポートの追加

テーマに基本的な配置サポートを追加します。

add_theme_support('align-wide');wp_apply_alignment_support('core/paragraph',array('align'=>true));

例2:幅広い配置のサポート

幅広い配置オプションを有効にします。

add_theme_support('align-wide');wp_apply_alignment_support('core/image',array('align'=>array('wide','full')));

例3:特定のブロックのみに適用

特定のブロックタイプにのみ配置サポートを適用します。

wp_apply_alignment_support('core/heading',array('align'=>true));

例4:複数のブロックに適用例5:カスタムブロックへの適用

カスタムブロックに配置サポートを追加します。

wp_apply_alignment_support('my-plugin/custom-block',array('align'=>true));

例6:フル幅配置のサポート

フル幅配置をサポートします。

add_theme_support('align-full');wp_apply_alignment_support('core/group',array('align'=>array('full')));

例7:条件付きで配置サポートを追加

条件に基づいて配置サポートを追加します。

if(function_exists('wp_apply_alignment_support')){wp_apply_alignment_support('core/columns',array('align'=>true));}

注意点

  • この関数を使用する前にadd_theme_support()で配置オプションを有効にする必要があります
  • WordPress5.0以降で利用可能です
  • 子テーマで親テーマの設定を上書きできます

関連機能：