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



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。