register_block_style

説明

bool register_block_style( string $block_name, array $style_properties )
ブロックにスタイルを追加する。

パラメータ

  • $block_name
    'core/image'のようなブロック名を指定。
  • $style_properties
    スタイルを示す連想配列を指定。

返り値

ブロックにスタイルを追加できた場合はtrueを、できなかった場合はfalseを返す。

注意

標準でスタイルプロパティを持つ「引用(core/quote)」や「画像(core/image)」はもちろん、「段落(core/paragraph)」のような標準でスタイルプロパティを持たないブロックにも使用できる。

パラメータ$style_propertiesの連想配列は次の通りである。

キー備考
'name'スタイルのclass名必須
'label'スタイルのラベル名必須
'inline_style'インラインスタイルオプション
'style_handle'wp_register_style関数で登録したcssファイルのハンドル名オプション

'inline_style'または'style_handle'のどちらかは必ず指定する(両方を指定することも可能)。指定した内容はenqueue_block_styles_assets関数で出力用のキューに追加されるため、テーマやプラグインで wp_enqueue_style関数や wp_add_inline_style関数を使用する必要はない。


使用例

  • 「画像」ブロックに「Drop Shadow」スタイルを追加する
    <?php
    register_block_style(
    	'core/image',
    	array(
    		'name'         => 'drop-shadow',
    		'label'        => __( 'Drop Shadow', 'theme-domain' ),
    		'inline_style' => '.wp-block-image.is-style-drop-shadow { box-shadow: rgb(128, 128, 128) 4px 4px 4px 2px; }',
    	)
    );
    ?>

フィルター

直接実行するフィルターはありません。

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/blocks.php

最終更新 : 2019年11月25日 12:45



お勧め

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

管理画面の'アイキャッチ画像'を'写真'に変える(2013年1月23日 更新)

クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。

5.7の機能拡張:投稿一覧画面向けのフィルター(2021年2月18日 更新)

昨日、予定通り公開された「WordPress 5.7 Beta 3(以降Beta 3)」。WordPressはバージョンアップ毎にアクションやフィルターが追加されており、今回のバージョンアップでは投稿一覧画面に影響を与えるフィルターが追加されていた。

Login rebuilder 2.6.0の新機能紹介(2019年4月22日 更新)

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

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

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