プラグインCustom Post Type UIのcptui_no_post_types_listingフィルタの使用方法・解説

概要

cptui_no_post_types_listingフィルタは、Custom Post Type UIプラグインで定義されたカスタム投稿タイプの一覧表示を制御するためのフックです。このフィルタを使用することで、特定のカスタム投稿タイプが管理画面の投稿一覧に表示されるかどうかを制御できます。例えば、特定のロールに対して特定の投稿タイプを隠したり、特定の条件下で投稿タイプの表示を変更したりするのに役立ちます。

このフィルタを利用する際に考慮すべき機能は以下の通りです。

ユーザーのロールに基づいて特定の投稿タイプを非表示にする
特定のカスタム投稿タイプを管理画面から隠す
条件によって表示する投稿タイプを動的に変更する
管理画面の可視性をカスタマイズする
フロントエンドの表示条件を制御する
デザインや機能性の向上に役立つ

このフィルタは、Custom Post Type UIプラグインのバージョンに依存することなく使用可能です。また、WordPressのバージョンは4.0以降の適切なバージョンに対応しています。

構文

フィルタの構文は次の通りです。

add_filter('cptui_no_post_types_listing', 'my_custom_function');

パラメータ

$post_types：表示される投稿タイプの配列。

戻り値

返される値は、非表示にしたい投稿タイプを含む配列です。

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

アクション	使用可能性
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_filter('cptui_no_post_types_listing', function($post_types) {
    if (current_user_can('editor')) {
        $post_types[] = 'my_custom_post_type';
    }
    return $post_types;
});

説明: このコードは、現在のユーザーが「editor」ロールの時にカスタム投稿タイプ「my_custom_post_type」を隠すものです。

サンプルコード2

add_filter('cptui_no_post_types_listing', function($post_types) {
    if (is_admin() && isset($_GET['page']) && $_GET['page'] === 'my_custom_page') {
        $post_types[] = 'another_custom_post_type';
    }
    return $post_types;
});

説明: このコードは、管理画面に特定のページ（「my_custom_page」）が表示されているときに、別のカスタム投稿タイプ「another_custom_post_type」を隠します。

サンプルコード3

add_filter('cptui_no_post_types_listing', function($post_types) {
    if ($_SERVER['SERVER_NAME'] === 'example.com') {
        $post_types[] = 'hidden_post_type';
    }
    return $post_types;
});

説明: サブドメイン「example.com」でアクセスされた場合、カスタム投稿タイプ「hidden_post_type」を隠します。

サンプルコード4

add_filter('cptui_no_post_types_listing', function($post_types) {
    $current_time = time();
    if ($current_time < strtotime('2023-01-01')) {
        $post_types[] = 'temporary_post_type';
    }
    return $post_types;
});

説明: 現在の時間が2023年1月1日以前の場合、カスタム投稿タイプ「temporary_post_type」を隠すことができます。

サンプルコード5

add_filter('cptui_no_post_types_listing', function($post_types) {
    if (is_user_logged_in()) {
        $post_types[] = 'restricted_post_type';
    }
    return $post_types;
});

説明: ログインしているユーザーがいる場合、カスタム投稿タイプ「restricted_post_type」を隠します。

概要

構文