ACF before_delete_field_group action

The before_delete_field_group action in Advanced Custom Fields (ACF) allows you to perform custom actions before a field group is deleted. This can be useful if you need to clean up any related data or perform any other tasks before the field group is removed.

To use the before_delete_field_group action, you can add your own custom function and hook it into the action using the add_action() function. Here’s an example:

function wpsnippets_before_delete_field_group( $group_id ) {
    // Perform custom actions before the field group is deleted
    // You can access the $group_id parameter to get information about the field group being deleted
}
add_action( 'before_delete_field_group', 'wpsnippets_before_delete_field_group' );

In the example above, the wpsnippets_before_delete_field_group function is hooked into the before_delete_field_group action using add_action(). Inside the function, you can add your own custom code to perform any actions you need before the field group is deleted.

Remember to replace wpsnippets_before_delete_field_group with your own unique function name to avoid conflicts with other functions.

This code snippet can be useful in scenarios where you need to perform specific tasks or cleanup operations before a field group is deleted in ACF. For example, you might want to delete related data or update other records in your database when a field group is removed.

Examples

Example 1: Removing custom data when a field group is deleted

This use case demonstrates how to use the before_delete_field_group action in Advanced Custom Fields (ACF) to remove any custom data associated with a field group when it is deleted.

add_action( 'before_delete_field_group', 'wpsnippets_remove_custom_data', 10, 1 );

function wpsnippets_remove_custom_data( $group ) {
    // Get the field group ID
    $group_id = $group['ID'];

    // Remove custom data associated with the field group
    delete_post_meta( $group_id, 'custom_data_key' );
}

In this code example, we hook into the before_delete_field_group action using the add_action function. When the action is triggered, the wpsnippets_remove_custom_data function is called with the field group as the parameter. Inside the function, we retrieve the field group ID and use it to delete any custom data associated with the field group using the delete_post_meta function.

Example 2: Logging field group deletion

This use case demonstrates how to use the before_delete_field_group action in ACF to log the deletion of a field group.

add_action( 'before_delete_field_group', 'wpsnippets_log_field_group_deletion', 10, 1 );

function wpsnippets_log_field_group_deletion( $group ) {
    // Get the field group title
    $group_title = $group['title'];

    // Log the deletion in a custom log file
    error_log( 'Field group "' . $group_title . '" deleted.' );
}

In this code example, we hook into the before_delete_field_group action using the add_action function. When the action is triggered, the wpsnippets_log_field_group_deletion function is called with the field group as the parameter. Inside the function, we retrieve the field group title and log the deletion message, including the title, to a custom log file using the error_log function.

Example 3: Preventing field group deletion

This use case demonstrates how to use the before_delete_field_group action in ACF to prevent the deletion of a specific field group.

add_action( 'before_delete_field_group', 'wpsnippets_prevent_field_group_deletion', 10, 1 );

function wpsnippets_prevent_field_group_deletion( $group ) {
    // Get the field group ID
    $group_id = $group['ID'];

    // Check if the field group should not be deleted
    if ( $group_id === 123 ) {
        wp_die( 'This field group cannot be deleted.' );
    }
}

In this code example, we hook into the before_delete_field_group action using the add_action function. When the action is triggered, the wpsnippets_prevent_field_group_deletion function is called with the field group as the parameter. Inside the function, we retrieve the field group ID and check if it matches the ID of the field group that should not be deleted. If it matches, we use the wp_die function to display an error message and prevent the deletion of the field group.