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



お勧め

投稿一覧に独自リンクを追加する(2013年10月16日 更新)

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

更新ボタンの横にスピナーを実装する(2019年5月14日 更新)

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

ブロックエディターをちょっとだけカスタマイズしてみる(2021年11月3日 更新)

ブロックエディターで投稿を編集していると「ここは〇〇だったらいいのにな」と思うところがある。今回は、そんな気になるところをいくつか(自分好みに)調整してみた。

Login rebuilder 2.3.0の新機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」はログイン時の履歴(ログ)や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

メディア(attachment)を拡張してより便利に活用する(2014年5月22日 更新)

「メディア(attachment)」は、標準ではカテゴリもタグもカスタムフィールドもない。投稿と親子関係を作って利用することが前提だからともいえるが、メディアをもっと便利に活用するために、それらの付加情報を絞り込みの材料として利用できないか調べてみた。