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

概要

フィルタ cptui_post_types_dropdown_options は、WordPress のプラグイン Custom Post Type UI で使用されるフックです。このフィルタは、カスタム投稿タイプのドロップダウンオプションをカスタマイズするために利用されます。特に、ユーザーが投稿タイプを選択する際に表示されるオプションを変更するのに役立ちます。以下に、このフィルタがよく使われるケースを挙げます。

カスタム投稿タイプの名前を翻訳可能な形式で変更
特定の条件に応じて投稿タイプの表示を制御
デフォルトの投稿タイプリストに追加情報を表示
投稿タイプに基づいてフィルタリングを行う際にオプションを上書き
特定の投稿タイプを管理画面から隠すためのオプション作成
カスタムメタデータと連携して投稿タイプの表示を強化

構文

フィルタの基本的な構文は次の通りです。

add_filter('cptui_post_types_dropdown_options', 'your_custom_function');

パラメータ

$options (配列): ドロップダウンオプションの配列。

戻り値

フィルタリングされたオプションの配列。

プラグインのバージョン

Custom Post Type UI のバージョンは、0.0.1 から対応しています。

ワードプレスのバージョン

WordPress バージョン 4.9 以降で使用可能です。

サンプルコード

サンプルコード 1: 投稿タイプの名前を変更

このコードは、カスタム投稿タイプの名前を「カスタム投稿」に変更します。

add_filter('cptui_post_types_dropdown_options', function($options) {
    if (isset($options['your_custom_post_type'])) {
        $options['your_custom_post_type'] = 'カスタム投稿';
    }
    return $options;
});

サンプルコード 2: 特定の投稿タイプを削除

指定した条件に基づいて、特定の投稿タイプをドロップダウンから削除します。

add_filter('cptui_post_types_dropdown_options', function($options) {
    unset($options['unwanted_post_type']);
    return $options;
});

サンプルコード 3: 投稿タイプの情報を追加

ドロップダウンに投稿タイプの説明を追加します。

add_filter('cptui_post_types_dropdown_options', function($options) {
    foreach ($options as $key => $value) {
        $options[$key] .= ' (説明)';
    }
    return $options;
});

サンプルコード 4: 特定条件に基づくフィルタリング

ユーザーの権限に応じて、表示する投稿タイプを制御します。

add_filter('cptui_post_types_dropdown_options', function($options) {
    if (!current_user_can('manage_options')) {
        unset($options['restricted_post_type']);
    }
    return $options;
});

サンプルコード 5: カスタムメタデータとの連携

特定のメタデータに基づいて、ドロップダウンのオプションを変更します。

add_filter('cptui_post_types_dropdown_options', function($options) {
    if (get_option('some_meta_flag')) {
        $options['special_post_type'] = '特別な投稿';
    }
    return $options;
});

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

アクション	使用例
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

この表に示されている通り、cptui_post_types_dropdown_options フィルタは特定のアクション内で使用されることはありませんが、WordPress のテーマやプラグインの一部として自由に活用できます。

概要

構文