wp_get_admin_notice

説明

string wp_get_admin_notice( string $message [ , array $args = array() ] )
管理画面の通知HTMLマークアップを取得する。

パラメータ

  • $message
    メッセージを指定。
  • $args
    各種設定を連想配列で指定(省略時はarray())。
    キー内容省略時
    type通知タイプを示す'error'、'success'、'warning'、'info'などを指定''
    dismissible通知を消去にするボタンを表示する場合はtrueを指定false
    id通知のdiv要素に適用するid属性を指定''
    additional_classes通知のdiv要素に適用するclass属性に追加する内容を指定array()
    attributes通知のdiv要素に適用する属性名と属性値のペアを連想配列で指定array()
    paragraph_wrapメッセージをp要素で囲む場合はtrueを指定true

返り値

パラメータ$messageを含んだHTMLマークアップを返す。

注意

プラグインなどで管理画面に表示する通知のHTMLマークアップを取得する。

パラメータ$messageはエスケープされないので、任意のHTML要素を含められる。

パラメータ$argsの'attributes'の連想配列に指定するキー(属性名)と値(属性値)は esc_attr関数でエスケープされる。


使用例

  • 管理画面の通知HTMLマークアップを取得する
    $notice = wp_get_admin_notice( __( 'Settings saved.' ), array( 'type' => 'success', 'dismissible' => true ) );
    // <div class="notice notice-success is-dismissible"><p>Settings saved.</p></div>
    

フィルター

[6.4.0]パラメータ$argsとデフォルト値をマージした後に'wp_admin_notice_args'フィルターを呼び出す。パラメータ$argsにはデフォルト値とマージした内容が、$messageには本関数が受け取った内容が格納されている。
$args = apply_filters( 'wp_admin_notice_args', $args, $message );
[6.4.0]通知のHTMLマークアップを返す前に'wp_admin_notice_markup'フィルターを呼び出す。パラメータ$markupには通知のHTMLマークアップが、$messageには本関数が受け取った内容が、$argsには'wp_admin_notice_args'フィルターの返り値が格納されている。
return apply_filters( 'wp_admin_notice_markup', $markup, $message, $args );

アクション

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

ソースファイル

/wp-includes/functions.php

最終更新 : 2023年11月10日 16:29



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。