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

概要

cptui_user_supports_params フィルタは、WordPressのCustom Post Type UIプラグインによって提供され、カスタム投稿タイプに追加のサポート機能を設定する際に使用されます。このフィルタを利用することで、特定のカスタム投稿タイプに対して、独自の機能を簡単に拡張することが可能です。これにより、ユーザーのニーズに合わせて投稿タイプを細かく調整できます。

このフィルタがよく使われる機能の例としては、以下のようなものがあります：

ユーザーが投稿編集時に特定のメタフィールドにアクセスできるようにする。
カスタム投稿タイプに独自のタクソノミーを関連付ける。
投稿の公開設定や表示オプションをカスタマイズする。
テンプレートファイルを変更して、特定の表示形式を適用する。
権限に基づいてユーザーの投稿操作を制限する。
管理画面でのUI要素を調整する。

フィルタの概要

構文: add_filter( 'cptui_user_supports_params', 'your_function_name', 10, 2 );
パラメータ:
- $supports: サポートする機能の配列。
- $post_type: 対象とするカスタム投稿タイプのスラッグ。
戻り値: 修正されたサポート機能の配列。
使用可能なプラグインバージョン: 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: 特定のカスタム投稿タイプに「thumbnail」機能を追加

add_filter( 'cptui_user_supports_params', function( $supports, $post_type ) {
    if ( 'your_custom_post_type' === $post_type ) {
        $supports[] = 'thumbnail';
    }
    return $supports;
}, 10, 2 );

このサンプルコードでは、特定のカスタム投稿タイプ（your_custom_post_type）にアイキャッチ画像（thumbnail）のサポートを追加します。

サンプル2: 独自のカスタムメタデータを追加

add_filter( 'cptui_user_supports_params', function( $supports, $post_type ) {
    if ( 'your_custom_post_type' === $post_type ) {
        $supports[] = 'custom-fields';
    }
    return $supports;
}, 10, 2 );

このコードでは、指定したカスタム投稿タイプにカスタムフィールドのサポートを追加します。

サンプル3: 投稿のエクス抜出をサポート

add_filter( 'cptui_user_supports_params', function( $supports, $post_type ) {
    if ( 'your_custom_post_type' === $post_type ) {
        $supports[] = 'excerpts';
    }
    return $supports;
}, 10, 2 );

このサンプルソースは、指定されたカスタム投稿タイプに抜粋機能を追加します。

サンプル4: カスタム投稿タイプに「revisions」機能を追加

add_filter( 'cptui_user_supports_params', function( $supports, $post_type ) {
    if ( 'your_custom_post_type' === $post_type ) {
        $supports[] = 'revisions';
    }
    return $supports;
}, 10, 2 );

このコードは、指定したカスタム投稿タイプに修正履歴のサポートを追加します。

サンプル5: カスタム投稿タイプに「author」機能を追加

add_filter( 'cptui_user_supports_params', function( $supports, $post_type ) {
    if ( 'your_custom_post_type' === $post_type ) {
        $supports[] = 'author';
    }
    return $supports;
}, 10, 2 );

このサンプルでは、指定したカスタム投稿タイプが著者情報を持つことをサポートします。

概要