Onboarding
Contains backend logic for the onboarding profile and checklist feature.
Description Description
Source Source
File: packages/woocommerce-admin/src/Features/Onboarding.php
Methods Methods
- __construct — Hook into WooCommerce.
- activate_and_install_jetpack_ahead_of_wcpay — Ensure that Jetpack gets installed and activated ahead of WooCommerce Payments if both are being installed/activated at the same time.
- add_actions — Add onboarding actions.
- add_filters — Add onboarding filters.
- add_help_tab — Update the help tab setup link to reset the onboarding profiler.
- add_preload_endpoints — Preload data from API endpoints.
- add_toggle_actions — Adds the ability to toggle the new onboarding experience on or off.
- add_uploaded_theme_data — Add theme data to response from themes controller.
- admin_redirects — Handle redirects to setup/welcome page after install and updates.
- append_product_data — Append dynamic product data from API.
- calypso_tests — Allows quick access to testing the calypso parts of onboarding.
- component_settings — Add profiler items to component settings.
- delete_themes_transient — Delete the stored themes transient.
- enable_onboarding — Reset the onboarding profiler and redirect to the profiler.
- finish_paypal_connect — Finishes the PayPal connection process by saving the correct settings.
- finish_square_connect — Finishes the Square connection process by saving the correct settings.
- get_active_plugins — Get a list of active plugins, relevent to the onboarding wizard.
- get_allowed_industries — Get a list of allowed industries for the onboarding wizard.
- get_allowed_plugins — Gets an array of plugins that can be installed & activated via the onboarding wizard.
- get_allowed_product_types — Get a list of allowed product types for the onboarding wizard.
- get_allowed_themes — Gets an array of themes that can be installed & activated via the onboarding wizard.
- get_instance — Get class instance.
- get_stripe_supported_countries — Returns a list of Stripe supported countries. This method can be removed once merged to core.
- get_theme_data — Get theme data used in onboarding theme browser.
- get_themes — Get a list of themes for the onboarding wizard.
- has_woocommerce_support — Check if theme has declared support for WooCommerce. — deprecated
- is_home_or_setup_wizard_page — Determine if the current page is home or setup wizard.
- is_loading — Let the app know that we will be showing the onboarding route, so wp-admin elements should be hidden while loading.
- is_running_from_async_action_scheduler — Test whether the context of execution comes from async action scheduler.
- maybe_mark_complete — When updating WooCommerce, mark the profiler and task list complete.
- overwrite_paypal_redirect — Instead of redirecting back to the payment settings page, we will redirect back to the payments task list with our status.
- overwrite_square_redirect — Instead of redirecting back to the payment settings page, we will redirect back to the payments task list with our status.
- preload_options — Preload options to prime state of the application.
- preload_settings — Preload WC setting options to prime state of the application.
- redirect_old_onboarding — Redirect the old onboarding wizard to the profiler.
- redirect_wccom_install — Redirects the user to the task list if the task list is enabled and finishing a wccom checkout.
- remove_install_notice — Remove the install notice that prompts the user to visit the old onboarding setup wizard.
- reset_extended_task_list — Reset the extended task list and redirect to the dashboard.
- reset_profiler — Reset the onboarding profiler and redirect to the profiler.
- reset_task_list — Reset the onboarding task list and redirect to the dashboard.
- send_profile_data — Send profile data to WooCommerce.com.
- send_profile_data_on_connect — Send profiler data after a site is connected.
- send_profile_data_on_update — Send profiler data on profiler change to completion.
- set_woocommerce_setup_jetpack_opted_in — Sets the woocommerce_setup_jetpack_opted_in to true when Jetpack connects to WPCOM.
- should_show_profiler — Returns true if the profiler should be displayed (not completed and not skipped).
- should_show_tasks — Returns true if the task list should be displayed (not completed or hidden off the dashboard).
- sort_woocommerce_themes — Sort themes returned from WooCommerce.com
- track_onboarding_toggle — Track changes to the onboarding option.
- trigger_profile_completed_action — Trigger the woocommerce_onboarding_profile_completed action
- update_help_tab — Update the existing help tab and add an option to enable the new onboarding experience.