プラグインCustom Post Type UIのcptui_admin_noticeアクションの使用方法・解説

概要

cptui_admin_noticeは、WordPressプラグインCustom Post Type UIに関連するフックで、プラグインの管理画面で特定の通知メッセージを表示するために使用されます。このアクションは、管理者が特定の状況に応じてユーザーにメッセージを表示したい際に便利です。例えば、カスタム投稿タイプを正常に作成した、または特定の設定が更新されたといった情報をユーザーに知らせるために利用されます。

このフックは、以下のようなシナリオでよく使用されます。

カスタム投稿タイプの作成成功メッセージの表示
プラグインの更新完了通知
エラーメッセージの表示（設定ミスなど）
プラグイン設定の変更成功の表示
ユーザーに対する重要な情報や注意喚起
インストール手順の案内やサポート情報の告知

構文

add_action('cptui_admin_notice', 'your_custom_function');

パラメータ

cptui_admin_noticeアクションは、特定のパラメータを持たず、フック内で独自に処理を実行します。

戻り値

このアクションは戻り値を持たず、主に画面出力を目的として使用されます。

使用可能なプラグイン/バージョン

Custom Post Type UI: バージョン 1.0 以上
WordPress: バージョン 4.0 以上

この関数のアクションでの使用可能性

アクション名	使用例
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: カスタム投稿タイプ作成成功メッセージ

add_action('cptui_admin_notice', function() {
    echo '<div class="notice notice-success is-dismissable"><p>カスタム投稿タイプが正常に作成されました！</p></div>';
});

このコードは、カスタム投稿タイプが正常に作成された際に成功メッセージを表示します。

サンプルコード 2: 更新完了の通知

add_action('cptui_admin_notice', function() {
    echo '<div class="notice notice-info"><p>Custom Post Type UIが更新されました！新しい機能をお楽しみください。</p></div>';
});

このコードは、プラグインが更新されたことを通知するメッセージを表示します。

サンプルコード 3: 設定変更成功メッセージ

add_action('cptui_admin_notice', function() {
    if (isset($_GET['settings-updated'])) {
        echo '<div class="notice notice-success"><p>設定が正常に更新されました。</p></div>';
    }
});

このコードは、管理画面で設定が更新された場合に成功メッセージを表示します。

サンプルコード 4: エラーメッセージの表示

add_action('cptui_admin_notice', function() {
    if (some_error_condition()) {
        echo '<div class="notice notice-error"><p>エラーが発生しました: 正しい情報を入力してください。</p></div>';
    }
});

このコードは、特定のエラー条件を満たした場合にエラーメッセージを表示します。

サンプルコード 5: サポート情報の提供

add_action('cptui_admin_notice', function() {
    echo '<div class="notice notice-warning"><p>カスタム投稿タイプの管理でお困りですか？サポートページをご覧ください。</p></div>';
});

このコードは、ユーザーに対してサポート情報を提供する警告メッセージを表示します。

概要

構文