delete_sub_field()

Description

Deletes the value of a specific sub field.

This function can be used inside or outside of a have_rows() loop. When used inside, the current row will be used to delete the sub field value. When used outside, the rows and parents must be specified to target the correct value place.

Parameters

delete_sub_field($selector, [$post_id]);
  • $selector (string|array) (Required) The sub field name or key, or an array of ancestors and row numbers.
  • $post_id (mixed) (Optional) The post ID where the value is saved. Defaults to the current post.

Return

(bool) True on successful deletion, false on failure.

Change Log

  • Added in version 5.0.0

Examples

Delete a sub field inside of a have_rows() loop

This example shows how to loop through a Repeater field and delete one of its sub field values from each row.

if( have_rows('repeater') ) {
    while( have_rows('repeater') ) {
        the_row();
        delete_sub_field('caption');
    }
}

Delete a sub field outside of a have_rows() loop

This example shows how to delete a sub field value outside of a have_rows() loop. Here, the $selector parameter is provided an array containing a mixture of field names and row numbers. This array should read from left to right, the parents to children relationship separated by the row number.

Please see notes regarding index offset.

// Delete "caption" within the first row of "repeater".
delete_sub_field( array('repeater', 1, 'caption') );

Delete a nested sub field

The delete_sub_field() function can also be used to target a nested sub field both inside and outside of a have_rows() loop. This example shows how to delete a nested sub field function using both methods.

// Loop over parent rows.
if( have_rows('repeater') ) {
    while( have_rows('repeater') ) {
        the_row();

        // Loop over child rows.
        if( have_rows('sub_repeater') ) {
            while( have_rows('sub_repeater') ) {
                the_row();

                // Delete nested sub field value.
                delete_sub_field('sub_sub_field');
            }
        }
    }
}

// target a nested sub field directly.
delete_sub_field( array('repeater', 1, 'sub_repeater', 2, 'sub_sub_field') );

Notes

Index offset

When targeting a sub field using a specific row number, please note that row numbers begin from 1 and not 0. This means that the first row has an index of 1, the second row has an index of 2, and so on.

To begin indexes from 0, please use the row_index_offset setting like so.

functions.php

add_filter('acf/settings/row_index_offset', '__return_zero');

We use cookies to offer you a better browsing experience, analyze site traffic and personalize content. Read about how we use cookies and how you can control them in our Cookie Policy. If you continue to use this site, you consent to our use of cookies.