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日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

5.3の機能強化:カスタムフィールドキーの条件指定が使いやすくなる(2019年11月19日 更新)

5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

親子の固定ページで同じテンプレートを使う(2013年3月20日 更新)

固定ページのテンプレートファイルは「page.php」か、ページ名(スラッグ)または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。