register_block_style

（5.3.0以降）
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

関連

参考

Code Reference: register_block_style

お勧め

固定ページを投稿ページ用テンプレートファイル（single.php）で表示する（2013年7月31日 更新）

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

タイトルが一致する投稿を検索する（2014年2月20日 更新）

WordPressが提供する投稿ページの文字列検索機能の実現には、 query_posts関数（WP_Queryクラス）が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数（WP_Queryクラス）の使用法の一例である。

フォーム内のエスケープ処理を考える（2018年10月19日 更新）

WordPressにはエスケープ処理を行う esc_html関数と esc_attr関数がある。HTML要素（タグ）の属性値ならesc_attr関数を、それ以外はesc_html関数を使うことがほとんどだが、今回esc_html関数が適していないと思われるケースに遭遇した。

ダッシュボードのフィードボックスをカスタマイズ（2011年7月8日 更新）

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する（管理者権限）。

classic editorプラグインを試してみた（2018年12月10日 更新）

WordPress 5.0 beta1のリリースにあわせて旧エディター環境を実現できる「classic editor」（バージョン0.5.0）が公開された。自分が公開しているプラグインの一部が旧エディター環境に依存していることもあり、さっそく試してみた。WordPress 5.0正式リリースに合わせてclassic editorも1.0がリリースされたので、それについて追記しました。