プラグインAdvanced custom fields(ACF)のacf/settings/enable_post_typesフィルタの使用方法・解説

概要

acf/settings/enable_post_typesフィルタは、Advanced Custom Fields (ACF) プラグインでカスタム投稿タイプや分類機能を無効にするために使用されます。具体的には、このフィルタを使用することで、特定の投稿タイプに対するACFフィールドの表示を制御することができます。

よく使われる機能は以下の通りです。

特定のカスタム投稿タイプに対してACFフィールドを無効化
投稿エディタのUIをシンプルに保つためのフィールド制御
プラグインやテーマとの統合を避けるための柔軟なカスタマイズ
不要なフィールドを表示しないことでパフォーマンスを向上
管理画面のエクスペリエンスを向上させるための制御
特定の条件下でのフィールドの表示を動的に管理

構文

add_filter('acf/settings/enable_post_types', 'my_acf_enable_post_types');

function my_acf_enable_post_types($post_types) {
    // カスタム投稿タイプを無効にする条件を設定
    return $post_types;
}

パラメータ

$post_types : 現在有効化されている投稿タイプの配列。この配列を変更して特定の投稿タイプを無効化できます。

戻り値

変更後の投稿タイプの配列。無効にしたい投稿タイプをこの配列から削除します。

対応バージョン

ACFバージョン: 5.0 以上
WordPressバージョン: 4.0 以上

サンプルコード

サンプルコード1: 特定のカスタム投稿タイプを無効にする

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

add_filter('acf/settings/enable_post_types', function($post_types) {
    if (($key = array_search('my_custom_post_type', $post_types)) !== false) {
        unset($post_types[$key]);
    }
    return $post_types;
});

サンプルコード2: 複数のカスタム投稿タイプを無効にする

このコードは、custom_post_1 と custom_post_2 の2つのカスタム投稿タイプを無効にします。

add_filter('acf/settings/enable_post_types', function($post_types) {
    return array_diff($post_types, ['custom_post_1', 'custom_post_2']);
});

サンプルコード3: 投稿タイプごとに条件を付けて無効化

このコードは、ブログの設定に応じてカスタム投稿タイプを無効にします。

add_filter('acf/settings/enable_post_types', function($post_types) {
    if (get_option('disable_custom_fields')) {
        return array_filter($post_types, function($type) {
            return $type !== 'another_custom_post';
        });
    }
    return $post_types;
});

サンプルコード4: 投稿タイプを動的に制御

このコードは、特定の条件（管理者ユーザーでない場合）に基づいてカスタム投稿タイプを無効にします。

add_filter('acf/settings/enable_post_types', function($post_types) {
    if (!current_user_can('administrator')) {
        return array_diff($post_types, ['restricted_post_type']);
    }
    return $post_types;
});

サンプルコード5: カスタム投稿タイプを一括で無効化

このコードは、特定の接頭辞を持つすべてのカスタム投稿タイプを無効にします。

add_filter('acf/settings/enable_post_types', function($post_types) {
    return array_filter($post_types, function($type) {
        return strpos($type, 'prefix_') !== 0; // prefix_で始まらない投稿タイプのみを残す
    });
});

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

アクション	使用可能性
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

概要

構文