Automattic\WooCommerce\Blueprint\Steps

InstallPlugin::get_schema │ public static │ WC 1.0

Returns the schema for the JSON representation of this step.

Method of the class: InstallPlugin{}

No Hooks.

Returns

Array. The schema array.

Usage

$result = InstallPlugin::get_schema( $version ): array;

$version(int)

The version of the schema to return.
Default: 1

InstallPlugin::get_schema() InstallPlugin::get schema code ^{WC 10.7.0}

public static function get_schema( int $version = 1 ): array {
	return array(
		'type'       => 'object',
		'properties' => array(
			'step'       => array(
				'type' => 'string',
				'enum' => array( static::get_step_name() ),
			),
			'pluginData' => array(
				'anyOf' => array(
					require __DIR__ . '/schemas/definitions/VFSReference.php',
					require __DIR__ . '/schemas/definitions/LiteralReference.php',
					require __DIR__ . '/schemas/definitions/CorePluginReference.php',
					require __DIR__ . '/schemas/definitions/CoreThemeReference.php',
					require __DIR__ . '/schemas/definitions/UrlReference.php',
					require __DIR__ . '/schemas/definitions/GitDirectoryReference.php',
					require __DIR__ . '/schemas/definitions/DirectoryLiteralReference.php',
				),
			),
			'options'    => array(
				'type'       => 'object',
				'properties' => array(
					'activate' => array(
						'type' => 'boolean',
					),
				),
			),
		),
		'required'   => array( 'step', 'pluginData' ),
	);
}