プラグインCustom Post Type UIのcptui_custom_debug_info関数の使用方法・解説

概要

cptui_custom_debug_info 関数は、WordPressのCustom Post Type UIプラグインによって提供されるデバッグ情報を表示するための関数です。この関数は、カスタム投稿タイプの設定や状態を確認する際に役立ちます。主に以下のような場合に活用されます。

カスタム投稿タイプの登録状況を確認する。
既存のカスタム投稿タイプの情報を取得する。
プラグインの互換性をデバッグする。
より効率的にデバッグ情報を表示する。
設定ミスを迅速に特定する。
開発時のエラーハンドリングを支援する。

構文

cptui_custom_debug_info();

パラメータ

この関数にはパラメータはありません。

戻り値

この関数は、カスタム投稿タイプのデバッグ情報を表示しますが、戻り値はありません。

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

Custom Post Type UI: バージョン 1.10.0以上
WordPress: バージョン 4.8以上

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

アクション	使用可能
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('admin_init', 'display_cptui_debug_info');

function display_cptui_debug_info() {
    if (current_user_can('manage_options')) {
        cptui_custom_debug_info(); // デバッグ情報を出力
    }
}

このサンプルコードは、管理者が管理画面に入った際にカスタム投稿タイプのデバッグ情報を表示します。

サンプル 2

// テーマのfunctions.phpに追加
function my_custom_cpt_debug() {
    if (function_exists('cptui_custom_debug_info')) {
        cptui_custom_debug_info(); // カスタム投稿タイプ情報を取得
    }
}
add_action('wp_footer', 'my_custom_cpt_debug');

このサンプルは、サイトのフッターにカスタム投稿タイプのデバッグ情報を表示します。

サンプル 3

// ユーザー権限に基づきデバッグ情報を表示
add_action('admin_menu', function() {
    if (current_user_can('administrator')) {
        cptui_custom_debug_info(); // 管理者のみデバッグ情報を出力
    }
});

このコードは、管理者のみがカスタム投稿タイプのデバッグ情報を表示できるように設定しています。

サンプル 4

// shortcodeを作成してカスタム投稿タイプのデバッグ情報を表示
add_shortcode('cptui_debug', function() {
    ob_start();
    cptui_custom_debug_info(); // カスタム投稿タイプのデバッグ情報を取得
    return ob_get_clean();
});

このサンプルは、ショートコード [cptui_debug] を作成して、カスタム投稿タイプのデバッグ情報を表示します。

サンプル 5

// WP REST APIエンドポイントでデバッグ情報を取得
add_action('rest_api_init', function() {
    register_rest_route('custom/v1', '/debug/', array(
        'methods'  => 'GET',
        'callback' => 'cptui_custom_debug_info' // エンドポイントが呼ばれるとデバッグ情報を出力
    ));
});

このサンプルでは、REST APIのエンドポイントを作成し、そのエンドポイントにアクセスするとカスタム投稿タイプのデバッグ情報を取得できるようにしています。

概要

構文