wp_get_admin_notice

（6.4.0以降）
wp_get_admin_notice - 管理画面の通知HTMLマークアップを取得する

説明

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

参考

Code Reference: wp_get_admin_notice

お勧め

6.2に追加されるsearch_columnsパラメータが便利（2023年3月30日更新）

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル（post_title）、本文（post_content）、抜粋（post_excerpt）が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する（2013年3月9日更新）

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト（サブドメイン）を試した（2019年8月6日更新）

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo：プラグイン作ってみました（2019年9月19日更新）

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する（2012年1月23日更新）

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。