{eac}Doojigger Reference

eacDoojigger extends abstract_context
in package

eacDoojigger

Uses eacDoojigger_admin_traits

Primary plugin file - {eac}Doojigger for WordPress

CONTEXT_IS_BACKEND


    public
        bool
    CONTEXT_IS_BACKEND
    = false

context flags

CONTEXT_IS_FRONTEND


    public
        bool
    CONTEXT_IS_FRONTEND
    = true

context flags

CONTEXT_IS_NETWORK


    public
        bool
    CONTEXT_IS_NETWORK
    = false

context flags

ENVIRONMENT_LIVE


    public
        string
    ENVIRONMENT_LIVE
    = 'Production (live)'

environment - live

ENVIRONMENT_TEST


    public
        string
    ENVIRONMENT_TEST
    = 'Development (test)'

environment - test

EXTENSION_BASE_CLASS


    public
        string
    EXTENSION_BASE_CLASS
    = __NAMESPACE__ . '\\abstract_extension'

base class name of extensions

FILE_PERMISSION


    public
        int
    FILE_PERMISSION
    = 0664

file permission

FOLDER_PERMISSION


    public
        int
    FOLDER_PERMISSION
    = 0775

folder permission

NETWORK_OPTION_NAME


    public
        string
    NETWORK_OPTION_NAME
    = 'network_options'

network options name

PLUGIN_EXTENSION_TRANSIENT


    public
        string
    PLUGIN_EXTENSION_TRANSIENT
    = 'plugin_loaded_extensions'

transient name for plugin extensions to load

PLUGIN_HEADER_TRANSIENT


    public
        string
    PLUGIN_HEADER_TRANSIENT
    = 'plugin_header_data'

transient name for plugin header info

PLUGIN_OPTION_NAME


    public
        string
    PLUGIN_OPTION_NAME
    = 'plugin_options'

plugin options name

RESERVED_OPTIONS


    public
        array<string|int, mixed>
    RESERVED_OPTIONS
    = [
    'uninstall_options',
    // {classname}_uninstall_options for uninstall trait
    'selected_update_channel',
]

reserved options (not part of options array)

$advanced_mode


    public
        array<string|int, mixed>
    $advanced_mode
     = array('global' => array('default' => false), 'settings' => array('default' => false))

Advanced Mode. use setAdvancedMode(bool, what, level) to set, use isAdvancedMode(what, level) to check

$advanced_mode_allowed


    public
        bool
    $advanced_mode_allowed
     = false

Advanced Mode allowed.

$className


    public
        string
    $className

The name of this plugin class (sans namespace) aka $pluginName

$cookie_default_service


    public
        string
    $cookie_default_service
     = ''

default consent service name (set by using class)

$date_format


    public
        string
    $date_format

date format

$date_time_format


    public
        string
    $date_time_format

date/time format

$extension_aliases


    public
        array<string|int, mixed>
    $extension_aliases
     = array()

extension aliases (alias_name=>class_object)

$extension_objects


    public
        array<string|int, mixed>
    $extension_objects
     = array()

extension objects (class_name=>class_object)

$networkOptions


    public
        array<string|int, mixed>
    $networkOptions
     = array()

network options/settings array (optionName=>value)

$plugin


    public
        object
    $plugin

$PLUGIN_SLUG


    public
        string
    $PLUGIN_SLUG

plugin slug name (directory/pluginname.php)

$PLUGIN_TEXTDOMAIN


    public
        string
    $PLUGIN_TEXTDOMAIN

Language name of this plugin, must match 'Text Domain' comment

$pluginName


    public
        string
    $pluginName

The name of this plugin class (sans namespace) aka $className

$pluginOptions


    public
        array<string|int, mixed>
    $pluginOptions
     = array()

plugin/extension options/settings array (optionName=>value)

$reservedOptions


    public
        array<string|int, mixed>
    $reservedOptions
     = array()

reserved option keys (typically used outside of the plugin) option keys stored individually (true/false)

$time_format


    public
        string
    $time_format

time format

$wpdb


    public
        object
    $wpdb

WordPress DB

__construct()

constructor method


    public
                    __construct(array<string|int, mixed> $header) : void

Parameters

$header : array<string|int, mixed>

Return values

void —

__get()

__get magic method allows direct access to extension methods.


    public
                    __get(string $property) : object|null

Parameters

$property : string: the property name or extension name

Return values

object|null —

_COOKIE()

Safely get $_COOKIE data using PHP filter.


    public
                    _COOKIE(string $name[, mixed $filter = FILTER_CALLBACK ][, mixed $options = null ]) : mixed

Parameters

$name : string
$filter : mixed = FILTER_CALLBACK
$options : mixed = null

Return values

mixed —

_GET()

Safely get $_GET data using PHP filter.


    public
                    _GET(string $name[, mixed $filter = FILTER_CALLBACK ][, mixed $options = null ]) : mixed

Parameters

$name : string
$filter : mixed = FILTER_CALLBACK
$options : mixed = null

Return values

mixed —

_POST()

Safely get $_POST data using PHP filter.


    public
                    _POST(string $name[, mixed $filter = FILTER_CALLBACK ][, mixed $options = null ]) : mixed

Parameters

$name : string
$filter : mixed = FILTER_CALLBACK
$options : mixed = null

Return values

mixed —

_REQUEST()

Safely get $_REQUEST data using PHP filter.


    public
                    _REQUEST(string $name[, mixed $filter = FILTER_CALLBACK ][, mixed $options = null ]) : mixed

Parameters

$name : string
$filter : mixed = FILTER_CALLBACK
$options : mixed = null

Return values

mixed —

_SERVER()

Safely get $_SERVER data using PHP filter.


    public
                    _SERVER(string $name[, mixed $filter = FILTER_CALLBACK ][, mixed $options = null ]) : mixed

Parameters

$name : string
$filter : mixed = FILTER_CALLBACK
$options : mixed = null

Return values

mixed —

access_denied()

output forbidden response


    public
                    access_denied([string $logMsg = '' ], int $status[, string $message = '' ]) : WP_Error

Parameters

$logMsg : string = '': to log error message
$status : int: override default status
$message : string = '': override default message

Return values

WP_Error —

add_action()

add_action with prefixed name


    public
                    add_action(string $hookName, mixed ...$args) : mixed

Parameters

$hookName : string: the name of the action
$args : mixed: arguments passed to action

Return values

mixed —

add_admin_action_link()

add an action link (for menu and/or clickable actions)


    public
                    add_admin_action_link(string $action) : string

Parameters

$action : string: action name advanced_mode_enable, advanced_mode_disable, or custom action name

Return values

string —

href

add_admin_notice()

Add admin notice, log when not admin/backend


    public
                    add_admin_notice(string $message[, string $errorType = 'notice' ][, string $moreInfo = '' ]) : void

Parameters

$message : string: message text
$errorType : string = 'notice': 'error', 'warning', 'notice', 'success'
$moreInfo : string = '': additional message text

Return values

void —

add_filter()

add_filter with prefixed name


    public
                    add_filter(string $hookName, mixed ...$args) : mixed

Parameters

$hookName : string: the name of the filter
$args : mixed: arguments passed to filter

Return values

mixed —

add_network_option()

add_network_option() with prefixed option name (only network enabled)


    public
                    add_network_option(string $optionName, mixed $value) : mixed

Parameters

$optionName : string: option name
$value : mixed: option value

Return values

mixed —

option value

add_option()

add_option() with prefixed option name


    public
                    add_option(string $optionName, mixed $value[, bool $autoload = true ]) : mixed

Parameters

$optionName : string: option name
$value : mixed: option value
$autoload : bool = true: WordPress autoload/cache

Return values

mixed —

option value

add_site_option()

add_option() with prefixed option name (single site or network enabled)


    public
                    add_site_option(string $optionName, mixed $value[, bool $autoload = true ]) : mixed

Parameters

$optionName : string: option name
$value : mixed: option value
$autoload : bool = true: WordPress autoload/cache

Return values

mixed —

returned from add_option

addActionsAndFilters()

Called after instantiating, loading extensions and initializing


    public
                    addActionsAndFilters() : void

Return values

void —

addClassNamePrefix()

Get the prefix to the input $name suitable for storing


    public
                    addClassNamePrefix(string $name[, string $prefix = null ]) : string

Parameters

$name : string: option/hook/table name
$prefix : string = null: override default prefix

Return values

string —

option/hook/table name with prefix

addShortcodes()

Called after instantiating, loading extensions and initializing


    public
                    addShortcodes() : void

Return values

void —

after_switch_blog()

after switching blogs, load internal option array.


    public
                    after_switch_blog(string $new_blog_id, string $prev_blog_id, string $switch) : void

called from WP 'switch_blog' action.

Parameters

$new_blog_id : string: switching to blog
$prev_blog_id : string: switching from blog
$switch : string: 'switch' or 'restore'

Return values

void —

allow_advanced_mode()

alllow advanced mode - aids in complexity and/or licensing limits.


    public
                    allow_advanced_mode(bool $allow) : bool

standard license or better to enable advanced mose

Parameters

$allow : bool

allow or not

Return values

bool —

allowAdvancedMode()

allow advanced mode - aids in complexity and/or licensing limits.


    public
                    allowAdvancedMode([bool $allow = null ]) : bool

Parameters

$allow : bool = null

allow or not

Return values

bool —

allowed or not

apply_filters()

apply_filters with prefixed name


    public
                    apply_filters(string $hookName, mixed ...$args) : mixed

Parameters

$hookName : string: the name of the filter
$args : mixed: arguments passed to filter

Return values

mixed —

before_switch_blog()

before switching blogs, save internal option array.


    public
                    before_switch_blog(string $new_blog_id, string $prev_blog_id, string $switch) : void

called from $this->switch_to_blog() (not WP).

Parameters

$new_blog_id : string: switching to blog
$prev_blog_id : string: switching from blog
$switch : string: 'switch' or 'restore'

Return values

void —

callAllExtensions()

Execute a method in each/all loaded extension class


    public
                    callAllExtensions(string $method, mixed ...$arguments) : array<string|int, mixed>

Parameters

$method : string: the method name
$arguments : mixed: the arguments to method name

Return values

array<string|int, mixed> —

results from each call

callExtension()

call a specific extension method


    public
                    callExtension(string $extension, string $method, mixed ...$arguments) : mixed

Parameters

$extension : string: the extension name
$method : string: the method name
$arguments : mixed: the arguments to method name

Return values

mixed —

result of extension method called

callMethod()

call an internal plugin or extension method


    public
                    callMethod(string|array<string|int, mixed> $method, mixed ...$arguments) : mixed

Parameters

$method : string|array<string|int, mixed>: the method name or [extension,method]
$arguments : mixed: the arguments to method name

Return values

mixed —

result of call

config_advanced_mode()

config advanced mode - aids in complexity and/or licensing limits.


    public
                    config_advanced_mode() : void

set 'advanced mode' based on defined constant or user meta

Return values

void —

cookie_consent_patch()

enqueue javascripts to patch consent interface between browser and server


    public
                    cookie_consent_patch() : void

Return values

void —

createUniqueId()

Generates a Universally Unique IDentifier (UUID), version 4.


    public
                    createUniqueId() : string

Return values

string —

UUID

currentURL()

get the current url based on http request


    public
                    currentURL() : string

Return values

string —

the full url of the current request

delete_network_option()

delete_network_option() with prefixed option name (only network enabled)


    public
                    delete_network_option(string $optionName) : bool

Parameters

$optionName : string: option name

Return values

bool —

returned from delete_option

delete_option()

delete_option() with prefixed option name


    public
                    delete_option(string $optionName) : bool

Parameters

$optionName : string: option name

Return values

bool —

returned from delete_option

delete_site_option()

delete_option() with prefixed option name (single site or network enabled)


    public
                    delete_site_option(string $optionName) : bool

Parameters

$optionName : string: option name

Return values

bool —

returned from delete_option

delete_site_transient()

A wrapper function to WP delete_site_transient() with prefixed transient name


    public
                    delete_site_transient(string $transientName) : bool

Parameters

$transientName : string: transient name

Return values

bool —

delete_transient()

A wrapper function to WP delete_transient() with prefixed transient name


    public
                    delete_transient(string $transientName) : bool

Parameters

$transientName : string: transient name

Return values

bool —

did_action()

did_action with prefixed name


    public
                    did_action(string $hookName) : mixed

Parameters

$hookName : string: the name of the action

Return values

mixed —

did_filter()

did_filter with prefixed name (WP 6.1)


    public
                    did_filter(string $hookName) : mixed

Parameters

$hookName : string: the name of the filter

Return values

mixed —

do_action()

do_action with prefixed name


    public
                    do_action(string $hookName, mixed ...$args) : mixed

Parameters

$hookName : string: the name of the action
$args : mixed: arguments passed to action

Return values

mixed —

do_admin_action_links()

process action links from admin page.


    public
                    do_admin_action_links(object $admin_bar) : void

additional/custom actions may be added by adding an action for the function name: $this->add_action('my_action_name',function(){...});

Parameters

$admin_bar : object: wp_admin_bar

Return values

void —

doing_ajax()

detect an ajax request


    public
                    doing_ajax() : bool

Return values

bool —

error()

wp_error with logging


    public
                    error(string|int|object $code[, string $message = '' ][, mixed $data = '' ][, string $id = '' ][, mixed $isCritical = false ]) : object

Parameters

$code : string|int|object: Error code or wp_error or throwable instance
$message : string = '': Error message
$data : mixed = '': optional, Error data
$id : string = '': optional, source id
$isCritical : mixed = false

Return values

object —

WP_Error object

escape()

to filter/escape a variable


    public
                    escape(scalar|array<string|int, mixed> $input[, callable $callback = 'esc_attr' ]) : mixed

Parameters

$input : scalar|array<string|int, mixed>: the value to be filtered
$callback : callable = 'esc_attr': optional callback function

Return values

mixed —

the filtered value, false if filter failed

explode_with_keys()

explode a string into an associative array


    public
                    explode_with_keys(string $separator, string $string[, string $delimiter = '=' ]) : array<string|int, mixed>

Parameters

$separator : string: the glue value
$string : string: the string value to explode
$delimiter : string = '=': the key=value delimiter

Return values

array<string|int, mixed> —

the exploded array

fatal()

fatal error with logging


    public
                    fatal(string|int $code[, string $message = '' ][, mixed $data = '' ][, string $id = null ]) : void

Parameters

$code : string|int: Error code
$message : string = '': Error message
$data : mixed = '': optional, Error data
$id : string = null: optional, source id

Return values

void —

filter_plugin_access()

filter to execute a plugin or extension method OR get a plugin or wordpress option


    public
                    filter_plugin_access(string $default, array<string|int, mixed> $args) : mixed

Parameters

$default : string: default value if no request variable
$args : array<string|int, mixed>: array of arguments method methodName or [extension,methodName] or extension.methodName args arguments passed to method (array or string separated by ',') option option name bloginfo bloginfo name index if array, index or key to array value

Return values

mixed —

filter output

flush_caches()

clear cache and transient data


    public
                    flush_caches([bool $fullFlush = false ]) : void

Parameters

$fullFlush : bool = false

Return values

void —

forEachNetworkSite()

in multisite environment, perform callback for each site from network admin, not as network admin


    public
                    forEachNetworkSite(callable $callback, mixed ...$arguments) : bool

Parameters

$callback : callable
$arguments : mixed

Return values

bool —

is network admin

get()

retrieve a stored variable


    public
                    get(string $key[, mixed $default = null ]) : mixed

Parameters

$key : string: stored key
$default : mixed = null: default value

Return values

mixed —

stored variable (unserialized)

get_admin_bar_menu()

process the admin bar item


    public
                    get_admin_bar_menu(object $admin_bar) : void

Parameters

$admin_bar : object: wp_admin_bar

Return values

void —

get_cookie()

get a cookie (convenience method, since we have set_cookie)


    public
                    get_cookie(string|array<string|int, mixed> $name[, string $default = null ]) : string

Parameters

$name : string|array<string|int, mixed>: the cookie name (and alternates)
$default : string = null: if cookie not set

Return values

string —

cookie value

get_cookie_consent()

get a registered cookie consent array for a single cookie or all cookies


    public
                    get_cookie_consent([string $name = false ]) : array<string|int, mixed>

Parameters

$name : string = false: the cookie name (optional)

Return values

array<string|int, mixed> —

$consent or array of [name => $consent]

get_network_option()

get_network_option() with prefixed option name, optional callback default (only network enabled)


    public
                    get_network_option(string $optionName[, mixed $default = false ]) : mixed

Parameters

$optionName : string: option name
$default : mixed = false: default value or callable function to set value

Return values

mixed —

option value

get_network_option_decrypt()

get_network_option() and decrypt with prefixed option name, optional callback default


    public
                    get_network_option_decrypt(string $optionName[, mixed $default = false ]) : mixed

Parameters

$optionName : string: option name
$default : mixed = false: default value or callable function

Return values

mixed —

option value

get_option()

get_option() with prefixed option name, optional callback default


    public
                    get_option(string $optionName[, mixed $default = false ]) : mixed

Parameters

$optionName : string: option name
$default : mixed = false: default value or callable function to set value

Return values

mixed —

option value

get_option_decrypt()

get_option() and decrypt with prefixed option name, optional callback default


    public
                    get_option_decrypt(string $optionName[, mixed $default = false ]) : mixed

Parameters

$optionName : string: option name
$default : mixed = false: default value or callable function

Return values

mixed —

option value

get_output_file()

When creating a file, find appropriate path a. where the debug log is stored b. in the upload folder


    public
                    get_output_file(string $filePath[, bool $create = true ][, string $firstRecord = '' ]) : string|wp_error

Parameters

$filePath : string
$create : bool = true: create path/file
$firstRecord : string = ''

Return values

string|wp_error —

file path name

get_page_footer()

get a template page footer


    public
                    get_page_footer([string $name = null ]) : string

Parameters

$name : string = null: special footer name

Return values

string —

the footer content

get_page_header()

get a template page header


    public
                    get_page_header([string $name = null ]) : string

Parameters

$name : string = null: special header name

Return values

string —

the header content

get_page_template()

get a template page part


    public
                    get_page_template(string $slug[, string $name = null ][, mixed $args = [] ]) : string

Parameters

$slug : string: template file name {$slug}.php
$name : string = null: special name/part {$slug}-{$name}.php
$args : mixed = []

Return values

string —

the template content

get_post_by_slug()

get a post (or page) by slug


    public
                    get_post_by_slug(string $slug[, array<string|int, mixed> $options = [] ]) : object

Parameters

$slug : string: the name to search for
$options : array<string|int, mixed> = []: augment/override query options

Return values

object —

the first matching post

get_site_option()

get_option() with prefixed option name, optional callback default (single site or network enabled)


    public
                    get_site_option(string $optionName[, mixed $default = false ]) : mixed

Parameters

$optionName : string: option name
$default : mixed = false: default value or callable function

Return values

mixed —

option value

get_site_option_decrypt()

get_site_option() and decrypt with prefixed option name, optional callback default


    public
                    get_site_option_decrypt(string $optionName[, mixed $default = false ]) : mixed

Parameters

$optionName : string: option name
$default : mixed = false: default value or callable function

Return values

mixed —

option value

get_site_transient()

A wrapper function to WP get_site_transient() with prefixed transient name and callable function


    public
                    get_site_transient(string $transientName[, mixed $default = false ], int $expiration) : mixed

Parameters

$transientName : string: transient name
$default : mixed = false: default value or callable function
$expiration : int: time until expiration in seconds. Default 0 (no expiration)

Return values

mixed —

transient value

get_the_field()

get a post field


    public
                    get_the_field(string $field, int|WP_Post $post_id[, string|callable $format = "%s" ]) : object

Parameters

$field : string: the custom meta field name
$post_id : int|WP_Post
$format : string|callable = "%s": sprintf format string or callable function

Return values

object —

post

get_the_id()

get a post id


    public
                    get_the_id(int|WP_Post $post_id) : int

Parameters

$post_id : int|WP_Post

Return values

int —

post ID or null

get_the_post()

get a post


    public
                    get_the_post(int|WP_Post $post_id) : object

Parameters

$post_id : int|WP_Post

Return values

object —

post or null

get_transient()

A wrapper function to WP get_transient() with prefixed transient name and callable function


    public
                    get_transient(string $transientName[, mixed $default = false ], int $expiration) : mixed

Parameters

$transientName : string: transient name
$default : mixed = false: default value or callable function
$expiration : int: time until expiration in seconds. Default 0 (no expiration)

Return values

mixed —

transient value

getClassName()

get the class name without namespace


    public
                    getClassName([object $object = null ]) : string|bool

Parameters

$object : object = null: optional class object

Return values

string|bool —

getClassNamePrefix()

get the class name prefix


    public
                    getClassNamePrefix([string $prefix = null ]) : string

Parameters

$prefix : string = null: override default prefix

Return values

string —

short_classname_

getClassObject()

get class or extension object


    public
                    getClassObject([string $className = null ]) : object

Parameters

$className : string = null: class/extension name

Return values

object —

class object or null

getDocumentationLink()

get documentation link (i.e. the home/documentation page for this plugin) requires 'Plugin URI' in plugin header


    public
                    getDocumentationLink([mixed $plugin = true ][, string $permalink = null ][, string $name = 'Docs' ][, string $title = 'Documentation' ]) : string

Parameters

$plugin : mixed = true: true=use this plugin title, array=get_plugin_data array, string = title
$permalink : string = null: uri (/sample-post, ?p=nnn, /2022/08/26/sample-post/, etc.)
$name : string = 'Docs': link name ('Docs')
$title : string = 'Documentation': title ('Documentation')

Return values

string —

the Documentation link

getDocumentationURL()

get documentation url (i.e. the home/documentation page for this plugin)


    public
                    getDocumentationURL([mixed $plugin = true ][, string $permalink = null ]) : string

Parameters

$plugin : mixed = true: true=use this plugin title, array=get_plugin_data array, string = title
$permalink : string = null: uri (/sample-post, ?p=nnn, /2022/08/26/sample-post/, etc.)

Return values

string —

the Documentation link

getExtension()

get extension, loaded and enabled


    public
                    getExtension(object|string $extension[, bool $checkEnabled = true ]) : bool|object

Parameters

$extension : object|string: extension class or name
$checkEnabled : bool = true: check isEnabled()

Return values

bool|object —

false or extension object

getFilterCallback()

to parse the PHP filter name and options


    public
                    getFilterCallback([int|callable $filter = FILTER_CALLBACK ][, int|array<string|int, mixed>|callable $options = null ][, array<string|int, mixed> $args = null ]) : array<string|int, mixed>

Parameters

$filter : int|callable = FILTER_CALLBACK: the filter to use
$options : int|array<string|int, mixed>|callable = null: passed to the filter
$args : array<string|int, mixed> = null: additional arguments passed to callable

Return values

array<string|int, mixed> —

[filter, options]

getMySqlVersion()

Query MySQL DB for its version


    public
                    getMySqlVersion() : string|false

Return values

string|false —

getPageName()

Get the page "name"


    public
                    getPageName([mixed $post = null ][, bool $permalink = false ]) : string|null

Parameters

$post : mixed = null
$permalink : bool = false: get post permalink name

Return values

string|null —

the requested page name (sans extension)

getPluginValue()

get plugin value from pluginData (base file header)


    public
                    getPluginValue([string $name = null ]) : string

Parameters

$name : string = null: name of plugin data value

Return values

string —

data value from plugin header

getPluginValues()

get plugin value array from pluginData (base file header).


    public
                    getPluginValues() : array<string|int, mixed>

Return values

array<string|int, mixed> —

values from plugin header

getRelease()

get release (stable tag/Last Updated) from the readme header


    public
                    getRelease([mixed $default = '' ]) : string

Parameters

$default : mixed = ''

Return values

string —

'Release __ (__)'

getRequestHost()

Returns the local host from home_url


    public
                    getRequestHost() : string

Return values

string —

getRequestOrigin()

get the the request origin


    public
                    getRequestOrigin() : string

Return values

string —

the origin host

getRequestParts()

get the current url part(s) based on WP request


    public
                    getRequestParts(mixed $part) : string

Parameters

$part : mixed

Return values

string —

getRequestPath()

get the current url path based on WP request


    public
                    getRequestPath() : string

Return values

string —

getRequestURL()

get the current url based on WP request


    public
                    getRequestURL() : string

Return values

string —

getSemanticVersion()

Parse a Semantic or Calendar version number.


    public
                    getSemanticVersion([string $version = null ]) : object|null

Semantic Version (SemVer) = major . minor . patch [- release + build] Calendar Version (CalVer) = yy . mmdd . patch [- release + build].

Any version-release is almost always less than version (no release) 1.2.3 > 1.2.3-Release+Build, 1.2.3-release > 1.2.3-Release+Build, 1.2.3-release < 1.2.3

Parameters

$version : string = null

Return values

object|null —

'original' => '1.2.3-Release+Build', 'major' => '1', 'minor' => '2', 'patch' => '3', 'release' => 'Release', 'build' => 'Build', 'version' => '1.2.3-release', (use with version compare) 'primary' => '1.2.3', __toString() = '1.2.3-release+build'

getSettingsLink()

get settings link (i.e. the page for setting options)


    public
                    getSettingsLink([mixed $plugin = true ][, string $tab = null ][, string $name = 'Settings' ][, string $title = 'Settings' ]) : string

Parameters

$plugin : mixed = true: true=use this plugin title, array=get_plugin_data array, string = title
$tab : string = null: add tab name to url
$name : string = 'Settings': link name ('Settings')
$title : string = 'Settings': title ('Settings')

Return values

string —

the settings link

getSettingsSlug()

get settings name (i.e. the page for setting options)


    public
                    getSettingsSlug([mixed $tab = null ]) : string

Parameters

$tab : mixed = null

Return values

string —

the settings slug name

getSettingsURL()

get settings link (i.e. the page for setting options)


    public
                    getSettingsURL([mixed $plugin = true ][, string $tab = null ]) : string

Parameters

$plugin : mixed = true: true=use this plugin title, array=get_plugin_data array, string = title
$tab : string = null: add tab name to url

Return values

string —

the settings link

getSupportLink()

get WordPress support link for this plugin


    public
                    getSupportLink([mixed $plugin = true ][, string $slug = null ][, string $name = 'Support' ][, string $title = 'Support' ]) : string

Parameters

$plugin : mixed = true: true=use this plugin title, array=get_plugin_data array, string = title
$slug : string = null: uri plugin slug
$name : string = 'Support': link name ('Support')
$title : string = 'Support': title ('Support')

Return values

string —

the Support link

getSupportURL()

get WordPress support URL for this plugin


    public
                    getSupportURL([mixed $plugin = true ][, string $slug = null ]) : string

Parameters

$plugin : mixed = true: true=use this plugin title, array=get_plugin_data array, string = title
$slug : string = null: uri plugin slug

Return values

string —

the Support URL

getVariable()

retrieve a stored variable


    public
                    getVariable(string $key[, mixed $default = null ]) : mixed

Parameters

$key : string: stored key
$default : mixed = null: default value

Return values

mixed —

stored variable (unserialized)

getVersion()

version of this code from the plugin header or from given extension


    public
                    getVersion([mixed $extension = null ][, mixed $default = '' ]) : string

Parameters

$extension : mixed = null
$default : mixed = ''

Return values

string —

'n.n.n'

getVisitorCountry()

Get the visitor's country from the language header


    public
                    getVisitorCountry([string $default = 'US' ]) : string

Parameters

$default : string = 'US'

Return values

string —

2 character country code (default=US)

getVisitorId()

Get a unique visitor id


    public
                    getVisitorId([bool $forRequest = false ]) : string

Parameters

$forRequest : bool = false: unique to this request

Return values

string —

getVisitorIP()

Get the visitor's IP address


    public
                    getVisitorIP() : string

Return values

string —

IP address

has_action()

has_action with prefixed name


    public
                    has_action(string $hookName[, mixed $callback = false ]) : mixed

Parameters

$hookName : string: the name of the action
$callback : mixed = false

Return values

mixed —

has_action_count()

has_action with prefixed name - returns count of filters


    public
                    has_action_count(string $hookName[, mixed $callback = false ]) : int

Parameters

$hookName : string: the name of the action
$callback : mixed = false

Return values

int —

has_cookie_consent()

check consent is loaded and category set (convenience method)


    public
                    has_cookie_consent([string $category = null ]) : bool

Parameters

$category : string = null: consent category to check.

Return values

bool —

has_filter()

has_filter with prefixed name


    public
                    has_filter(string $hookName[, mixed $callback = false ]) : mixed

Parameters

$hookName : string: the name of the filter
$callback : mixed = false

Return values

mixed —

has_filter_count()

has_filter with prefixed name - returns count of filters


    public
                    has_filter_count(string $hookName[, mixed $callback = false ]) : int

Parameters

$hookName : string: the name of the filter
$callback : mixed = false

Return values

int —

hasClassNamePrefix()

has the class name prefix


    public
                    hasClassNamePrefix(string $name[, string $prefix = null ]) : bool

Parameters

$name : string: option/hook/table name
$prefix : string = null: override default prefix

Return values

bool —

implode_with_keys()

implode an associative array into a string


    public
                    implode_with_keys(string $separator, array<string|int, mixed> $array[, string $delimiter = '=' ]) : string

Parameters

$separator : string: the glue value
$array : array<string|int, mixed>: the associative array to implode
$delimiter : string = '=': the key=value delimiter

Return values

string —

the imploded string

initialize()

class initialization.


    public
                    initialize() : void

Called after instantiating and loading extensions

Return values

void —

insert_with_markers()

like WordPress insert_with_markers, works with multiple file types


    public
                    insert_with_markers(string $filename, string $marker, array<string|int, mixed> $insertion[, string $commentBegin = '#' ][, string $commentEnd = '' ][, bool $insertAtTop = false ]) : bool

Parameters

$filename : string

path name to file

$marker : string

marker text

$insertion : array<string|int, mixed>

line(s) to be inserted

$commentBegin : string = '#'

beginning of a comment (i.e. '#', ';', '//', '/*')

$commentEnd : string = ''

ending of a comment (i.e. '* /')

$insertAtTop : bool = false

true to insert new block at beginning of file

Return values

bool —

is_admin()

is admin (is_admin() or admin url) w/ability to set


    public
                    is_admin([bool $set = null ]) : bool

Parameters

$set : bool = null: set/override is_admin

Return values

bool —

is_advanced_mode()

is advanced mode filter - aids in complexity and/or licensing limits.


    public
                    is_advanced_mode([bool $bool = false ][, string $what = null ][, string $level = null ]) : bool

Parameters

$bool : bool = false

ignored

$what : string = null

what is in advanced mode

$level : string = null

what level is in advanced mode (default, basic, standard, pro)

Return values

bool —

is or is not

is_backend()

is back-end (is_admin() or admin url)


    public
                    is_backend() : bool

Return values

bool —

is_frontend()

is front-end (not is_admin() or admin url)


    public
                    is_frontend() : bool

Return values

bool —

is_network_admin()

is network admin (is_network_admin() or network admin url) w/ability to set


    public
                    is_network_admin([bool $set = null ]) : bool

Parameters

$set : bool = null: set/override is_network_admin

Return values

bool —

is_network_enabled()

is plugin network-enabled


    public
                    is_network_enabled([string $plugin = null ]) : bool

Parameters

$plugin : string = null

Return values

bool —

is_network_option()

is network option a value or in a set of values (only network enabled)


    public
                    is_network_option(string $optionName[, mixed $value = null ]) : bool|mixed

Parameters

$optionName : string: option name
$value : mixed = null: check this value

Return values

bool|mixed —

option is set and has value

is_option()

is option a value or in a set of values


    public
                    is_option(string $optionName[, mixed $value = null ][, bool $network = false ]) : bool|mixed

Parameters

$optionName : string: option name
$value : mixed = null: check for this value (optional)
$network : bool = false: using network options (internal)

Return values

bool|mixed —

null or option value

is_plugin_active()

is plugin active (may be called from inactive site)


    public
                    is_plugin_active([string $plugin = null ]) : bool

Parameters

$plugin : string = null: plugin slug

Return values

bool —

is_site_option()

is_option a value or in a set of values (single site or network enabled)


    public
                    is_site_option(string $optionName[, mixed $value = null ]) : bool|mixed

Parameters

$optionName : string: option name
$value : mixed = null: check this value

Return values

bool|mixed —

option is set and has value

isAdvancedMode()

is advanced mode - aids in complexity and/or licensing limits.


    public
                    isAdvancedMode([string $what = null ][, string|array<string|int, mixed> $level = null ]) : bool

Parameters

$what : string = null

what is in advanced mode

$level : string|array<string|int, mixed> = null

what level(s) is in advanced mode (default, basic, standard, pro)

Return values

bool —

is or is not

isAjaxRequest()

now an alias to $tthis->doing_ajax()


    public
                    isAjaxRequest() : bool

Return values

bool —

isBasicLicense()

is license L2 (basic) or better


    public
                    isBasicLicense() : bool

Return values

bool —

isCurrentScreen()

get or check the current screen name


    public
                    isCurrentScreen([mixed $screen = null ]) : null|bool|string

Parameters

$screen : mixed = null

Return values

null|bool|string —

isEnterpriseLicense()

is license L5 (enterprise) or better


    public
                    isEnterpriseLicense() : bool

Return values

bool —

isExtension()

alias to getExtension - is extension loaded and enabled


    public
                    isExtension(object|string $extension[, bool $checkEnabled = true ]) : bool|object

Parameters

$extension : object|string: extension class or name
$checkEnabled : bool = true: check isEnabled()

Return values

bool|object —

false or extension object

isFalse()

is value false? - false,off,no,0


    public
                    isFalse(string $value) : bool

Parameters

$value : string: value to check

Return values

bool —

isIpInList()

Check an IP address against list of IPs/subnets


    public
                    isIpInList(string $ipAddress, array<string|int, mixed> $ipList) : bool

Parameters

$ipAddress : string: IPv4 or IPv6 address
$ipList : array<string|int, mixed>: list of IP addresses or subnets (cidr)

Return values

bool —

isNewVisitor()

Check visitor cookie


    public
                    isNewVisitor() : string

Return values

string —

isPluginsPage()

when we're on the plugins page


    public
                    isPluginsPage() : bool

Return values

bool —

isProfessionalLicense()

is license L4 (professional) or better


    public
                    isProfessionalLicense() : bool

Return values

bool —

isReservedOption()

test or set reserved option key


    public
                    isReservedOption(string $optionName[, bool $set = null ]) : bool

Parameters

$optionName : string: option name
$set : bool = null: set as reserved or not

Return values

bool —

isSettingsPage()

when we're on our settings page


    public
                    isSettingsPage([string $isTab = null ]) : bool

Parameters

$isTab : string = null: check specific tab name

Return values

bool —

isStandardLicense()

is license L3 (standard) or better


    public
                    isStandardLicense() : bool

Return values

bool —

isTestSite()

is this a test or live production site


    public
                    isTestSite() : bool

Return values

bool —

sets $site_is_test

isTrue()

is value true? true,on,yes,1


    public
                    isTrue(string $value) : bool

Parameters

$value : string: value to check

Return values

bool —

loadAllExtensions()

Called after instantiation of this class to load all extension classes frontend uses transient cache to load extensions


    public
                    loadAllExtensions() : void

Return values

void —

log()

PSR-3 Log


    public
                    log([int|string $level = '' ][, mixed $message = '' ][, array<string|int, mixed> $context = [] ]) : object|void

Parameters

$level : int|string = '': PHP or PSR error level
$message : mixed = ''
$context : array<string|int, mixed> = []: [key=>value] array for interpolation of $message

Return values

object|void —

logger object or void on log()

logAlways()

console/file logging - always


    public
                    logAlways(mixed $variable[, mixed $message = '' ][, array<string|int, mixed> $context = [] ]) : void

Parameters

$variable : mixed: variable to log, WP_Error object, throwable object
$message : mixed = ''
$context : array<string|int, mixed> = []: [key=>value] array for interpolation of $message

Return values

void —

logData()

console/file logging - data (warning)


    public
                    logData(mixed $variable[, mixed $message = '' ][, array<string|int, mixed> $context = [] ]) : void

Parameters

$variable : mixed: variable to log, WP_Error object, throwable object
$message : mixed = ''
$context : array<string|int, mixed> = []: [key=>value] array for interpolation of $message

Return values

void —

logDebug()

console/file logging - debug


    public
                    logDebug(mixed $variable[, mixed $message = '' ][, array<string|int, mixed> $context = [] ]) : void

Parameters

$variable : mixed: variable to log, WP_Error object, throwable object
$message : mixed = ''
$context : array<string|int, mixed> = []: [key=>value] array for interpolation of $message

Return values

void —

logError()

console/file logging - error


    public
                    logError(mixed $variable[, mixed $message = '' ][, array<string|int, mixed> $context = [] ]) : void

Parameters

$variable : mixed: variable to log, WP_Error object, throwable object
$message : mixed = ''
$context : array<string|int, mixed> = []: [key=>value] array for interpolation of $message

Return values

void —

logInfo()

console/file logging - info (notice)


    public
                    logInfo(mixed $variable[, mixed $message = '' ][, array<string|int, mixed> $context = [] ]) : void

Parameters

$variable : mixed: variable to log, WP_Error object, throwable object
$message : mixed = ''
$context : array<string|int, mixed> = []: [key=>value] array for interpolation of $message

Return values

void —

logNotice()

console/file logging - notice


    public
                    logNotice(mixed $variable[, mixed $message = '' ][, array<string|int, mixed> $context = [] ]) : void

Parameters

$variable : mixed: variable to log, WP_Error object, throwable object
$message : mixed = ''
$context : array<string|int, mixed> = []: [key=>value] array for interpolation of $message

Return values

void —

logWarning()

console/file logging - warning


    public
                    logWarning(mixed $variable[, mixed $message = '' ][, array<string|int, mixed> $context = [] ]) : void

Parameters

$variable : mixed: variable to log, WP_Error object, throwable object
$message : mixed = ''
$context : array<string|int, mixed> = []: [key=>value] array for interpolation of $message

Return values

void —

logWrite()

console/file logging


    public
                    logWrite(int $level, mixed $variable[, mixed $message = '' ][, array<string|int, mixed> $context = [] ]) : void

Parameters

$level : int: the debugging log level
$variable : mixed: variable to log, WP_Error object, throwable object
$message : mixed = ''
$context : array<string|int, mixed> = []: [key=>value] array for interpolation of $message

Return values

void —

minifyString()

Simple minify for JS or CSS content.


    public
                    minifyString(string $content[, mixed $stripNL = true ]) : string

Strips comments, leading/ttrailing white-space, new-lines. Warning: not all js/css strings may succesfully pass through this regex!

Parameters

$content : string
$stripNL : mixed = true

Return values

string —

minified content

modifyColor()

Increases or decreases the brightness of a color by a percentage of the current brightness.


    public
                    modifyColor(string $hexCode, float $adjustPercent) : string

Parameters

$hexCode : string: Supported formats: #FFF, #FFFFFF, FFF, FFFFFF
$adjustPercent : float: A number between -1 and 1. E.g. 0.3 = 30% lighter; -0.4 = 40% darker.

Return values

string —

optimize_async_script()

Make js async


    public
                    optimize_async_script(string $tag, string $handle, string $src) : string

Parameters

$tag : string
$handle : string: script/style name
$src : string: tag src= or href=

Return values

string —

optimize_async_style()

Make css async


    public
                    optimize_async_style(string $tag, string $handle, string $src, string $media) : string

Parameters

$tag : string
$handle : string: script/style name
$src : string: tag src= or href=
$media : string: tag media=

Return values

string —

optimize_hints()

Pre-load headers for js & css


    public
                    optimize_hints(string $src, string $handle) : string

Parameters

$src : string: tag src= or href=
$handle : string: script/style name

Return values

string —

page_redirect()

redirect the current page


    public
                    page_redirect(string $url[, int $status = 302 ][, bool $die = false ]) : void

Parameters

$url : string: destination url
$status : int = 302: http status (302)
$die : bool = false: true to die()

Return values

void —

page_reload()

reload the current page


    public
                    page_reload([bool $die = false ]) : void

Parameters

$die : bool = false: true to die()

Return values

void —

plugin_daily_event()

plugin_daily_event


    public
                    plugin_daily_event() : void

Return values

void —

plugin_hourly_event()

plugin_hourly_event


    public
                    plugin_hourly_event() : void

Return values

void —

plugin_ready()

Plugin is fully loaded and ready.


    public
                    plugin_ready() : void

Called when plugin is ready (all extensions/filters/shortcodes loaded)

Return values

void —

plugin_weekly_event()

plugin_weekly_event


    public
                    plugin_weekly_event() : void

Return values

void —

pluginHeader()

get plugin value from pluginData (base file header)


    public
                    pluginHeader([string $name = null ]) : string

Parameters

$name : string = null: name of plugin data value 'Title' => 'Plugin Name', The name of your plugin, which will be displayed in the Plugins list in the WordPress Admin. 'Description' => 'Description', A short description of the plugin, as displayed in the Plugins section in the WordPress Admin 'Version' => 'Version', The current version number of the plugin. 'RequiresWP' => 'Requires at least', The lowest WordPress version that the plugin will work on. 'RequiresPHP' => 'Requires PHP', The minimum required PHP version. 'RequiresEAC' => 'Requires EAC', The minimum required eacDoojigger version. 'RequiresWC' => 'WC requires at least', The lowest WooCommerce version that the plugin will work on. 'Author' => 'Author', The name of the plugin author. 'AuthorURI' => 'Author URI', The author’s website or profile on another website, such as WordPress.org. 'License' => 'License', The short name (slug) of the plugin’s license (e.g. GPLv2). 'LicenseURI' => 'License URI', A link to the full text of the license (e.g. https://www.gnu.org/licenses/gpl-2.0.html). 'TextDomain' => 'Text Domain', The gettext text domain of the plugin. 'DomainPath' => 'Domain Path', The domain path lets WordPress know where to find the translations. 'Network' => 'Network', Whether the plugin can be activated network-wide. 'PluginURI' => 'Plugin URI', The home page or update link of the plugin. 'UpdateURI' => 'Update URI', Allows third-party plugins to avoid accidentally being overwritten with an update of a plugin of a similar name from the WordPress.org Plugin Directory. 'StableTag' => 'Stable Tag', From readme.txt. 'LastUpdated' => 'Last Updated', From readme.txt. 'Name' The directory name within plugins. 'PluginSlug' The plugin_basename() slug. 'PluginDir' The directory name plugin_dir_path(). 'PluginDirUrl' The plugin url plugin_dir_url() 'VendorDir' The namespace directory within plugin directory.

Return values

string —

data value from plugin header

pluginHeaders()

get plugin value array from pluginData (base file header).


    public
                    pluginHeaders() : array<string|int, mixed>

Return values

array<string|int, mixed> —

values from plugin header

pluginHelpEnabled()

pluginHelpEnabled


    public
                    pluginHelpEnabled([bool $tabs = null ][, bool $fields = null ]) : bool

Parameters

$tabs : bool = null: enable/disable tabs
$fields : bool = null: enable/disable fields

Return values

bool —

prefixHookName()

Get the prefixed version of the hook name


    public
                    prefixHookName(string $hookName) : string

Parameters

$hookName : string: filter/action name

Return values

string —

hookname with prefix

prefixOptionName()

Get the prefixed version of the option name


    public
                    prefixOptionName(string $optionName) : string

Parameters

$optionName : string: option name

Return values

string —

$optionName with prefix

prefixTableName()

Prefix the table name with wpdb prefix and our class prefix (wpdb_classname_tablename)


    public
                    prefixTableName(string $name[, string $prefix = null ]) : string

Parameters

$name : string
$prefix : string = null: override default prefix

Return values

string —

full table name

prefixTransientName()

Get the prefixed version of the transient name


    public
                    prefixTransientName(string $transientName[, string $prefix = null ]) : string

Parameters

$transientName : string: transient name
$prefix : string = null: override default prefix

Return values

string —

transient name with prefix

print_admin_notice()

write admin notice immediately, noop when not admin/backend


    public
                    print_admin_notice(string $message[, string $errorType = 'notice' ][, string $moreInfo = '' ]) : void

Parameters

$message : string: message text
$errorType : string = 'notice': 'error', 'warning', 'notice', 'success'
$moreInfo : string = '': additional message text

Return values

void —

purge_expired_transients()

purge expired transients for current blog


    public
                    purge_expired_transients() : mixed

Return values

mixed —

registerNetworkOptions()

add network options (values) for the plugin


    public
                    registerNetworkOptions(string|array<string|int, mixed> $optionGroup[, array<string|int, mixed> $optionMeta = [] ]) : void

Parameters

$optionGroup : string|array<string|int, mixed>: group name or [groupname, tabname]]
$optionMeta : array<string|int, mixed> = []: group option meta

Return values

void —

registerPluginOptions()

add additional options (values) for the plugin (or extension)


    public
                    registerPluginOptions(string|array<string|int, mixed> $optionGroup[, array<string|int, mixed> $optionMeta = [] ]) : void

Parameters

$optionGroup : string|array<string|int, mixed>: group name or [groupname, tabname]]
$optionMeta : array<string|int, mixed> = []: group option meta

Return values

void —

remove_action()

remove_action with prefixed name


    public
                    remove_action(string $hookName, mixed ...$args) : mixed

Parameters

$hookName : string: the name of the action
$args : mixed: arguments passed to action

Return values

mixed —

remove_filter()

remove_filter with prefixed name


    public
                    remove_filter(string $hookName, mixed ...$args) : mixed

Parameters

$hookName : string: the name of the filter
$args : mixed: arguments passed to filter

Return values

mixed —

removeClassNamePrefix()

Remove the prefix from the input $name


    public
                    removeClassNamePrefix(string $name[, string $prefix = null ]) : string

Parameters

$name : string: option/hook/table name
$prefix : string = null: override default prefix

Return values

string —

option/hook/table name without prefix

rename_network_option()

rename a network option (only network enabled)


    public
                    rename_network_option(string $oldOptionName, string $newOptionName) : mixed

Parameters

$oldOptionName : string: old (current) option name
$newOptionName : string: new option name

Return values

mixed —

returned from update_option

rename_option()

rename an option


    public
                    rename_option(string $oldOptionName, string $newOptionName[, bool $autoload = true ]) : mixed

Parameters

$oldOptionName : string: old (current) option name
$newOptionName : string: new option name
$autoload : bool = true: WordPress autoload/cache

Return values

mixed —

returned from update_option

rename_site_option()

rename an option (single site or network enabled)


    public
                    rename_site_option(string $oldOptionName, string $newOptionName[, bool $autoload = true ]) : mixed

Parameters

$oldOptionName : string: old (current) option name
$newOptionName : string: new option name
$autoload : bool = true: WordPress autoload/cache

Return values

mixed —

returned from update_option

restore_current_blog()

restore_current_blog wrapper.


    public
                    restore_current_blog() : bool

enables calls to $this->before_switch_blog() and $this->after_switch_blog()

Return values

bool —

safeEcho()

safeEcho - only echo output when not wp_doing_ajax(), prevents interference with multiple/auto installs


    public
                    safeEcho(string $string) : bool

Parameters

$string : string: to echo

Return values

bool —

sanitize()

to filter/sanitize a variable


    public
                    sanitize(scalar|array<string|int, mixed> $input[, int|callable $filter = FILTER_CALLBACK ][, int|array<string|int, mixed>|callable $options = null ]) : mixed

Parameters

$input : scalar|array<string|int, mixed>: the value to be filtered
$filter : int|callable = FILTER_CALLBACK: the filter to use
$options : int|array<string|int, mixed>|callable = null: passed to the filter

Return values

mixed —

the filtered value, false if filter failed

set()

set a stored variable


    public
                    set(string $key[, mixed $default = null ]) : string

Parameters

$key : string: stored key
$default : mixed = null

Return values

string —

stored variable (serialized)

set_admin_bar_menu()

add the admin bar menu


    public
                    set_admin_bar_menu(object $admin_bar) : void

Parameters

$admin_bar : object: wp_admin_bar

Return values

void —

set_cookie()

set a cookie supporting wp_consent if enabled


    public
                    set_cookie(string|array<string|int, mixed> $name, mixed $value, string|int $expires[, array<string|int, mixed> $options = [] ][, mixed $consent = [] ]) : bool

Parameters

$name : string|array<string|int, mixed>: the cookie name
$value : mixed: the cookie value
$expires : string|int: cookie expiration in seconds or timestamp or string 'delete', 'expired', 'session', 'n days', 'n months', etc.
$options : array<string|int, mixed> = []: cookie parameters 'path', 'domain', 'secure', 'httponly', 'samesite'.
$consent : mixed = []: (array) consent parameters or (string) category or true = already registered 'plugin_or_service', 'category', 'function', ...

Return values

bool —

success or failure (as best we can tell)

set_cookie_consent()

set a cookie's consent information


    public
                    set_cookie_consent(string $name, array<string|int, mixed>|string $consent[, bool $register = true ][, array<string|int, mixed> $defaults = [] ]) : array<string|int, mixed>

Parameters

$name : string: the cookie name
$consent : array<string|int, mixed>|string: consent parameters or category 'plugin_or_service', 'category', 'function', ...
$register : bool = true: with wp_add_cookie_info()
$defaults : array<string|int, mixed> = []: default consent parameters

Return values

array<string|int, mixed> —

$consent

set_cookie_expiration()

set a cookie expiration as integer and string


    public
                    set_cookie_expiration(string|int $expires[, bool $getString = true ]) : array<string|int, mixed>

Parameters

$expires : string|int: cookie expiration in seconds or timestamp or string 'delete', 'expired', 'session', 'n days', 'n months', etc.
$getString : bool = true: (false) return array when true

Return values

array<string|int, mixed> —

[ $expInt, $expStr ]

set_network_option()

set a network option value (only network enabled)


    public
                    set_network_option(string $optionName, mixed $value) : mixed

Parameters

$optionName : string: option name
$value : mixed: value to set

Return values

mixed —

option value

set_option()

set an option value


    public
                    set_option(string $optionName, mixed $value) : mixed

Parameters

$optionName : string: option name
$value : mixed: value to set

Return values

mixed —

option value

set_site_option()

temporarily set an option value (single site or network enabled)


    public
                    set_site_option(string $optionName, mixed $value) : mixed

Parameters

$optionName : string: option name
$value : mixed: value to set

Return values

mixed —

option value

set_site_transient()

A wrapper function to WP set_site_transient() with prefixed transient name


    public
                    set_site_transient(string $transientName, mixed $value, int $expiration) : bool

Parameters

$transientName : string: transient name
$value : mixed: value to save
$expiration : int: time until expiration in seconds. Default 0 (no expiration)

Return values

bool —

set_transient()

A wrapper function to WP set_transient() with prefixed transient name


    public
                    set_transient(string $transientName, mixed $value, int $expiration) : bool

Parameters

$transientName : string: transient name
$value : mixed: value to save
$expiration : int: time until expiration in seconds. Default 0 (no expiration)

Return values

bool —

setAdvancedMode()

set advanced mode - aids in complexity and/or licensing limits.


    public
                    setAdvancedMode([bool $is = true ][, string $what = null ][, string $level = null ]) : void

allow settings 'advanced' attribute of 'standard', 'professional', 'enterprise'

Parameters

$is : bool = true

is or is not

$what : string = null

what is in advanced mode (global, settings, ...)

$level : string = null

what level is in advanced mode (default, basic, standard, pro)

Return values

void —

setVariable()

set a stored variable


    public
                    setVariable(string $key, mixed $value) : string

Parameters

$key : string: stored key
$value : mixed: stored variable

Return values

string —

stored variable (serialized)

shortcode_plugin_access()

shortcode to execute a plugin or extension method OR get a plugin or wordpress option


    public
                    shortcode_plugin_access([array<string|int, mixed> $atts = null ][, string $content = '' ][, string $tag = '' ]) : string

Parameters

$atts : array<string|int, mixed> = null: Shortcode attributes (use 'method' or 'option') method methodName or extension.methodName args arguments passed to method (string separated by ',') option option name bloginfo bloginfo name index if array, index or key to array value default default return value
$content : string = '': default content
$tag : string = '': The shortcode which invoked the callback

Return values

string —

Shortcode output

standardizeOptionGroup()

standardize the options group display name


    public
                    standardizeOptionGroup(string|array<string|int, mixed> $optionGroup) : string|array<string|int, mixed>

Parameters

$optionGroup : string|array<string|int, mixed>: group name or [groupname, tabname]]

Return values

string|array<string|int, mixed> —

standardized option group name

standardizeOptionName()

standardize the option name


    public
                    standardizeOptionName(string $optionName[, bool $toLC = true ]) : string

Parameters

$optionName : string: option name
$toLC : bool = true: convert to lower case

Return values

string —

standardized option name

switch_to_blog()

switch_to_blog wrapper.


    public
                    switch_to_blog(string $new_blog_id) : bool

enables calls to $this->before_switch_blog() and $this->after_switch_blog()

Parameters

$new_blog_id : string: switching to blog

Return values

bool —

always true

text_to_array()

parse delimited string to arrray


    public
                    text_to_array(string $string[, array<string|int, mixed> $delimiters = [';'] ][, callable $callback = 'trim' ]) : array<string|int, mixed>

Parameters

$string : string: delimited by \n or $delimiters
$delimiters : array<string|int, mixed> = [';']: split string on these delimiters
$callback : callable = 'trim': array_map callback function (i.e. sanitize_textarea_field)

Return values

array<string|int, mixed> —

toKeyString()

convert a display title/name to a key/class string


    public
                    toKeyString(string $string[, string $with = '-' ]) : string

Parameters

$string : string: to be converted
$with : string = '-': to replace ' '

Return values

string —

unprefixOptionName()

Get the un-prefixed version of the option name


    public
                    unprefixOptionName(string $optionName) : string

Parameters

$optionName : string: prefixed option name

Return values

string —

$optionName without prefix

update_network_option()

update_network_option() with prefixed option name (only network enabled)


    public
                    update_network_option(string $optionName, mixed $value) : mixed

Parameters

$optionName : string: option name
$value : mixed: option value

Return values

mixed —

option value

update_network_option_encrypt()

encrypt and update_network_option() with prefixed option name


    public
                    update_network_option_encrypt(string $optionName, mixed $value) : mixed

Parameters

$optionName : string: option name
$value : mixed: option value

Return values

mixed —

returned from update_option

update_option()

update_option() with prefixed option name


    public
                    update_option(string $optionName, mixed $value[, bool $autoload = true ]) : mixed

Parameters

$optionName : string: option name
$value : mixed: option value
$autoload : bool = true: WordPress autoload/cache

Return values

mixed —

option value

update_option_encrypt()

encrypt and update_option() with prefixed option name


    public
                    update_option_encrypt(string $optionName, mixed $value[, bool $autoload = true ]) : mixed

Parameters

$optionName : string: option name
$value : mixed: option value
$autoload : bool = true: WordPress autoload/cache

Return values

mixed —

returned from update_option

update_site_option()

update_site_option() with prefixed option name (single site or network enabled)


    public
                    update_site_option(string $optionName, mixed $value[, bool $autoload = true ]) : mixed

Parameters

$optionName : string: option name
$value : mixed: option value
$autoload : bool = true: WordPress autoload/cache

Return values

mixed —

returned from update_option

update_site_option_encrypt()

encrypt and update_site_option() with prefixed option name (single site or network enabled)


    public
                    update_site_option_encrypt(string $optionName, mixed $value[, bool $autoload = true ]) : mixed

Parameters

$optionName : string: option name
$value : mixed: option value
$autoload : bool = true: WordPress autoload/cache

Return values

mixed —

returned from update_option

varCookie()

Safely get $_COOKIE data using PHP filter.


    public
                    varCookie(string $name[, int|callable $filter = FILTER_CALLBACK ][, int|array<string|int, mixed>|callable $options = null ]) : mixed

Parameters

$name : string: the name of the cookie
$filter : int|callable = FILTER_CALLBACK: the filter to use
$options : int|array<string|int, mixed>|callable = null: passed to the filter

Return values

mixed —

the filtered value, false if filter failed, null if not found

varGet()

Safely get $_GET data if set using PHP filter


    public
                    varGet(string $name[, int|callable $filter = FILTER_CALLBACK ][, int|array<string|int, mixed>|callable $options = null ]) : mixed

Parameters

$name : string: the name of the variable
$filter : int|callable = FILTER_CALLBACK: the filter to use
$options : int|array<string|int, mixed>|callable = null: passed to the filter

Return values

mixed —

the filtered value, false if filter failed, null if not found

varPost()

Safely get $_POST data if set using PHP filter


    public
                    varPost(string $name[, int|callable $filter = FILTER_CALLBACK ][, int|array<string|int, mixed>|callable $options = null ]) : mixed

Parameters

$name : string: the name of the variable
$filter : int|callable = FILTER_CALLBACK: the filter to use
$options : int|array<string|int, mixed>|callable = null: passed to the filter

Return values

mixed —

the filtered value, false if filter failed, null if not found

varRequest()

Safely get $_REQUEST data if set, using PHP filter


    public
                    varRequest(string $name[, int|callable $filter = FILTER_CALLBACK ][, int|array<string|int, mixed>|callable $options = null ]) : mixed

Parameters

$name : string: the name of the variable
$filter : int|callable = FILTER_CALLBACK: the filter to use
$options : int|array<string|int, mixed>|callable = null: passed to the filter

Return values

mixed —

the filtered value, false if filter failed, null if not found

varServer()

Safely get $_SERVER or $_ENV data if set, using PHP filter


    public
                    varServer(string $name[, int|callable $filter = FILTER_CALLBACK ][, int|array<string|int, mixed>|callable $options = null ]) : mixed

Parameters

$name : string: the name of the variable
$filter : int|callable = FILTER_CALLBACK: the filter to use
$options : int|array<string|int, mixed>|callable = null: passed to the filter

Return values

mixed —

the filtered value, false if filter failed, null if not found

wp_action_count()

wp has_action - returns count of actions


    public
                    wp_action_count(string $hookName[, mixed $callback = false ]) : int

Parameters

$hookName : string: the name of the action
$callback : mixed = false

Return values

int —

wp_filter_count()

wp has_filter - returns count of filters


    public
                    wp_filter_count(string $hookName[, mixed $callback = false ]) : int

Parameters

$hookName : string: the name of the filter
$callback : mixed = false

Return values

int —

wp_kses()

customized wp_kses


    public
                    wp_kses(string $content[, array<string|int, array<string|int, mixed>> $allowed_html = [] ][, array<string|int, string> $allowed_protocols = [] ]) : string

Parameters

$content : string: Text content to filter.
$allowed_html : array<string|int, array<string|int, mixed>> = []: An array of allowed HTML elements and attributes,
$allowed_protocols : array<string|int, string> = []: An array of allowed URL protocols.

Return values

string —

Filtered content containing only the allowed HTML.

eacDoojigger extends abstract_context in package eacDoojigger Uses eacDoojigger_admin_traits

Tags

Table of Contents

Constants

CONTEXT_IS_BACKEND

CONTEXT_IS_FRONTEND

CONTEXT_IS_NETWORK

ENVIRONMENT_LIVE

ENVIRONMENT_TEST

EXTENSION_BASE_CLASS

FILE_PERMISSION

Tags

FOLDER_PERMISSION

Tags

NETWORK_OPTION_NAME

PLUGIN_EXTENSION_TRANSIENT

PLUGIN_HEADER_TRANSIENT

Tags

PLUGIN_OPTION_NAME

RESERVED_OPTIONS

Properties

$advanced_mode

$advanced_mode_allowed

$className

Tags

$cookie_default_service

$date_format

$date_time_format

$extension_aliases

$extension_objects

Tags

$networkOptions

$plugin

$PLUGIN_SLUG

$PLUGIN_TEXTDOMAIN

$pluginName

Tags

$pluginOptions

$reservedOptions

$time_format

$wpdb

Methods

__construct()

Parameters

Tags

Return values

__get()

Parameters

Tags

Return values

_COOKIE()

Parameters

Tags

Return values

_GET()

Parameters

Tags

Return values

_POST()

Parameters

Tags

Return values

_REQUEST()

Parameters

Tags

Return values

_SERVER()

Parameters

Tags

Return values

access_denied()

Parameters

Tags

Return values

add_action()

Parameters

Return values

add_admin_action_link()

Parameters

Return values

eacDoojigger extends abstract_context
in package

eacDoojigger

Uses eacDoojigger_admin_traits