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

概要

cptui_disable_cptは、WordPressプラグイン「Custom Post Type UI」において、カスタム投稿タイプの登録を制御するためのフィルタです。このフィルタを使用することで、特定のカスタム投稿タイプの登録を無効にすることができます。以下はこのフィルタがよく使われる機能の例です。

不要なカスタム投稿タイプの無効化
特定のユーザーにのみ利用可能なカスタム投稿タイプの制御
テーマやプラグインの特定の条件に基づくカスタム投稿タイプの非表示
プラグインの互換性を考慮したカスタム投稿タイプの調整
カスタム投稿タイプのアクセス制御
バージョン管理のためのカスタム投稿タイプの廃止

フィルタの概要

構文: add_filter( 'cptui_disable_cpt', 'your_custom_function' );
パラメータ: cptui_disable_cptのフィルタは、無効にするカスタム投稿タイプの配列を受け取ります。
戻り値: 無効にするカスタム投稿タイプの配列を返す必要があります。
バージョン: 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: 特定のカスタム投稿タイプを無効化する

add_filter('cptui_disable_cpt', function($post_types) {
    $post_types[] = 'portfolio'; // "portfolio" というカスタム投稿タイプを無効化
    return $post_types;
});

このコードは、「portfolio」というカスタム投稿タイプを無効化します。

サンプル2: 特定の条件下でカスタム投稿タイプを無効化

add_filter('cptui_disable_cpt', function($post_types) {
    if (is_admin()) {
        $post_types[] = 'events'; // 管理画面では "events" 投稿タイプを無効化
    }
    return $post_types;
});

このコードは、管理画面でのみ「events」というカスタム投稿タイプを無効化します。

サンプル3: 特定のユーザー権限がある場合に無効化

add_filter('cptui_disable_cpt', function($post_types) {
    if (!current_user_can('administrator')) {
        $post_types[] = 'testimonials'; // 管理者以外は "testimonials" 投稿タイプを無効化
    }
    return $post_types;
});

このコードは、管理者以外のユーザーが「testimonials」カスタム投稿タイプにアクセスできなくします。

サンプル4: プラグインが有効な場合に無効化

add_filter('cptui_disable_cpt', function($post_types) {
    if (is_plugin_active('some-plugin/some-plugin.php')) {
        $post_types[] = 'products'; // 特定のプラグインが有効な場合、"products"を無効化
    }
    return $post_types;
});

このコードは、特定のプラグインが有効な場合に「products」というカスタム投稿タイプを無効化します。

サンプル5: ユーザーのロールによって異なる無効化

add_filter('cptui_disable_cpt', function($post_types) {
    if (user_can(get_current_user_id(), 'editor')) {
        $post_types[] = 'news'; // 編集者ロールのユーザーがいる場合、 "news" 投稿タイプを無効化
    }
    return $post_types;
});

このコードは、編集者ロールを持つユーザーがいる場合、「news」というカスタム投稿タイプを無効化します。

以上のサンプルはそれぞれ異なる条件や状況でカスタム投稿タイプを無効化する方法を示しています。

概要