Automattic\WooCommerce\Blueprint\Steps

SetSiteOptions{} │ WC 1.0└─ Step

Set site options step.

No Hooks.

Usage

$SetSiteOptions = new SetSiteOptions();
// use class methods

Methods

1. public __construct( array $options = array() )
2. public static get_schema( int $version = 1 )
3. public static get_step_name()
4. public prepare_json_array()

SetSiteOptions{} SetSiteOptions{} code ^{WC 10.6.2}

class SetSiteOptions extends Step {
	/**
	 * Site options.
	 *
	 * @var array site options
	 */
	private array $options;

	/**
	 * Constructor.
	 *
	 * @param array $options site options.
	 */
	public function __construct( array $options = array() ) {
		$this->options = $options;
	}

	/**
	 * Get the name of the step.
	 *
	 * @return string step name
	 */
	public static function get_step_name(): string {
		return 'setSiteOptions';
	}

	/**
	 * Get the schema for the step.
	 *
	 * @param int $version schema version.
	 *
	 * @return array schema for the step
	 */
	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() ),
				),

			),
			'required'   => array( 'step' ),
		);
	}

	/**
	 * Prepare the step for JSON serialization.
	 *
	 * @return array array representation of the step
	 */
	public function prepare_json_array(): array {
		return array(
			'step'    => static::get_step_name(),
			'options' => (object) $this->options,
		);
	}
}