get_block_editor_settings

（5.8.0以降）
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

関連

参考

Code Reference: get_block_editor_settings

お勧め

プラグインのロード順を制御する（2014年6月9日 更新）

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

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

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

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

更新ボタンの横にスピナーを実装する（2019年5月14日 更新）

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

「順序」をtextからnumberに変更してみた（2018年5月27日 更新）

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。