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



お勧め

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

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

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

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

投稿日の検索が自由自在に(2015年3月7日 更新)

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろん query_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。