概要
wp_get_admin_notice 関数は、WordPressの管理画面における通知HTMLマークアップを取得するために使用されます。この関数は、特定の条件や状況に応じたメッセージを管理画面に表示する際によく利用されます。以下のような機能を実装する際に役立ちます：
- プラグインのインストールや更新を通知する
- システム要件の不足を警告する
- セキュリティインシデントへの注意を呼びかける
- カスタム設定の完了を知らせる
- 緊急のメンテナンスや変更のお知らせを表示する
- ユーザーの役に立つヒントやアドバイスを提供する
- テーマやプラグインの互換性に関する情報を提供する
- フィードバックや評価を促す通知を表示する
構文
wp_get_admin_notice( $message, $type = 'info' );
パラメータ
$message(string): 表示するメッセージ内容。$type(string): 通知の種類（例：’info’, ‘warning’, ‘error’, ‘success’）。デフォルトは ‘info’。
戻り値
- (string): 管理画面の通知HTMLマークアップが返されます。
関連する関数
使用可能なバージョン
- WordPress 5.0以降
コアファイルのパス
wp-includes/protocols.php
この関数のアクションでの使用可能性
| アクション | 使用可否 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
サンプルコード
サンプルコード1: 基本的な通知の表示
function my_custom_admin_notice() {
echo wp_get_admin_notice( 'このメッセージはカスタム通知です。', 'info' );
}
add_action( 'admin_notices', 'my_custom_admin_notice' );
このサンプルコードは、管理画面にカスタム情報通知を表示します。
サンプルコード2: エラーメッセージの表示
function my_error_admin_notice() {
echo wp_get_admin_notice( 'エラーが発生しました。もう一度お試しください。', 'error' );
}
add_action( 'admin_notices', 'my_error_admin_notice' );
このコードは、エラー通知を管理画面に表示します。
サンプルコード3: 警告メッセージの表示
function my_warning_admin_notice() {
echo wp_get_admin_notice( '警告: システムの更新が必要です。', 'warning' );
}
add_action( 'admin_notices', 'my_warning_admin_notice' );
このサンプルは、警告メッセージを管理画面に表示するものです。
サンプルコード4: 成功メッセージの表示
function my_success_admin_notice() {
echo wp_get_admin_notice( '処理が成功しました！', 'success' );
}
add_action( 'admin_notices', 'my_success_admin_notice' );
このコードは、成功メッセージを管理画面に表示します。
サンプルコード5: 条件付き通知の表示
function my_conditional_admin_notice() {
if ( ! current_user_can( 'manage_options' ) ) {
echo wp_get_admin_notice( 'この通知は管理者にのみ表示されます。', 'info' );
}
}
add_action( 'admin_notices', 'my_conditional_admin_notice' );
このコードは、特定のユーザー権限を持っていない場合に通知を表示します。