概要
get_classic_theme_supports_block_editor_settings フィルタは、クラシックテーマのブロックエディタに関するサポート設定を取得するために使用されます。このフィルタを使用することで、テーマの機能や設定をカスタマイズすることができ、ブロックエディタの(user experience)を向上させることが可能です。一般的には、以下のような機能を実装する際によく使われます。
- 投稿やページのエディタ設定をカスタマイズする
- 独自のメタボックスを追加する
- エディタ内のカスタムブロックの設定を変更する
- エディタのスタイルやスクリプトを調整する
- プラグインやテーマの整合性を保つ
- ブロックに追加するカスタム属性を定義する
- 属性に基づく条件付きロジックを実装する
- エディタのデフォルト設定を変更する
構文
get_classic_theme_supports_block_editor_settings( array $supports );
パラメータ
array $supports– 現在のサポート設定の配列。
戻り値
array– フィルタ適用後のサポート設定を示す配列。
関連する関数
フィルタ: get_classic_theme_supports_block_editor_settings
使用可能なバージョン
- WordPress 5.0 以降
コアファイルのパス
wp-includes/class-wp-block-editor.php
サンプルコード
サンプルコード1: カスタムエディタ設定を追加する
このサンプルコードは、クラシックテーマのブロックエディタにカスタム設定を追加する基本的な方法を示しています。
add_filter('get_classic_theme_supports_block_editor_settings', function($supports) {
$supports['customSetting'] = true;
return $supports;
});
このコードは、customSettingというカスタム設定を追加し、その値をtrueに設定します。これにより、エディタでのカスタマイズが可能になります。
引用元: https://developer.wordpress.org/reference/hooks/get_classic_theme_supports_block_editor_settings/
サンプルコード2: サポートされるカスタムブロックを定義する
この例では、特定のカスタムブロックをエディタで利用できるようにするための設定を加えています。
add_filter('get_classic_theme_supports_block_editor_settings', function($supports) {
$supports['customBlocks'] = ['my-custom-block'];
return $supports;
});
ここでは、my-custom-blockというカスタムブロックをサポートするように設定しています。
引用元: https://developer.wordpress.org/reference/hooks/get_classic_theme_supports_block_editor_settings/
サンプルコード3: ブロックエディタのスタイルを変更
このコードで、ブロックエディタの表示スタイルを調整しています。
add_filter('get_classic_theme_supports_block_editor_settings', function($supports) {
$supports['editorStyles'] = ['style.css'];
return $supports;
});
このサンプルでは、エディタに適用するスタイルシートを指定しています。
引用元: https://developer.wordpress.org/reference/hooks/get_classic_theme_supports_block_editor_settings/
サンプルコード4: エディタのスクリプトを追加
このサンプルでは、エディタに独自のスクリプトを追加しています。
add_filter('get_classic_theme_supports_block_editor_settings', function($supports) {
$supports['editorScript'] = 'my-editor-script';
return $supports;
});
my-editor-scriptというスクリプトをエディタに読み込む設定を追加しています。
引用元: https://developer.wordpress.org/reference/hooks/get_classic_theme_supports_block_editor_settings/
サンプルコード5: ブロック属性を設定
こちらでは、ブロックの属性をカスタマイズする例を示しています。
add_filter('get_classic_theme_supports_block_editor_settings', function($supports) {
$supports['attributes'] = ['my_attribute'];
return $supports;
});
このコードにより、my_attributeという独自属性をブロックに追加しています。
引用元: https://developer.wordpress.org/reference/hooks/get_classic_theme_supports_block_editor_settings/
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | 〇 |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
非推奨または削除されたワードプレスバージョン
特に非推奨または削除されたバージョンはありません。