WooCommerce Code Reference

LaunchYourStore
in package

Takes care of Launch Your Store related actions.

Table of Contents

BANNER_DISMISS_USER_META_KEY  = 'coming_soon_banner_dismissed'
__construct()  : mixed
Constructor.
add_user_data_fields()  : array<string|int, mixed>
Register user meta fields for Launch Your Store.
append_coming_soon_global_tracks()  : array<string|int, mixed>
Append coming soon prop tracks globally.
load_newsletter_scripts()  : void
Load slotfill script and JS variables for the newsletter.
maybe_add_coming_soon_banner_on_frontend()  : mixed
Add 'coming soon' banner on the frontend when the following conditions met.
maybe_track_template_change()  : mixed
Track when coming soon template is changed.
preload_settings()  : mixed
Preload settings for Site Visibility.
register_launch_your_store_user_meta_fields()  : mixed
Register user meta fields for Launch Your Store.
reset_woocommerce_coming_soon_banner_dismissed()  : mixed
Reset 'woocommerce_coming_soon_banner_dismissed' user meta to 'no'.
save_site_visibility_options()  : void
Save values submitted from WooCommerce -> Settings -> General.
is_mailpoet_connected()  : bool
Check if the Mailpoet is connected.
is_manager_or_admin()  : bool
User must be an admin or editor.

Constants

Methods

add_user_data_fields()

Register user meta fields for Launch Your Store.

public add_user_data_fields(array<string|int, mixed> $user_data_fields) : array<string|int, mixed>
Parameters
$user_data_fields : array<string|int, mixed>

user data fields.

Return values
array<string|int, mixed> —

append_coming_soon_global_tracks()

Append coming soon prop tracks globally.

public append_coming_soon_global_tracks(array<string|int, mixed> $event_properties) : array<string|int, mixed>
Parameters
$event_properties : array<string|int, mixed>

Event properties array.

Return values
array<string|int, mixed> —

load_newsletter_scripts()

Load slotfill script and JS variables for the newsletter.

public load_newsletter_scripts() : void

The comingSoonNewsletter is used in client/wp-admin-scripts/coming-soon-newsletter-panel

Return values
void —

maybe_add_coming_soon_banner_on_frontend()

Add 'coming soon' banner on the frontend when the following conditions met.

public maybe_add_coming_soon_banner_on_frontend() : mixed
  • User must be either an admin or store editor (must be logged in).
  • 'woocommerce_coming_soon' option value must be 'yes'
  • The page must not be the Coming soon page itself.
Return values
mixed —

maybe_track_template_change()

Track when coming soon template is changed.

public maybe_track_template_change(int $post_id, WP_Post $post, bool $update) : mixed
Parameters
$post_id : int

The post ID.

$post : WP_Post

The post object.

$update : bool

Whether the post is being updated.

Return values
mixed —

preload_settings()

Preload settings for Site Visibility.

public preload_settings(array<string|int, mixed> $settings) : mixed
Parameters
$settings : array<string|int, mixed>

settings array.

Return values
mixed —

register_launch_your_store_user_meta_fields()

Register user meta fields for Launch Your Store.

public register_launch_your_store_user_meta_fields() : mixed

This should be removed in WC 9.4.

Return values
mixed —

reset_woocommerce_coming_soon_banner_dismissed()

Reset 'woocommerce_coming_soon_banner_dismissed' user meta to 'no'.

public reset_woocommerce_coming_soon_banner_dismissed(string $user_login, object $user) : mixed

Runs when a user logs-in successfully.

Parameters
$user_login : string

user login.

$user : object

user object.

Return values
mixed —

save_site_visibility_options()

Save values submitted from WooCommerce -> Settings -> General.

public save_site_visibility_options() : void
Return values
void —

is_mailpoet_connected()

Check if the Mailpoet is connected.

private is_mailpoet_connected() : bool
Return values
bool — true if Mailpoet is fully connected, meaning the API key is valid and approved.