GravityKit\GravityMigrate\Abilities\Bundles\ImportBundle
Reads a bundle into this site: forms, entries, Views, the pages that embed them.
Writes into Gravity Forms tables and creates posts, and cannot be undone from here. It refuses rather than clears whenever an import is already running, stuck or crashed, and names what it is importing in its answer.
Since: %ver%
Source: src/Abilities/Bundles/ImportBundle.php:29
Details
- Kind:
class - Namespace:
GravityKit\GravityMigrate\Abilities\Bundles - Extends:
Ability
Methods
| Method | Description |
|---|---|
name() | The ability name, gk-gravitymigrate/{object}-{verb}. |
label() | The short human label, shown in Foundation's settings list. |
description() | What this ability does, written for the agent that has to choose between it and the one |
category() | The category slug, which must be one {@see Bootstrap::categories()} declares. |
input_schema() | JSON Schema for the input. |
output_schema() | JSON Schema for the output. |
annotations() | WordPress's own annotation vocabulary for this ability. |
execute() | Does the work. |
permission() | Whether this caller may run it. |
Method Reference
name()
public static function name(): string
The ability name, gk-gravitymigrate/{object}-{verb}.
Permanent once published: the MCP tool name is derived from it, so renaming one breaks every client already bound to it.
Returns
string
Since: %ver%
Source: src/Abilities/Bundles/ImportBundle.php:55
label()
public static function label(): string
The short human label, shown in Foundation's settings list.
Returns
string
Since: %ver%
Source: src/Abilities/Bundles/ImportBundle.php:62
description()
public static function description(): string
What this ability does, written for the agent that has to choose between it and the one
next to it. It is the only documentation an MCP client ever sees.
Returns
string
Since: %ver%
Source: src/Abilities/Bundles/ImportBundle.php:69
category()
public static function category(): string
The category slug, which must be one {@see Bootstrap::categories()} declares.
Foundation derives gk_scope from the suffix, so only a gk-gravitymigrate-{scope} slug
is reachable through a cross-product scope filter.
Returns
string
Since: %ver%
Source: src/Abilities/Bundles/ImportBundle.php:82
input_schema()
public static function input_schema(): array
JSON Schema for the input.
Returns
array
Since: %ver%
Source: src/Abilities/Bundles/ImportBundle.php:89
output_schema()
public static function output_schema(): array
JSON Schema for the output.
Returns
array
Since: %ver%
Source: src/Abilities/Bundles/ImportBundle.php:131
annotations()
public static function annotations(): array
WordPress's own annotation vocabulary for this ability.
Writes, and not idempotent: importing the same bundle twice imports it twice. Destructive
because gf_settings, gk_settings and rest_api_keys overwrite this site's own rather
than being created beside them.
Returns
array{readonly:bool,— destructive:bool, idempotent:bool}
Since: %ver%
Source: src/Abilities/Bundles/ImportBundle.php:175
execute()
public static function execute( array $input )
Does the work.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$input | array | Input as received. |
Returns
array|\WP_Error
Since: %ver%
Source: src/Abilities/Bundles/ImportBundle.php:190
permission()
public static function permission( array $input=[] )
Whether this caller may run it.
Answered through \GravityKit\GravityMigrate\Migration\Permission, never a bare
current_user_can(): that helper is the one gate the wizard and wp gk migrate also ask.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$input | array | [] | Input as received. |
Returns
bool|\WP_Error
Since: %ver%
Source: src/Abilities/Bundles/ImportBundle.php:304