GravityKit\GravityMigrate\Platforms\WPForms\WPFormsImporter
Imports WPForms forms into Gravity Forms.
Since: %ver%
Source: src/Platforms/WPForms/WPFormsImporter.php:23
Details
- Kind:
class - Namespace:
GravityKit\GravityMigrate\Platforms\WPForms - Extends:
AbstractImporter
Properties
| Property | Type | Description |
|---|---|---|
$wpforms_form_handler | \WPForms_Form_Handler | null | false | Cached WPForms form handler instance. |
$source_adapter | SourceAdapterInterface | null | Source adapter instance. |
Methods
| Method | Description |
|---|---|
is_available() | Whether the importer can run on the current site (dependencies active, etc). |
list_forms() | Returns a list of importable forms. |
import_form() | Creates the Gravity Forms form for the requested source form. |
prepare_wpforms_form() | Prepares a Gravity Forms payload and metadata describing the import. |
import_wpforms_form() | Imports a WPForms form array directly. |
create_gravity_form_from_prepared() | Finalizes Gravity Forms creation from a prepared payload. |
Method Reference
is_available()
public function is_available(): bool
Whether the importer can run on the current site (dependencies active, etc).
Returns
bool
Since: %ver%
Source: src/Platforms/WPForms/WPFormsImporter.php:61
list_forms()
public function list_forms( array $args=[] ): array
Returns a list of importable forms.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$args | array | [] | Optional request arguments. |
Returns
array— Associative arrays carrying at leastidandtitle.
Since: %ver%
Source: src/Platforms/WPForms/WPFormsImporter.php:68
import_form()
public function import_form( $form_id, array $args=[] )
Creates the Gravity Forms form for the requested source form.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$form_id | mixed | Source form identifier. | |
$args | array | [] | Optional request arguments. |
Returns
array| WP_Error —gravity_form_id,edit_url,preview_urlandwarningsfor the created form, or WP_Error describing the failure.
Since: %ver%
Source: src/Platforms/WPForms/WPFormsImporter.php:170
prepare_wpforms_form()
public function prepare_wpforms_form( array $form_data )
Prepares a Gravity Forms payload and metadata describing the import.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$form_data | array | WPForms form data. |
Returns
array| WP_Error
Since: %ver%
Source: src/Platforms/WPForms/WPFormsImporter.php:284
import_wpforms_form()
public function import_wpforms_form( array $form_data )
Imports a WPForms form array directly.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$form_data | array | WPForms form data. |
Returns
array| WP_Error
Since: %ver%
Source: src/Platforms/WPForms/WPFormsImporter.php:306
create_gravity_form_from_prepared()
public function create_gravity_form_from_prepared( array $prepared, int $source_form_id )
Finalizes Gravity Forms creation from a prepared payload.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$prepared | array | Prepared data from prepare_wpforms_form. | |
$source_form_id | int | Source form identifier. |
Returns
array| WP_Error
Since: %ver%
Source: src/Platforms/WPForms/WPFormsImporter.php:328