WooCommerce Code Reference

WCAdminHelper
in package

Class WCAdminHelper

Table of Contents

WC_ADMIN_STORE_AGE_RANGES  = array('week-1' => array('start' => 0, 'end' => WEEK_IN_SECONDS), 'week-1-4' => array('start' => WEEK_IN_SECONDS, 'end' => WEEK_IN_SECONDS * 4), 'month-1-3' => array('start' => MONTH_IN_SECONDS, 'end' => MONTH_IN_SECONDS * 3), 'month-3-6' => array('start' => MONTH_IN_SECONDS * 3, 'end' => MONTH_IN_SECONDS * 6), 'month-6+' => array('start' => MONTH_IN_SECONDS * 6))
WC_ADMIN_TIMESTAMP_OPTION  = 'woocommerce_admin_install_timestamp'
WC Admin timestamp option name.
get_wcadmin_active_for_in_seconds()  : number
Get the number of seconds that the store has been active.
is_wc_admin_active_for()  : bool
Test how long WooCommerce Admin has been active.
is_wc_admin_active_in_date_range()  : bool
Test if WooCommerce Admin has been active within a pre-defined range.

Constants

WC_ADMIN_STORE_AGE_RANGES

public mixed WC_ADMIN_STORE_AGE_RANGES = array('week-1' => array('start' => 0, 'end' => WEEK_IN_SECONDS), 'week-1-4' => array('start' => WEEK_IN_SECONDS, 'end' => WEEK_IN_SECONDS * 4), 'month-1-3' => array('start' => MONTH_IN_SECONDS, 'end' => MONTH_IN_SECONDS * 3), 'month-3-6' => array('start' => MONTH_IN_SECONDS * 3, 'end' => MONTH_IN_SECONDS * 6), 'month-6+' => array('start' => MONTH_IN_SECONDS * 6))

WC_ADMIN_TIMESTAMP_OPTION

WC Admin timestamp option name.

public mixed WC_ADMIN_TIMESTAMP_OPTION = 'woocommerce_admin_install_timestamp'

Methods

get_wcadmin_active_for_in_seconds()

Get the number of seconds that the store has been active.

public static get_wcadmin_active_for_in_seconds() : number
Return values
numberNumber of seconds.

is_wc_admin_active_for()

Test how long WooCommerce Admin has been active.

public static is_wc_admin_active_for(int $seconds) : bool
Parameters
$seconds : int

Time in seconds to check.

Return values
boolWhether or not WooCommerce admin has been active for $seconds.

is_wc_admin_active_in_date_range()

Test if WooCommerce Admin has been active within a pre-defined range.

public static is_wc_admin_active_in_date_range(string $range[, int $custom_start = null ]) : bool
Parameters
$range : string

range available in WC_ADMIN_STORE_AGE_RANGES.

$custom_start : int = null

custom start in range.

Tags
throws
InvalidArgumentException

Throws exception when invalid $range is passed in.

Return values
boolWhether or not WooCommerce admin has been active within the range.