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

概要

cptui_user_supports_paramsフィルタは、WordPressのCustom Post Type UIプラグインに関連するフックで、新しいカスタム投稿タイプを作成する際にサポートする機能を変更するためのものです。このフィルタを利用することで、ユーザーが特定の機能を持つカスタム投稿タイプを作成できるようにカスタマイズできます。

このフィルタは以下のような機能を実装する際によく使用されます。
1. タクソノミーのカスタマイズ
2. 投稿のサポート機能の追加（例：アイキャッチ画像）
3. カスタムメタボックスの設定
4. 権限管理の強化
5. カスタム編集画面の追加
6. ショートコードのサポート設定

構文

add_filter('cptui_user_supports_params', 'your_function_name', 10, 2);

パラメータ

$supports: サポートする機能の配列。
$post_type: カスタム投稿タイプの名前。

戻り値

修正されたサポート機能の配列。

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

Custom Post Type UI: 1.0.0以上（例）

使用可能なWordPressのバージョン

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_user_supports_params', 'custom_post_type_supports', 10, 2);

function custom_post_type_supports($supports, $post_type) {
    if ($post_type == 'custom_type') {
        $supports[] = 'custom-fields'; // カスタムフィールドをサポート
    }
    return $supports;
}

このサンプルは、特定のカスタム投稿タイプ（custom_type）に対してカスタムフィールドを追加でサポートします。

サンプルコード 2

add_filter('cptui_user_supports_params', 'add_thumbnail_support', 10, 2);

function add_thumbnail_support($supports, $post_type) {
    if ($post_type == 'portfolio') {
        $supports[] = 'thumbnail'; // アイキャッチ画像をサポート
    }
    return $supports;
}

このサンプルは、portfolioというカスタム投稿タイプに対してアイキャッチ画像のサポートを追加します。

サンプルコード 3

add_filter('cptui_user_supports_params', 'enable_excerpt_support', 10, 2);

function enable_excerpt_support($supports, $post_type) {
    if ($post_type == 'event') {
        $supports[] = 'excerpt'; // 抜粋をサポート
    }
    return $supports;
}

このサンプルは、eventというカスタム投稿タイプに抜粋のサポートを追加するものです。

サンプルコード 4

add_filter('cptui_user_supports_params', 'add_custom_revisions', 10, 2);

function add_custom_revisions($supports, $post_type) {
    if ($post_type == 'review') {
        $supports[] = 'revisions'; // リビジョンをサポート
    }
    return $supports;
}

このサンプルは、リビジョン機能をreviewというカスタム投稿タイプに追加するためのものです。

サンプルコード 5

add_filter('cptui_user_supports_params', 'enable_slug_support', 10, 2);

function enable_slug_support($supports, $post_type) {
    if ($post_type == 'gallery') {
        $supports[] = 'slug'; // スラッグのサポートを追加
    }
    return $supports;
}

このサンプルは、galleryというカスタム投稿タイプにスラッグサポートを追加するものです。

概要

構文