Deleting Forms with the GFAPI

Introduction

The GFAPI::delete_form() and GFAPI::delete_forms() methods are used to delete forms.

The GFAPI::delete_form() method is used to delete a single form.

public static function delete_form( $form_id ) {}

This method is located in /includes/api.php.

Param	Type	Description
$form_id	integer	The ID of the form to be deleted.

Boolean, true on success, or a WP_Error instance if an error occurs.

$result = GFAPI::delete_form( $form_id );

The GFAPI::delete_forms() method is used to delete multiple forms.

public static function delete_forms( $form_ids ) {}

This method is located in /includes/api.php.

Param	Type	Description
$form_ids	integer []	An array containing the IDs of the forms to be deleted.

This method does not return a result.

GFAPI::delete_forms( array( $form_1_id, $form_2_id ) );