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



お勧め

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

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

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

カレンダーウィジェットをAjaxで切り替える(2011年8月22日 更新)

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

続テーマを変更せずにWebフォントを使ってみた(2022年2月8日 更新)

先日投稿した「テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Twenty One」でWebフォントを使うことができた。その後、ほかのテーマで試したところ、そのままではWebフォントを使うことができなかった。今回は、それらのテーマの対応について紹介する。

LevelとCapability(2018年5月27日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。