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

概要

cptui_below_taxonomy_tab_menu アクションフックは、Custom Post Type UIプラグインでカスタム投稿タイプの管理画面で特定のタブメニューの下に独自のコンテンツを追加するのに使われます。このフックは、ユーザーがカスタム投稿タイプのタクソノミー設定ページを有効化する際によく用いられ、以下のような機能を実装する際に便利です。

カスタムフィールドの追加
説明文やヘルプテキストの追加
他のプラグインとの統合情報の表示
管理者用のカスタム設定セクションの追加
特定条件に基づいた情報表示
タクソノミーの情報を元にしたカスタムメッセージの表示

構文

add_action('cptui_below_taxonomy_tab_menu', 'function_name');

パラメータ

このアクションは特定のパラメータを持っていません。タクソノミーの設定ページでのみ実行されます。

戻り値

このアクション自体は何も戻り値を返しません。フック内で行った処理はHTMLとして出力され、管理画面に追加されます。

使用可能なプラグインおよびワードプレスのバージョン

Custom Post Type UIのバージョン: 1.9.0以上
WordPressのバージョン: 5.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_below_taxonomy_tab_menu', function() {
    echo '<div class="custom-help-text">ここにカスタムヘルプテキストを記載します。</div>';
});

このコードは、タクソノミー設定ページの下にカスタムのヘルプテキストを追加します。

サンプルコード2: タクソノミー関連情報の表示

add_action('cptui_below_taxonomy_tab_menu', function() {
    $taxonomy = get_current_screen()->taxonomy;
    echo '<p>現在のタクソノミー: ' . esc_html($taxonomy) . '</p>';
});

このコードは、現在のタクソノミーのスラッグを表示します。

サンプルコード3: 設定に基づくメッセージの表示

add_action('cptui_below_taxonomy_tab_menu', function() {
    $setting = get_option('my_custom_setting');
    if ($setting) {
        echo '<p>' . esc_html($setting) . '</p>';
    }
});

このコードは、特定の設定オプションの値に基づいてメッセージを表示します。

サンプルコード4: 統計情報の表示

add_action('cptui_below_taxonomy_tab_menu', function() {
    $count = wp_count_terms('my_custom_taxonomy');
    echo '<p>このタクソノミーには ' . esc_html($count) . ' 件の項目があります。</p>';
});

このコードは、特定のタクソノミーに関連する項目の数を表示します。

サンプルコード5: カスタムフィールドの説明を追加

add_action('cptui_below_taxonomy_tab_menu', function() {
    echo '<h3>カスタムフィールドの説明</h3>';
    echo '<p>このタクソノミーに関連するカスタムフィールドの設定を行います。</p>';
});

このコードは、タクソノミー設定ページにカスタムフィールドの説明を追加します。

概要

構文