Skip to main content

GravityKit\GravityMigrate\Plugin

Boots GravityMigrate: requirements, admin menu, assets, and the cron cleanups.

Since: 1.0.0

Source: src/Plugin.php:23

Details​

  • Kind: class
  • Namespace: GravityKit\GravityMigrate

Properties​

PropertyTypeDescription
$settingsSettingsSettings instance.
$utilUtilUtil instance.
$external_migrationsExternalMigrations | nullExternal migration registry/controller bootstrap.

Methods​

MethodDescription
__construct()Plugin constructor.
add_gk_submenu()Adds the GravityMigrate item to the GravityKit admin menu, above "Grant Support Access".
get_instance()Returns an instance of the GravityMigrate plugin.
clear_imports()Clears import directory.
reschedule_clear_imports()Re-arms the clear-imports cron for another interval, leaving the staged data in place.
clear_exports()Clears export directory.
check_min_requirements()Checks if minimum requirements are met.
enqueue_assets()Enqueues UI assets.
is_plugin_page()Checks if the current page is the plugin page.
init()Initializes required classes.

Method Reference​

__construct()​

public function __construct()

Plugin constructor.

Source: src/Plugin.php:96

add_gk_submenu()​

public function add_gk_submenu( $submenus )

Adds the GravityMigrate item to the GravityKit admin menu, above "Grant Support Access".

Parameters​

NameTypeDefaultDescription
$submenusarraySubmenus keyed by position.

Returns​

  • array

Since: 1.0.0

Source: src/Plugin.php:168

get_instance()​

public static function get_instance(): Plugin

Returns an instance of the GravityMigrate plugin.

Returns​

  • Plugin

Since: 1.0.0

Source: src/Plugin.php:229

clear_imports()​

public function clear_imports()

Clears import directory.

Returns​

  • void

Since: 1.0.0

Source: src/Plugin.php:244

reschedule_clear_imports()​

public static function reschedule_clear_imports()

Re-arms the clear-imports cron for another interval, leaving the staged data in place.

Returns​

  • void

Since: %ver%

Source: src/Plugin.php:286

clear_exports()​

public function clear_exports()

Clears export directory.

Returns​

  • void

Since: 1.0.0

Source: src/Plugin.php:302

check_min_requirements()​

public function check_min_requirements(): void

Checks if minimum requirements are met.

Returns​

  • void

Since: 1.0.0

Source: src/Plugin.php:326

enqueue_assets()​

public function enqueue_assets(): void

Enqueues UI assets.

Returns​

  • void

Since: 1.0.0

Source: src/Plugin.php:379

is_plugin_page()​

public function is_plugin_page()

Checks if the current page is the plugin page.

Returns​

  • bool

Since: 1.0.0

Source: src/Plugin.php:414

init()​

public function init(): void

Initializes required classes.

Returns​

  • void

Since: 1.0.0

Source: src/Plugin.php:432