get_default_block_editor_settings

説明

array get_default_block_editor_settings()
デフォルトのブロックエディター設定内容を取得する。

パラメータ

パラメータはありません。

返り値

ブロックエディター設定内容を格納した連想配列を返す。

注意

ブロックエディター向けの各種設定値を取得するもので、直接呼び出す機会は少ない。

各種設定値は、テーマのfunctions.phpで add_theme_support関数を使って指定する内容が関連している。返り値となる連想配列のキーと関連する関数は次の通り。

キー常在関連する関数など
'alignWide'get_theme_support( 'align-wide' )
'allowedBlockTypes'true
'allowedMimeTypesget_allowed_mime_types()
'blockCategories'get_default_block_categories()
'disableCustomColors'get_theme_support( 'disable-custom-colors' )
'disableCustomFontSizes'get_theme_support( 'disable-custom-font-sizes' )
'disableCustomGradients'get_theme_support( 'disable-custom-gradients' )
'enableCustomLineHeight'get_theme_support( 'custom-line-height' )
'enableCustomSpacing'get_theme_support( 'custom-spacing' )
'enableCustomUnits'get_theme_support( 'custom-units' )
'isRTL'is_rtl()
'imageDefaultSize'get_option( 'image_default_size', 'large' )
'imageDimensions'wp_get_registered_image_subsizes()
'imageEditing'true
'imageSizes' 
'maxUploadFileSize'wp_max_upload_size()
'colors'get_theme_support( 'editor-color-palette' )
'fontSizes'get_theme_support( 'editor-font-sizes' )
'gradients'get_theme_support( 'editor-gradient-presets' )

このデフォルトのブロックエディター設定内容は、 get_block_editor_settings関数でtheme.jsonの内容で補完される。


使用例

  • デフォルトのブロックエディター設定内容を取得する
    $settings = get_default_block_editor_settings();

フィルター

[5.8.0]'image_size_names_choose'フィルターを呼び出す。パラメータ$namesには、対応する画像サイズを示した連想配列が格納されている。
$image_size_names = apply_filters( 'image_size_names_choose', $names );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/block-editor.php

最終更新 : 2021年08月12日 14:29



お勧め

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目(2011年7月6日 更新)

新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。

標準で使用できる数少ないショートコード[caption]とは(2018年5月27日 更新)

画像をアップロードして「投稿に追加」ボタンをクリックすると、投稿記事内にリンク付きのimgタグか、ショートコードのが挿入される。ここではそれらの書式を整理する。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。