get_block_editor_settings

説明

array get_block_editor_settings( array $custom_settings, WP_Block_Editor_Context $block_editor_context )
ブロックエディター設定内容を取得する。

パラメータ

  • $custom_settings
    ブロックエディター設定の初期値を示す連想配列を指定。
  • $block_editor_context
    WP_Block_Editor_Contextオブジェクトを指定。

返り値

ブロックエディター設定内容を格納した連想配列を返す。

注意

これまでのバージョンではブロックエディター設定の初期化として'block_editor_settings'フィルターが利用されていたが、5.8.0では本関数が定義された。'block_editor_settings'フィルターは非推奨になり、代わりとして'block_editor_settings_all'フィルターがある。

ブロックエディター設定内容は、パラメータ$custom_settings get_default_block_editor_settings関数の返り値、theme.jsonの内容がマージされたものとなる。


使用例

  • ブロックエディター設定内容を取得する
    $settings = get_block_editor_settings( $settings, $block_editor_context );

フィルター

[5.8.0]ブロックエディター設定内容を返す前に'block_editor_settings_all'フィルターを呼び出す。パラメータ$editor_settingsにはブロックエディター設定内容を示す連想配列が、$block_editor_contextには本関数が受け取った内容が格納されている。
$editor_settings = apply_filters( 'block_editor_settings_all', $editor_settings, $block_editor_context );
[5.0.0]ブロックエディター設定内容を返す前に'block_editor_settings'フィルターを呼び出す。パラメータ$editor_settingsにはブロックエディター設定内容を示す連想配列が、$postには$block_editor_contextに含まれている投稿情報が格納されている。
$editor_settings = apply_filters( 'block_editor_settings', $editor_settings, $post );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/block-editor.php

最終更新 : 2021年08月17日 15:02



お勧め

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

WordPressのコーディングスタンダードとPSR-2がかみ合わない(2018年5月27日 更新)

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon(4.6)」から「Oxygen(4.7)」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style(Formatter)」が「PSR-2」に設定されていることが原因だった。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

さくらのVPSでKUSANAGI#3(2018年5月27日 更新)

今回は「前回」の続き。http(80番)をクローズ、そのほかに行った調整作業について整理する。