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



お勧め

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 更新)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

query_posts(WP_Queryクラス)で投稿タグを絞り込む(2011年9月14日 更新)

投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

Align widgets horizontally:プラグイン作ってみました(2024年5月6日 更新)

ほぼ毎日何度も見ているダッシュボードページ。自分好みに各ウィジェットの場所を配置しているものの、何かすっきりしない。そこでふと思ったのが、ウィジェットを横並びにできれば隣り合うウィジェットの並びがガタガタしなくなるのでは!?

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

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