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

概要

cptui_main_page_after_headerは、WordPressのCustom Post Type UIプラグインにおいて、カスタム投稿タイプの管理ページのヘッダーの後にフックされるアクションです。このアクションは、ユーザーがCustom Post Typeの設定を行う際に、追加情報や操作を提供するためによく使われます。具体的には以下のような機能を実装する際に利用されることが一般的です：

カスタム設定オプションのインターフェースを追加する
ユーザーへのヒントやガイドを表示する
カスタム投稿タイプに関連する統計情報を表示する
その他のプラグインのインターフェースと統合する
管理者向けの通知メッセージを表示する
サポートリンクや問い合わせボタンを追加する

構文

add_action('cptui_main_page_after_header', 'your_function_name');

パラメータ

cptui_main_page_after_headerにはパラメータはありません。

戻り値

このアクションは値を返しません。出力を行うために使用されます。

使用可能なバージョン

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: ヒントメッセージを表示する

function add_custom_notice() {
    echo '<div class="notice notice-info"><p>カスタム投稿タイプの追加・設定を行う際は、必要な情報を入力してください。</p></div>';
}
add_action('cptui_main_page_after_header', 'add_custom_notice');

このサンプルコードは、カスタム投稿タイプの設定ページに、利用者に対して必要な情報を入力するよう案内するインフォメーションボックスを表示します。

サンプルコード 2: 開発者向けのリンクを追加する

function add_developer_links() {
    echo '<div class="dev-links"><a href="https://example.com/docs">ドキュメント</a> | <a href="https://example.com/support">サポート</a></div>';
}
add_action('cptui_main_page_after_header', 'add_developer_links');

このコードは、カスタム投稿タイプの設定ページの後にドキュメントやサポートへのリンクを追加します。

サンプルコード 3: 統計情報を表示する

function display_post_count() {
    $count = wp_count_posts('your_custom_post_type');
    echo '<div class="post-count">現在のカスタム投稿数: ' . $count->publish . '</div>';
}
add_action('cptui_main_page_after_header', 'display_post_count');

この例では、特定のカスタム投稿タイプの総数を表示します。これにより、ユーザーは投稿数を簡単に把握できます。

サンプルコード 4: プラグイン間の統合を提示する

function show_related_plugins() {
    echo '<div class="related-plugins">関連プラグイン: <a href="https://example.com">関連プラグイン名</a></div>';
}
add_action('cptui_main_page_after_header', 'show_related_plugins');

このサンプルは、他の関連プラグインへのリンクを表示し、ユーザーが関連情報を容易に得られるようにします。

サンプルコード 5: 管理者通知を追加する

function add_admin_alert() {
    if ( current_user_can('administrator') ) {
        echo '<div class="notice notice-warning">注意: 新しいカスタム投稿タイプを作成する前に、全てのフィールドを確認してください。</div>';
    }
}
add_action('cptui_main_page_after_header', 'add_admin_alert');

このコードは、管理者権限を持つユーザーに対して特定の注意メッセージを表示します。これにより、大事な情報が特定のユーザーに目に留まるようになります。

概要

構文