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

お勧め

Emojin：プラグイン作ってみました（2015年3月21日 更新）

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

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

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

5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。