block_core_image_get_lightbox_settings()


WordPressのblock_core_image_get_lightbox_settings()関数は、ブロックエディタ内で画像のライトボックス設定を取得するために使用されます。この関数は、画像ブロックのライトボックス機能に関連する設定を返します。

シンタックス

block_core_image_get_lightbox_settings();
  • array — ライトボックスの設定を含む配列を返します。

例1: ライトボックス設定の取得

この例では、ライトボックスの設定を取得し、その内容を表示します。

$lightbox_settings = block_core_image_get_lightbox_settings(); print_r($lightbox_settings);

例2: ライトボックス設定の特定の値の取得

この例では、ライトボックス設定の特定の値を取得します。

$lightbox_settings = block_core_image_get_lightbox_settings(); echo $lightbox_settings['enabled'];

例3: ライトボックス設定の有効化状態を確認

この例では、ライトボックスが有効かどうかを確認します。

$lightbox_settings = block_core_image_get_lightbox_settings(); if ($lightbox_settings['enabled']) { echo 'ライトボックスは有効です'; }

例4: ライトボックス設定の変更

この例では、ライトボックス設定を変更します。

add_filter('block_core_image_lightbox_settings', function($settings) { $settings['enabled'] = false; return $settings; });

例5: ライトボックス設定の追加

この例では、新しい設定をライトボックスに追加します。

add_filter('block_core_image_lightbox_settings', function($settings) { $settings['new_setting'] = 'value'; return $settings; });

例6: ライトボックス設定の削除

この例では、ライトボックス設定から特定の設定を削除します。

add_filter('block_core_image_lightbox_settings', function($settings) { unset($settings['enabled']); return $settings; });

例7: ライトボックス設定のデフォルト値の確認

この例では、ライトボックスのデフォルト設定を確認します。

$default_settings = block_core_image_get_lightbox_settings(); print_r($default_settings);

注意点

  • この関数は、ブロックエディタのコンテキストでのみ動作します。
  • ライトボックス設定は、テーマやプラグインによって変更される可能性があります。
  • 設定を変更する場合は、必ずフィルターフックを使用してください。

関連機能：