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



お勧め

囲み型ショートコードとwpautop(2018年5月27日 更新)

ショートコードは投稿記事の閲覧時に動的に内容を変更できる優れもの。galleryやcaptionなどいくつかのショートコードが標準で組み込まれており、一部のプラグインではその機能を利用する手段としてショートコードが利用されている。

使っていないか確認しないとね!(フィルター編)(2019年4月24日 更新)

先週末にWordPress 5.2 Beta3(以降5.2Beta3)が公開され、正式リリースまであとわずか。ソースコードの変更点を見ていくと、wp-login.phpの中に非推奨となったフィルターが目に留まった。

Login rebuilder 2.5.0の新機能紹介(2018年12月10日 更新)

今回追加したものは、任意の名前でロックファイルを設定し、そのファイルが存在する場合は常にログイン不可にする機能である。この機能を有効にしておくことで、何らかの理由により認証に関する情報が漏洩した場合でも不正なログインを防ぐことができる。

時代はWP_Queryなのか(2011年8月1日 更新)

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

query_posts(WP_Queryクラス)で'tax_query'を使いこなす(2011年9月14日 更新)

2日にわたって投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」「query_posts(WP_Queryクラス)で投稿タグを絞り込む」の続き。今日はカテゴリーや投稿タグ以外ののタクソノミーによる絞り込み、複数のタクソノミーの絞り込みの組み合わせについてまとめてみる。