wp_admin_notice() の使い方｜説明・引数・注意点

説明

基本構文

wp_admin_notice( string $message, array|string $args = array() ): void

引数

• $message：通知のメッセージ
• $args：type、dismissible、id など

戻り値

戻り値はありません（出力します）。

使い方（サンプル）

wp_admin_notice( '保存しました', array( 'type' => 'success', 'dismissible' => true ) );

注意点

• WordPress 6.4 で追加された関数です。それ以前のバージョンでは使えません。

実務での使いどころ

• 管理画面に、通知（成功、エラー、警告、情報）を、出力するとき（WordPress 6.4以降）。
• 閉じられる通知（dismissible）を、作るとき。

よくあるミスと対処

• WordPress 6.4より前の環境で呼び、未定義の関数のエラーになる。function_exists() で確認する。
• admin_notices フックの外で呼んでいる。
• メッセージのHTMLを、エスケープせずに、渡している。
• type の値を、間違えている。success・error・warning・info。

NG例

wp_admin_notice( $_GET['msg'] ); // 入力を、そのまま出力している

OK例

add_action( 'admin_notices', function () {
	if ( function_exists( 'wp_admin_notice' ) ) {
		wp_admin_notice( esc_html( '保存しました。' ), array( 'type' => 'success', 'dismissible' => true ) );
	}
} );

使い分け早見表

関連項目

admin_notices（フック）()、add_settings_error()

公式リファレンス：wp_admin_notice() | Function | WordPress Developer Resources