wp_register_layout_support()


WordPressのwp_register_layout_support()関数は、ブロックエディタでレイアウト関連のサポートを登録するために使用されます。この関数は、テーマやプラグインでカスタムレイアウトを定義する際に役立ちます。

構文

wp_register_layout_support( string $feature, array $args = array() );

引数の説明:

  • $feature(string) — レイアウト機能の名前を指定します。
  • $args(array) — レイアウト機能に関連する追加の引数を指定します。

例1: 基本的なレイアウトサポートの登録

この例では、シンプルなレイアウトサポートを登録します。

wp_register_layout_support( 'custom-layout', array( 'default' => 'wide' ) );

例2: カスタムレイアウトオプションの追加

カスタムレイアウトオプションを追加する例です。

wp_register_layout_support( 'custom-layout', array( 'options' => array( 'wide', 'narrow', 'full' ) ) );

例3: レイアウトのデフォルト値を設定

デフォルトのレイアウト値を設定する例です。

wp_register_layout_support( 'custom-layout', array( 'default' => 'narrow' ) );

例4: レイアウトの条件付きサポート

特定の条件でレイアウトサポートを登録する例です。

if ( is_singular() ) { wp_register_layout_support( 'custom-layout', array( 'default' => 'wide' ) ); }

例5: 複数のレイアウト機能を一度に登録

複数のレイアウト機能を一度に登録する例です。

wp_register_layout_support( 'custom-layout-1', array( 'default' => 'wide' ) ); wp_register_layout_support( 'custom-layout-2', array( 'default' => 'narrow' ) );

例6: レイアウトサポートの削除

登録したレイアウトサポートを削除する例です。

remove_theme_support( 'custom-layout' );

例7: レイアウトサポートの確認

レイアウトサポートが登録されているか確認する例です。

if ( current_theme_supports( 'custom-layout' ) ) { echo 'レイアウトサポートが有効です。'; }

注意点

  • レイアウトサポートを登録する際は、テーマやプラグインの要件に応じて適切な引数を指定してください。
  • レイアウトサポートを削除する際は、他の機能に影響を与えないように注意してください。

関連機能：