get_block_wrapper_attributes

説明

string get_block_wrapper_attributes( string[] $extra_attributes = array() )
ブロックのラッパー要素向けの属性を取得する。

パラメータ

  • $extra_attributes
    'id'、'class'、'style'キーを持つ連想配列を指定(省略時はarray())。

返り値

ブロックのラッパー要素向けの属性文字列を返す。ラッパー要素に指定する属性がない場合は''を返す。

注意

本関数はダイナミックブロックをレンダリングするコールバック関数内で、対象ブロックの始まりの要素向けの属性を取得する際に使用する。

パラメータ$extra_attributesの連想配列は、キーに属性名、その内容に属性値を指定する。それぞれは対象ブロックのデフォルト属性(ブロックのattributesやsupportsプロパティに依存)とマージされ、最終的なラッパー要素の属性文字列となる。

各属性値は本関数内でエスケープ処理される。


使用例

  • デフォルトのラッパー要素向けの属性を取得する
    $wrapper_attributes = get_block_wrapper_attributes();
  • style属性を追加したラッパー要素向けの属性を取得する
    $wrapper_attributes = get_block_wrapper_attributes( array( 'style' => 'width:300px;height:300px;' ) );

フィルター

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

アクション

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

ソースファイル

/wp-includes/class-wp-block-supports.php

最終更新 : 2024年07月18日 13:59


お勧め

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

5.3の機能強化:カスタムフィールドキーの条件指定が使いやすくなる(2019年11月19日 更新)

5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。

HTML entities button:プラグイン作ってみました(2021年4月28日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

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

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

「順序」をtextからnumberに変更してみた(2018年5月27日 更新)

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。