acf_trash_field()

Advanced Custom Fields (ACF) プラグインの acf_trash_field() 関数は、特定のフィールドをゴミ箱に移動するために使用されます。この関数を使用することで、フィールドを削除せずに一時的に無効化することができます。

構文

acf_trash_field( $field_key );

• $field_key (string) — フィールドの一意のキー。このキーを指定することで特定のフィールドをゴミ箱に移動します。

例 1. フィールドをゴミ箱に移動する

特定のキーを持つフィールドをゴミ箱に移動します。

acf_trash_field( 'field_123abc' );

例 2. 動的にフィールドをゴミ箱に移動する

フィールドキーを動的に取得してゴミ箱に移動します。

$field_key = get_field_object( 'custom_field' )['key'];
acf_trash_field( $field_key );

例 3. 条件付きでフィールドをゴミ箱に移動する

フィールドが存在する場合のみゴミ箱に移動します。

if ( get_field_object( 'custom_field' ) ) {
    acf_trash_field( 'field_456def' );
}

例 4. カスタムポストタイプのフィールドをゴミ箱に移動する

特定のカスタム投稿タイプに関連付けられたフィールドを移動します。

if ( get_post_type() === 'custom_post_type' ) {
    acf_trash_field( 'field_789ghi' );
}

例 5. バッチ処理で複数のフィールドをゴミ箱に移動する

複数のフィールドキーを繰り返し処理してゴミ箱に移動します。

$fields = ['field_123abc', 'field_456def', 'field_789ghi'];
foreach ( $fields as $field_key ) {
    acf_trash_field( $field_key );
}

注意事項

• acf_trash_field() 関数はフィールドを完全に削除するのではなく、非アクティブ化するためのものです。
• ゴミ箱に移動したフィールドは管理画面で再び有効化できます。
• 不適切なフィールドキーを指定するとエラーが発生する可能性があるため、事前にキーの存在を確認してください。