Automattic\WooCommerce\Internal\Admin\Onboarding
OnboardingProfile{}
Contains backend logic for the onboarding profile and checklist feature.
Hooks from the class
Usage
$OnboardingProfile = new OnboardingProfile(); // use class methods
Methods
- ERROR: no method name found on line ``
- ERROR: no method name found on line ``
- ERROR: no method name found on line ``
- ERROR: no method name found on line ``
- ERROR: no method name found on line ``
- ERROR: no method name found on line ``
- ERROR: no method name found on line ``
- ERROR: no method name found on line ``
- ERROR: no method name found on line ``
- public static init()
- public static needs_completion()
- ERROR: no method name found on line ``
- ERROR: no method name found on line ``
- ERROR: no method name found on line `}`
- ERROR: no method name found on line ``
- public static trigger_complete( $old_value, $value )
- ERROR: no method name found on line ``
- ERROR: no method name found on line ``
OnboardingProfile{} OnboardingProfile{} code WC 9.6.0
class OnboardingProfile { /** * Profile data option name. */ const DATA_OPTION = 'woocommerce_onboarding_profile'; /** * Option for storing the onboarding profile progress. */ const PROGRESS_OPTION = 'woocommerce_onboarding_profile_progress'; /** * Add onboarding actions. */ public static function init() { add_action( 'update_option_' . self::DATA_OPTION, array( __CLASS__, 'trigger_complete' ), 10, 2 ); } /** * Trigger the woocommerce_onboarding_profile_completed action * * @param array $old_value Previous value. * @param array $value Current value. */ public static function trigger_complete( $old_value, $value ) { if ( isset( $old_value['completed'] ) && $old_value['completed'] ) { return; } if ( ! isset( $value['completed'] ) || ! $value['completed'] ) { return; } /** * Action hook fired when the onboarding profile (or onboarding wizard, * or profiler) is completed. * * @since 1.5.0 */ do_action( 'woocommerce_onboarding_profile_completed' ); } /** * Check if the profiler still needs to be completed. * * @return bool */ public static function needs_completion() { $onboarding_data = get_option( self::DATA_OPTION, array() ); $is_completed = isset( $onboarding_data['completed'] ) && true === $onboarding_data['completed']; $is_skipped = isset( $onboarding_data['skipped'] ) && true === $onboarding_data['skipped']; // @todo When merging to WooCommerce Core, we should set the `completed` flag to true during the upgrade progress. // https://github.com/woocommerce/woocommerce-admin/pull/2300#discussion_r287237498. return ! $is_completed && ! $is_skipped; } }