acf_trash_field_group()


Advanced Custom Fields(ACF)のacf_trash_field_group()関数は、特定のフィールドグループをゴミ箱に移動するために使用されます。この操作はフィールドグループを完全に削除するのではなく、復元可能な状態にします。

構文

acf_trash_field_group( int|string $field_group_id );
  • $field_group_id (int|string) — フィールドグループのIDまたはキー。削除対象のフィールドグループを指定します。

例1: フィールドグループをゴミ箱に移動

指定したIDのフィールドグループをゴミ箱に移動します。

acf_trash_field_group( 123 );

例2: フィールドグループキーを使用して移動

フィールドグループのキーを使用してゴミ箱に移動します。

acf_trash_field_group( 'group_605c3edc7b3a6' );

例3: 動的に取得したフィールドグループを移動

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

$field_group_id = get_field_group_id_by_name( 'example_group' );
acf_trash_field_group( $field_group_id );

例4: 条件に基づいてフィールドグループを移動

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

if ( acf_get_field_group( 'group_605c3edc7b3a6' ) ) {
    acf_trash_field_group( 'group_605c3edc7b3a6' );
}

例5: フィルターを使用してカスタマイズ

特定の条件をフィルターで指定して移動操作をカスタマイズします。

add_filter( 'acf/pre_trash_field_group', function( $field_group ) {
    if ( $field_group['title'] === '削除対象グループ' ) {
        acf_trash_field_group( $field_group['ID'] );
    }
    return $field_group;
} );

注意事項

  • ゴミ箱に移動したフィールドグループは完全に削除されるわけではなく、必要に応じて復元可能です。
  • 適切なIDまたはキーを指定しないとエラーが発生する可能性があります。