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

最終更新 : 2023年03月31日 14:12



お勧め

4.2.3でちょっと変わったショートコード(2018年5月27日 更新)

4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

Gutenbergエディターのフォントを変える(2018年10月16日 更新)

Gutenbergエディターを試していてしっくりこないのが、編集時とそれを投稿した際の見た目の違い。GutenbergエディターとテーマTwenty Seventeenとではまったく異なるタイプのフォントが適用されていることが大きな理由である。

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。