説明
array get_block_editor_settings( array $custom_settings, WP_Block_Editor_Context $block_editor_context )
ブロックエディター設定内容を取得する。
パラメータ
- $custom_settingsブロックエディター設定の初期値を示す連想配列を指定。
- $block_editor_contextWP_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 );$editor_settings = apply_filters( 'block_editor_settings', $editor_settings, $post );アクション
直接実行するアクションはありません。ソースファイル
/wp-includes/block-editor.php最終更新 : 2021年08月17日 15:02
関連
お勧め
個人データのエクスポートメール向けに追加された新フィルター（2020年4月2日 更新）
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。
決まった値を返すだけの関数群（2018年5月27日 更新）
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
サイドバーの初期化はwidgets_initアクションで（2011年7月14日 更新）
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
favicon.icoがWordPressロゴになる！？（2020年2月25日 更新）
先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。