get_block_editor_server_block_settings()


WordPressの関数get_block_editor_server_block_settings()は、ブロックエディターで使用するサーバーサイドブロックの設定を取得します。

構文

get_block_editor_server_block_settings( string $block_name );
  • $block_name(string) — ブロックの名前(例: ‘core/paragraph’)

例1: 基本的なブロック設定の取得

‘core/paragraph’ブロックの設定を取得します。

$settings = get_block_editor_server_block_settings( 'core/paragraph' );

例2: カスタムブロックの設定確認

カスタムブロック’my-plugin/custom-block’の設定を確認します。

$custom_settings = get_block_editor_server_block_settings( 'my-plugin/custom-block' );

例3: 設定の存在チェック

ブロック設定が存在するかどうかを確認します。

if( get_block_editor_server_block_settings( 'core/image' ) ) { /* 処理 */ }

例4: ブロックサポートの確認

ブロックが特定のサポート機能を持っているか確認します。

$settings = get_block_editor_server_block_settings( 'core/heading' );
$has_align = isset( $settings['supports']['align'] );

例5: ブロックスタイルの取得

ブロックのスタイル設定を取得します。

$styles = get_block_editor_server_block_settings( 'core/button' )['styles'];

例6: ブロックバリエーションの確認

ブロックのバリエーション設定を確認します。

$variations = get_block_editor_server_block_settings( 'core/columns' )['variations'];

例7: ブロックのデフォルト属性取得

ブロックのデフォルト属性を取得します。

$defaults = get_block_editor_server_block_settings( 'core/gallery' )['attributes'];

注意点

  • ブロックが登録されていない場合、falseが返されます
  • この関数は管理画面でのみ動作します
  • フロントエンドでは使用しないでください

関連機能: