説明
パラメータ
パラメータはありません。返り値
ブロックエディター設定内容を格納した連想配列を返す。注意
ブロックエディター向けの各種設定値を取得するもので、直接呼び出す機会は少ない。
各種設定値は、テーマのfunctions.phpで add_theme_support関数を使って指定する内容が関連している。返り値となる連想配列のキーと関連する関数は次の通り。
| キー | 常在 | 関連する関数など |
| 'alignWide' | 〇 | get_theme_support( 'align-wide' ) |
|---|---|---|
| 'allowedBlockTypes' | 〇 | true |
| 'allowedMimeTypes | 〇 | get_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
関連
お勧め
個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。
決まった値を返すだけの関数群(2018年5月27日 更新)
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)
先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。