WooCommerce Code Reference

Onboarding extends DeprecatedClassFacade
in package

Contains backend logic for the onboarding profile and checklist feature.

Tags
deprecated

since 6.3.0, use WooCommerce\Internal\Admin\Onboarding.

Table of Contents

$deprecated_in_version  : string
The version that this class was deprecated in.
$facade_over_classname  : string
The name of the non-deprecated class that this facade covers.
$instance  : object
The instance that this facade covers over.
$logged_messages  : array<string|int, mixed>
Static array of logged messages.
__call()  : mixed
Executes when calling any function on an instance of this class.
__callStatic()  : mixed
Executes when calling any static function on this class.
__construct()  : mixed
Hook into WooCommerce.
get_allowed_industries()  : array<string|int, mixed>
Get a list of allowed industries for the onboarding wizard.
get_allowed_product_types()  : array<string|int, mixed>
Get a list of allowed product types for the onboarding wizard.
get_allowed_themes()  : array<string|int, mixed>
Gets an array of themes that can be installed & activated via the onboarding wizard.
get_product_data()  : array<string|int, mixed>
Get dynamic product data from API.
get_theme_data()  : array<string|int, mixed>
Get theme data used in onboarding theme browser.
get_themes()  : array<string|int, mixed>
Get a list of themes for the onboarding wizard.
log_deprecation()  : mixed
Log a deprecation to the error log.

Properties

$deprecated_in_version

The version that this class was deprecated in.

protected static string $deprecated_in_version = '6.3.0'

$facade_over_classname

The name of the non-deprecated class that this facade covers.

protected static string $facade_over_classname = 'Automattic\WooCommerce\Admin\Features\Onboarding'

Methods

__call()

Executes when calling any function on an instance of this class.

public __call(string $name, array<string|int, mixed> $arguments) : mixed
Parameters
$name : string

The name of the function being called.

$arguments : array<string|int, mixed>

An array of the arguments to the function call.

Return values
mixed

__callStatic()

Executes when calling any static function on this class.

public static __callStatic(string $name, array<string|int, mixed> $arguments) : mixed
Parameters
$name : string

The name of the function being called.

$arguments : array<string|int, mixed>

An array of the arguments to the function call.

Return values
mixed

get_allowed_industries()

Get a list of allowed industries for the onboarding wizard.

public static get_allowed_industries() : array<string|int, mixed>
Tags
deprecated
6.3.0
Return values
array<string|int, mixed>

get_allowed_product_types()

Get a list of allowed product types for the onboarding wizard.

public static get_allowed_product_types() : array<string|int, mixed>
Tags
deprecated
6.3.0
Return values
array<string|int, mixed>

get_allowed_themes()

Gets an array of themes that can be installed & activated via the onboarding wizard.

public static get_allowed_themes() : array<string|int, mixed>
Tags
deprecated
6.3.0
Return values
array<string|int, mixed>

get_product_data()

Get dynamic product data from API.

public static get_product_data(array<string|int, mixed> $product_types) : array<string|int, mixed>
Parameters
$product_types : array<string|int, mixed>

Array of product types.

Tags
deprecated
6.3.0
Return values
array<string|int, mixed>

get_theme_data()

Get theme data used in onboarding theme browser.

public static get_theme_data(WP_Theme $theme) : array<string|int, mixed>
Parameters
$theme : WP_Theme

Theme to gather data from.

Tags
deprecated
6.3.0
Return values
array<string|int, mixed>

get_themes()

Get a list of themes for the onboarding wizard.

public static get_themes() : array<string|int, mixed>
Tags
deprecated
6.3.0
Return values
array<string|int, mixed>

log_deprecation()

Log a deprecation to the error log.

private static log_deprecation(string $function) : mixed
Parameters
$function : string

The name of the deprecated function being called.

Return values
mixed