概要
wp_use_widgets_block_editorフィルタは、ウィジェットの管理にブロックエディターを使用するかどうかを調べるために使用されます。このフィルタを使うことで、ウィジェットエリアの入力方式をブロックエディターで利用できるかどうかを制御できます。
このフィルタがよく使われる機能には以下のようなものがあります。
- 新しいウィジェットエリアの作成
- 既存のウィジェットエリアの編集方法の変更
- プラグインでのウィジェット追加のカスタマイズ
- テーマ作成におけるウィジェットの利用
- 特定条件に応じたウィジェットの表示/非表示
- タグやカテゴリに基づくウィジェット設定
- 管理画面のカスタマイズ
- リッチテキストエディタの設定
構文
apply_filters( 'wp_use_widgets_block_editor', bool $use_widgets_block_editor );
パラメータ
$use_widgets_block_editor(bool): ウィジェットをブロックエディターで使用するかどうかのフラグ。
戻り値
- (bool): ウィジェットのブロックエディター使用の可否に関するフラグの値。
関連する関数
使用可能なバージョン
- WordPress 5.8以降
コアファイルのパス
wp-includes/class-wp-block-editor.php
この関数のアクションでの使用可能性
| アクション名 | 使用可能 |
|---|---|
| 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 |
サンプルコード
サンプルコード1: ブロックエディターを無効化する
このサンプルコードは、ウィジェットのブロックエディター機能を無効化します。
add_filter( 'wp_use_widgets_block_editor', '__return_false' );
引用元: https://developer.wordpress.org/reference/hooks/wp_use_widgets_block_editor/
サンプルコード2: 特定の条件でブロックエディターを有効にする
このサンプルコードは、特定の条件（例: 管理者の場合）でブロックエディターを有効にします。
add_filter( 'wp_use_widgets_block_editor', function( $use_widgets_block_editor ) {
return current_user_can( 'administrator' );
} );
引用元: https://developer.wordpress.org/reference/hooks/wp_use_widgets_block_editor/
サンプルコード3: プラグインに応じたウィジェット管理の変更
このサンプルコードは、特定のプラグインが有効な場合にのみブロックエディターを使用する設定です。
add_filter( 'wp_use_widgets_block_editor', function( $use_widgets_block_editor ) {
if ( is_plugin_active( 'some-plugin/some-plugin.php' ) ) {
return true;
}
return $use_widgets_block_editor;
} );
引用元: https://developer.wordpress.org/reference/hooks/wp_use_widgets_block_editor/
サンプルコード4: カスタムそうけを使ったウィジェットのデフォルト設定
このサンプルコードは、テーマやプラグインに関連する条件でウィジェットの設定を変更します。
add_filter( 'wp_use_widgets_block_editor', function( $use_widgets_block_editor ) {
return is_theme_active( 'my-custom-theme' ) ? true : $use_widgets_block_editor;
} );
引用元: https://developer.wordpress.org/reference/hooks/wp_use_widgets_block_editor/
サンプルコード5: デフォルトのウィジェット設定をオーバーライド
このサンプルコードは、デフォルトのウィジェット設定をオーバーライドし、ブロックエディターを使用するように設定します。
add_filter( 'wp_use_widgets_block_editor', '__return_true' );
引用元: https://developer.wordpress.org/reference/hooks/wp_use_widgets_block_editor/
このフィルタは、特定のバージョンで非推奨または削除されていません。