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

概要

cptui_admin_noticeは、WordPressプラグイン「Custom Post Type UI」に関連するアクションフックで、管理画面にカスタム通知メッセージを表示する際に使用されます。このフックは、ユーザーに注意を促したり、特定の情報を提供したりするためによく使用されます。以下は、このアクションが使用される具体的な状況の例です。

プラグインの設定が変更された際の確認メッセージ
カスタム投稿タイプの設定が成功したことを示す通知
プラグインの新機能についての情報提供
カスタム投稿タイプの作成後の再表示メッセージ
インストール手順のアドバイスを表示するため
エラーや警告メッセージを表示するため

このアクションの呼び出し構文は以下のようになります。

do_action('cptui_admin_notice');

構文

do_action('cptui_admin_notice');

パラメータ

なし（デフォルトのアクションとして呼び出されます）

戻り値

なし

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

Custom Post Type UIのバージョン: 1.0以降

使用可能なWordPressバージョン

WordPressのバージョン: 4.5以降

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

アクション	使用例
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', 'my_custom_admin_notice');
function my_custom_admin_notice() {
    ?>
    <div class="notice notice-success is-dismissible">
        <p><?php _e('Custom Post Type has been created successfully!', 'textdomain'); ?></p>
    </div>
    <?php
}

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

サンプルコード2

add_action('cptui_admin_notice', 'my_setup_notice');
function my_setup_notice() {
    if ( ! get_option('cptui_setup_complete') ) {
        ?>
        <div class="notice notice-warning">
            <p><?php _e('Please complete the setup for the Custom Post Type UI plugin.', 'textdomain'); ?></p>
        </div>
        <?php
    }
}

このコードは、プラグインのセットアップが未完了の場合に警告メッセージを表示します。

サンプルコード3

add_action('cptui_admin_notice', 'my_feature_notice');
function my_feature_notice() {
    ?>
    <div class="notice notice-info">
        <p><?php _e('Check out the new features in the latest version!', 'textdomain'); ?></p>
    </div>
    <?php
}

このコードは、プラグインの最新バージョンに新機能が追加されたことをユーザーに知らせる情報メッセージを表示します。

サンプルコード4

add_action('cptui_admin_notice', 'my_error_notice');
function my_error_notice() {
    if ( isset($_GET['error']) ) {
        ?>
        <div class="notice notice-error">
            <p><?php _e('There was an error processing your request!', 'textdomain'); ?></p>
        </div>
        <?php
    }
}

このコードは、エラーが発生した場合にエラーメッセージを表示します。

サンプルコード5

add_action('cptui_admin_notice', 'my_instruction_notice');
function my_instruction_notice() {
    ?>
    <div class="notice notice-info">
        <p><?php _e('To add a new Custom Post Type, navigate to the settings page.', 'textdomain'); ?></p>
    </div>
    <?php
}

このコードは、新しいカスタム投稿タイプを追加するための指示メッセージを表示します。

概要

構文