概要
unregister_block_style 関数は、WordPressのブロックエディタ（Gutenberg）で使用される特定のブロックスタイルを削除するための関数です。この関数は、カスタムブロックやテーマを作成する際に、不要なスタイルを制御したり、デフォルトのスタイルを無効化したりするのに役立ちます。一般的に、次のようなシナリオで使用されます。
- 不要なブロックスタイルを削除したい場合。
- ユーザーが誤って不適切なスタイルを選択するのを防ぎたい場合。
- 特定のプロジェクトに対してスタイルをカスタマイズしたい場合。
- テーマの美観に合わないスタイルを排除したい場合。
- 競合するスタイルを無効化したい場合。
- プラグインの機能を制御したい場合。
- チーム内の一貫性を持たせるためにスタイルを制限したい場合。
- テスト環境で無駄なスタイルを管理したい場合。
構文
unregister_block_style( $block_name, $style_name );
パラメータ
- $block_name （string）: 削除するスタイルを持つブロックの名前（例:
core/paragraph）。 - $style_name （string）: 削除したいスタイルの名前（例:
my-custom-style）。
戻り値
- void: この関数は何も値を返しません。
関連する関数
使用可能なバージョン
- WordPress 5.0 以降
コアファイルのパス
/wp-includes/block-supports.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: デフォルトブロックスタイルの削除
function my_custom_block_styles() {
unregister_block_style( 'core/quote', 'large' );
}
add_action( 'init', 'my_custom_block_styles' );
このコードは、標準の引用ブロックから「大」スタイルを削除します。
サンプルコード 2: 特定のテーマ用にスタイルを削除
function remove_custom_style() {
unregister_block_style( 'core/paragraph', 'Highlighted' );
}
add_action( 'init', 'remove_custom_style' );
このコードは、パラグラフブロックの中から「ハイライト」スタイルを削除します。
サンプルコード 3: 自作ブロックのスタイル管理
function custom_block_management() {
unregister_block_style( 'my-plugin/my-custom-block', 'My Special Style' );
}
add_action( 'init', 'custom_block_management' );
このコードは、カスタムブロック「my-custom-block」から「My Special Style」を削除します。
サンプルコード 4: プラグイン内のスタイル削除
function disable_block_styles() {
unregister_block_style( 'core/image', 'Align Center' );
}
add_action( 'init', 'disable_block_styles' );
このコードは、イメージブロックの中から「中央揃え」スタイルを無効にします。
サンプルコード 5: 複数ブロックスタイルの削除
function remove_multiple_styles() {
unregister_block_style( 'core/button', 'outline' );
unregister_block_style( 'core/button', 'round' );
}
add_action( 'init', 'remove_multiple_styles' );
このコードは、ボタンブロックから「アウトライン」と「ラウンド」スタイルを削除します。
これらのサンプルコードは、unregister_block_style 関数の使い方を具体的に示しており、さまざまなブロックやスタイルでの応用が可能です。