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



お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。