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

お勧め

meta_compare_key使ってみた（2019年3月19日 更新）

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた（2018年5月27日 更新）

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」（Bulkアクション）フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する（2012年3月15日 更新）

投稿記事に挿入する画像サイズは、サムネイル（150×150）、中サイズ（300×300）、大サイズ（1024×1024）がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」－「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える（2014年9月12日 更新）

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える（2021年9月9日 更新）

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。