{eac}Doojigger Reference

eacDoojigger extends abstract_context
in package
Uses standard_options, plugin_help

Primary plugin file - {eac}Doojigger for WordPress

Tags
category

WordPress Plugin

author

Kevin Burkholder KBurkholder@EarthAsylum.com

copyright

Copyright (c) 2022 EarthAsylum Consulting <www.earthasylum.com>

version
2.x
link
https://eacDoojigger.earthasylum.com/
see
https://eacDoojigger.earthasylum.com/phpdoc/
uses
abstract_context
uses
abstract_frontend
uses
abstract_backend

Table of Contents

CONTEXT_IS_BACKEND  = false
CONTEXT_IS_FRONTEND  = true
CONTEXT_IS_NETWORK  = false
ENVIRONMENT_LIVE  = 'Production (live)'
ENVIRONMENT_TEST  = 'Development (test)'
EXTENSION_BASE_CLASS  = __NAMESPACE__ . '\\abstract_extension'
FILE_PERMISSION  = 0664
FOLDER_PERMISSION  = 0775
LOG_DEBUG  = E_STRICT
LOG_ERROR  = E_USER_ERROR
LOG_NOTICE  = E_USER_NOTICE
LOG_WARNING  = E_USER_WARNING
NETWORK_OPTION_NAME  = 'network_options'
PLUGIN_EXTENSION_TRANSIENT  = 'plugin_loaded_extensions'
PLUGIN_HEADER_TRANSIENT  = 'plugin_header_data'
PLUGIN_OPTION_NAME  = 'plugin_options'
$className  : string
$date_format  : string
$date_time_format  : string
$extensions  : array<string|int, mixed>
$networkOptions  : array<string|int, mixed>
$plugin  : object
$plugin_help_fields_on_first_tab  : bool
$PLUGIN_SLUG  : string
$PLUGIN_TEXTDOMAIN  : string
$pluginName  : string
$pluginOptions  : array<string|int, mixed>
$time_format  : string
$wpdb  : object
__construct()  : void
constructor method
_COOKIE()  : mixed
Safely get $_COOKIE data if set using PHP filter.
_GET()  : mixed
Safely get $_GET data if set using PHP filter
_POST()  : mixed
Safely get $_POST data if set using PHP filter
_REQUEST()  : mixed
Safely get $_REQUEST data if set, using PHP filter
_SERVER()  : mixed
Safely get $_SERVER or $_ENV data if set, using PHP filter
add_action()  : mixed
add_action with prefixed name
add_filter()  : mixed
add_filter with prefixed name
add_network_option()  : mixed
add_network_option() with prefixed option name (only network enabled)
add_option()  : bool
add_option() with prefixed option name
add_site_option()  : mixed
add_option() with prefixed option name (single site or network enabled)
addActionsAndFilters()  : void
Called after instantiating, loading extensions and initializing
addPluginHelpField()  : void
Add field-level content to the help tabs.
addPluginHelpTab()  : void
Add content to the help tabs.
addPluginSidebarLink()  : void
Add link to the help sidebar.
addPluginSidebarText()  : void
Add text to the help sidebar.
addShortcodes()  : void
Called after instantiating, loading extensions and initializing
admin_options_help()  : void
Add help tab on admin page
admin_options_settings()  : void
register options on options_settings_page
admin_plugin_installed()  : void
version installed (action {classname}_version_installed)
admin_plugin_updated()  : void
version updated (action {classname}_version_updated)
after_switch_blog()  : void
after switching blogs, load internal option array.
apply_filters()  : mixed
apply_filters with prefixed name
before_switch_blog()  : void
before switching blogs, save internal option array.
callAllExtensions()  : array<string|int, mixed>
Execute a method in each/all loaded extension class
callExtension()  : mixed
call a specific extension method
callMethod()  : mixed
call an internal plugin or extension method
createUniqueId()  : string
Generates a Universally Unique IDentifier (UUID), version 4.
currentURL()  : string
get the current url
delete_network_option()  : bool
delete_network_option() with prefixed option name (only network enabled)
delete_option()  : bool
delete_option() with prefixed option name
delete_site_option()  : bool
delete_option() with prefixed option name (single site or network enabled)
delete_site_transient()  : bool
A wrapper function to WP delete_site_transient() with prefixed transient name
delete_transient()  : bool
A wrapper function to WP delete_transient() with prefixed transient name
deleteTransients()  : void
delete identifiable transients belonging to this plugin
did_action()  : mixed
did_action with prefixed name
did_filter()  : mixed
did_filter with prefixed name (WP 6.1)
do_action()  : mixed
do_action with prefixed name
eacDoojigger_ready()  : void
eacDoojigger is fully loaded and ready.
error()  : object
wp_error with logging
explode_with_keys()  : array<string|int, mixed>
explode a string into an associative array
fatal()  : void
fatal error with logging
filter_plugin_access()  : mixed
filter to execute a plugin or extension method OR get a plugin or wordpress option
flush_caches()  : void
clear cache and transient data
forEachNetworkSite()  : bool
in multisite environment, perform callback for each site from network admin, not as network admin
formatPluginHelp()  : string
Additional formatting of the help content
get()  : mixed
retrieve a stored variable
get_network_option()  : mixed
get_network_option() with prefixed option name, optional callback default (only network enabled)
get_network_option_decrypt()  : mixed
get_network_option() and decrypt with prefixed option name, optional callback default
get_option()  : mixed
get_option() with prefixed option name, optional callback default
get_option_decrypt()  : mixed
get_option() and decrypt with prefixed option name, optional callback default
get_page_footer()  : string
get a template page footer
get_page_header()  : string
get a template page header
get_post_by_slug()  : object
get a post (or page) by slug
get_site_option()  : mixed
get_option() with prefixed option name, optional callback default (single site or network enabled)
get_site_option_decrypt()  : mixed
get_site_option() and decrypt with prefixed option name, optional callback default
get_site_transient()  : mixed
A wrapper function to WP get_site_transient() with prefixed transient name and callable function
get_the_field()  : object
get a post field
get_the_id()  : int
get a post id
get_the_post()  : object
get a post
get_transient()  : mixed
A wrapper function to WP get_transient() with prefixed transient name and callable function
getClassName()  : string|bool
get the class name without namespace
getClassObject()  : object
get class or extension object
getDocumentationLink()  : string
get documentation link (i.e. the home/documentation page for this plugin) requires 'Plugin URI' in plugin header
getDocumentationURL()  : string
get documentation url (i.e. the home/documentation page for this plugin)
getMySqlVersion()  : string|false
Query MySQL DB for its version
getOptionNamePrefix()  : string
get the option prefix
getPageName()  : string|null
Get the page "name"
getPluginValue()  : string
get plugin value from pluginData (base file header)
getPluginValues()  : array<string|int, mixed>
get plugin value array from pluginData (base file header).
getSemanticVersion()  : object|null
Parse a Semantic or Date version number.
getSettingsCallback()  : array<string|int, mixed>
get settings page callback
getSettingsLink()  : string
get settings link (i.e. the page for setting options)
getSettingsSlug()  : string
get settings name (i.e. the page for setting options)
getSettingsURL()  : string
get settings link (i.e. the page for setting options)
getSupportLink()  : string
get WordPress support link for this plugin
getSupportURL()  : string
get WordPress support URL for this plugin
getVariable()  : mixed
retrieve a stored variable
getVersion()  : string
version of this code from the plugin header or from given extension
getVisitorCountry()  : string
Get the visitor's country from the language header
getVisitorId()  : string
Get a unique visitor id
getVisitorIP()  : string
Get the visitor's IP address
has_action()  : mixed
has_action with prefixed name
has_filter()  : mixed
has_filter with prefixed name
implode_with_keys()  : string
implode an associative array into a string
initialize()  : void
class initialization.
insert_with_markers()  : bool
like WordPress insert_with_markers, works with multiple file types
install_autoloader()  : void
Install autoloader in mu_plugins
install_environment()  : mixed
install/uninstall {eac}DoojiggerEnvironment
is_admin()  : bool
is admin (is_admin() or admin url) w/ability to set
is_backend()  : bool
is back-end (is_admin() or admin url)
is_frontend()  : bool
is front-end (not is_admin() or admin url)
is_network_admin()  : bool
is network admin (is_network_admin() or network admin url) w/ability to set
is_network_enabled()  : bool
is plugin network-enabled
is_network_option()  : bool|mixed
is network option a value or in a set of values (only network enabled)
is_option()  : bool|mixed
is option a value or in a set of values
is_plugin_active()  : bool
is plugin active (may be called from inactive site)
is_site_option()  : bool|mixed
is_option a value or in a set of values (single site or network enabled)
isAjaxRequest()  : bool
detect an ajax request
isCurrentScreen()  : bool|string
get or check the current screen name
isExtension()  : bool|object
is extension loaded and enabled
isFalse()  : bool
is value false? - false,off,no,0
isPluginsPage()  : bool
when we're on the plugins page
isReservedOption()  : bool
test or set reserved option key
isSettingsPage()  : bool
when we're on our settings page
isStandardLicense()  : bool
is license L3 (standard) or better
isTestSite()  : bool
is this a test or live production site
isTrue()  : bool
is value true? true,on,yes,1
loadAllExtensions()  : void
Called after instantiation of this class to load all extension classes frontend uses transient cache to load extensions
log()  : bool
log_write()  : bool
console/file logging
logAlways()  : bool
console/file logging - always
logData()  : bool
console/file logging - data (warning)
logDebug()  : bool
console/file logging - debug
logError()  : bool
console/file logging - error
logInfo()  : bool
console/file logging - info (notice)
logNotice()  : bool
console/file logging - notice
logv()  : bool
logWarning()  : bool
console/file logging - warning
minifyString()  : string
conservative minify for JS or CSS content
page_reload()  : void
reload the current page
plugin_daily_event()  : void
plugin_daily_event -
plugin_help_enabled()  : bool
plugin_help_enabled - set or test enabled for use
plugin_ready()  : void
Plugin is fully loaded and ready.
plugin_weekly_event()  : void
plugin_weekly_event -
pluginHelpEnabled()  : bool
pluginHelpEnabled
prefixHookName()  : string
Get the prefixed version of the hook name
prefixOptionName()  : string
Get the prefixed version input $name suitable for storing in WP options
prefixTableName()  : string
Prefix the table name with wpdb prefix and our class prefix (wpdb_classname_tablename)
prefixTransientName()  : string
Get the prefixed version of the transient name
remove_action()  : mixed
remove_action with prefixed name
remove_filter()  : mixed
remove_filter with prefixed name
rename_network_option()  : mixed
rename a network option (only network enabled)
rename_option()  : mixed
rename an option
rename_site_option()  : mixed
rename an option (single site or network enabled)
restore_current_blog()  : bool
restore_current_blog wrapper.
safeEcho()  : bool
safeEcho - only echo output when not wp_doing_ajax(), prevents interference with multiple/auto installs
sanitize()  : mixed
to filter/sanitize a variable
scheduleEvent()  : void
schedule a single event with callback
set()  : string
set a stored variable
set_network_option()  : mixed
set a network option value (only network enabled)
set_option()  : mixed
set an option value
set_site_option()  : mixed
temporarily set an option value (single site or network enabled)
set_site_transient()  : bool
A wrapper function to WP set_site_transient() with prefixed transient name
set_transient()  : bool
A wrapper function to WP set_transient() with prefixed transient name
setVariable()  : string
set a stored variable
shortcode_plugin_access()  : string
shortcode to execute a plugin or extension method OR get a plugin or wordpress option
standardizeOptionGroup()  : string|array<string|int, mixed>
standardize the options group name
standardizeOptionName()  : string
standardize the option name
stdOptions_post_networkCache()  : void
When _btnNetworkCache button is posted, display notice
switch_to_blog()  : bool
switch_to_blog wrapper.
uninstall_autoloader()  : void
Deactivate the plugin (via register_deactivation_hook), uninstall autoloader
unprefixOptionName()  : string
Remove the prefix from the input $name
update_network_option()  : mixed
update_network_option() with prefixed option name (only network enabled)
update_network_option_encrypt()  : mixed
encrypt and update_network_option() with prefixed option name
update_option()  : bool
update_option() with prefixed option name
update_option_encrypt()  : mixed
encrypt and update_option() with prefixed option name
update_site_option()  : mixed
update_site_option() with prefixed option name (single site or network enabled)
update_site_option_encrypt()  : mixed
encrypt and update_site_option() with prefixed option name (single site or network enabled)

Constants

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

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

Tags
see
setPluginHeaderValues()

PLUGIN_OPTION_NAME

public string PLUGIN_OPTION_NAME = 'plugin_options'

plugin options name

Properties

$className

public string $className

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

Tags
used-by

getClassName()

$extensions

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

extension objects (class_name=>[class_path,class_object])

Tags
used-by

loadextensions()

$networkOptions

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

network options/settings array (optionName=>value)

$plugin_help_fields_on_first_tab

public bool $plugin_help_fields_on_first_tab = false

force field help on first tab

$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

Tags
used-by

getClassName()

$pluginOptions

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

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

Methods

__construct()

constructor method

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

public

Return values
void

Safely get $_COOKIE data if set using PHP filter.

public _COOKIE(string $name[, int|callable $filter = FILTER_CALLBACK ][, int|array<string|int, mixed>|callable $options = 'sanitize_textarea_field' ]) : 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 = 'sanitize_textarea_field'

passed to the filter

Tags
example

$data = $this->_COOKIE('cookie_name');

Return values
mixed

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

_GET()

Safely get $_GET data if set using PHP filter

public _GET(string $name[, int|callable $filter = FILTER_CALLBACK ][, int|array<string|int, mixed>|callable $options = 'sanitize_textarea_field' ]) : 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 = 'sanitize_textarea_field'

passed to the filter

Tags
example

$data = $this->_GET('param_name');

Return values
mixed

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

_POST()

Safely get $_POST data if set using PHP filter

public _POST(string $name[, int|callable $filter = FILTER_CALLBACK ][, int|array<string|int, mixed>|callable $options = 'sanitize_textarea_field' ]) : 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 = 'sanitize_textarea_field'

passed to the filter

Tags
example

$data = $this->_POST('post_name');

Return values
mixed

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

_REQUEST()

Safely get $_REQUEST data if set, using PHP filter

public _REQUEST(string $name[, int|callable $filter = FILTER_CALLBACK ][, int|array<string|int, mixed>|callable $options = 'sanitize_textarea_field' ]) : 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 = 'sanitize_textarea_field'

passed to the filter

Tags
example

$data = $this->_REQUEST('param_name');

Return values
mixed

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

_SERVER()

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

public _SERVER(string $name[, int|callable $filter = FILTER_CALLBACK ][, int|array<string|int, mixed>|callable $options = 'sanitize_textarea_field' ]) : 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 = 'sanitize_textarea_field'

passed to the filter

Tags
example

$data = $this->_SERVER('server_name');

Return values
mixed

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

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_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[, 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_option()

add_option() with prefixed option name

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

option name

$value : mixed

option value

$autoload : bool = true

WordPress autoload/cache

Return values
bool

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

addPluginHelpField()

Add field-level content to the help tabs.

public addPluginHelpField(array<string|int, mixed>|string $titles, string $label, array<string|int, mixed>|string $content) : void

May occur after help has been rendered.

Parameters
$titles : array<string|int, mixed>|string

tab title or [multiple titles to match in priority order]

$label : string

field label

$content : array<string|int, mixed>|string

field content (may be [title=>content])

Return values
void

addPluginHelpTab()

Add content to the help tabs.

public addPluginHelpTab(array<string|int, mixed>|string $title, array<string|int, mixed>|string $content[, string|array<string|int, mixed> $header = null ][, int $priority = 10 ]) : void
Parameters
$title : array<string|int, mixed>|string

tab title or [title,id]

$content : array<string|int, mixed>|string

tab content

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

section header or [header,true] (optional)

$priority : int = 10

priority of the tab (optional, default 10)

Return values
void

Add link to the help sidebar.

public addPluginSidebarLink(string $title, string $link[, string $tooltip = null ]) : void
Parameters
$title : string

link title

$link : string

link url

$tooltip : string = null

a title tooltip (optional)

Return values
void

addPluginSidebarText()

Add text to the help sidebar.

public addPluginSidebarText(array<string|int, mixed>|string $content) : void
Parameters
$content : array<string|int, mixed>|string

sidebar content

Return values
void

admin_options_help()

Add help tab on admin page

public admin_options_help() : void
Return values
void

admin_options_settings()

register options on options_settings_page

public admin_options_settings() : void
Tags
access

public

Return values
void

admin_plugin_installed()

version installed (action {classname}_version_installed)

public admin_plugin_installed([string|null $curVersion = null ], string $newVersion, bool $asNetworkAdmin) : void

May be called more than once on a given site (once as network admin).

Parameters
$curVersion : string|null = null

currently installed version number (null)

$newVersion : string

version being installed/updated

$asNetworkAdmin : bool

running as network admin

Return values
void

admin_plugin_updated()

version updated (action {classname}_version_updated)

public admin_plugin_updated([string|null $curVersion = null ], string $newVersion, bool $asNetworkAdmin) : void

May be called more than once on a given site (once as network admin).

Parameters
$curVersion : string|null = null

currently installed version number

$newVersion : string

version being installed/updated

$asNetworkAdmin : bool

running as network admin

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

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

currentURL()

get the current url

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

deleteTransients()

delete identifiable transients belonging to this plugin

public deleteTransients([bool $isNetwork = false ]) : void
Parameters
$isNetwork : bool = false
Tags
used-by

flush_caches()

used-by

plugin_admin_deactivated()

Return values
void

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

eacDoojigger_ready()

eacDoojigger is fully loaded and ready.

public eacDoojigger_ready() : void

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

Return values
void

error()

wp_error with logging

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

Error code or wp_error or throwable instance

$message : string = ''

Error message

$data : mixed = ''

optional, Error data

$id : scalar = null

optional, source id

Return values
object

WP_Error object

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 = '' ][, scalar $id = null ]) : void
Parameters
$code : string|int

Error code

$message : string = ''

Error message

$data : mixed = ''

optional, Error data

$id : scalar = 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
Tags
example

$this->forEachNetworkSite( function() {...} );

Return values
bool

is network admin

formatPluginHelp()

Additional formatting of the help content

public formatPluginHelp(string $content) : string
Parameters
$content : string

tab content

Return values
string

get()

retrieve a stored variable

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

stored key

$default : mixed = null

default value

Tags
deprecated

use getVariable

Return values
mixed

stored variable (unserialized)

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

Tags
example

$this->get_network_option('my_option') - returns my_option value or false

example

$this->get_network_option('my_option',[]) - returns my_option value or []

example

$this->get_network_option('my_option','setMyOption') - returns my_option value or value returned by setMyOption()

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

Tags
example

$this->get_option('my_option') - returns my_option value or false

example

$this->get_option('my_option',[]) - returns my_option value or []

example

$this->get_option('my_option','setMyOption') - returns my_option value or value returned by setMyOption()

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 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_post_by_slug()

get a post (or page) by slug

public get_post_by_slug(string $slug) : object
Parameters
$slug : string

the name to search for

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)

Tags
example

$this->get_site_transient(name, function, nnn) to call function if transient is not set or has expired

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)

Tags
example

$this->get_transient(name, function, nnn) to call function if transient is not set or has expired

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

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

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

getMySqlVersion()

Query MySQL DB for its version

public getMySqlVersion() : string|false
Return values
string|false

getOptionNamePrefix()

get the option prefix

public getOptionNamePrefix([string $prefix = null ]) : string
Parameters
$prefix : string = null

override default prefix

Return values
string

short_classname_

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

getSemanticVersion()

Parse a Semantic or Date version number.

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

Semantic version = major . minor . patch [- release + build] Date Version = yy . mmdd . patch [- release + build]

Parameters
$version : string = null
Tags
see
https://semver.org
Return values
object|null

major, minor, patch, release, build, version (sans build, use for version compare)

getSettingsCallback()

get settings page callback

public getSettingsCallback() : array<string|int, mixed>
Return values
array<string|int, mixed>

the settings page callback

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() : string
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

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 = false ]) : string
Parameters
$extension : mixed = null
$default : mixed = false
Return values
string

'n.n.n'

getVisitorCountry()

Get the visitor's country from the language header

public getVisitorCountry() : string
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

ID

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 ...$args) : mixed
Parameters
$hookName : string

the name of the action

$args : mixed

arguments passed to action

Return values
mixed

has_filter()

has_filter with prefixed name

public has_filter(string $hookName, mixed ...$args) : mixed
Parameters
$hookName : string

the name of the filter

$args : mixed

arguments passed to filter

Return values
mixed

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

install_autoloader()

Install autoloader in mu_plugins

public install_autoloader() : void
Return values
void

install_environment()

install/uninstall {eac}DoojiggerEnvironment

public install_environment(mixed $action) : mixed
Parameters
$action : mixed
Return values
mixed

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_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

Tags
example

$this->is_network_option('my_option') - returns my_option value

example

$this->is_network_option('my_option','this_value') - returns 'this_value' or false

example

$this->is_network_option('my_option',['this_value','that_value']) - returns 'this_value' or 'that_value' or false

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)

Tags
example

$this->is_option('my_option') - returns my_option value

example

$this->is_option('my_option','this_value') - returns 'this_value' or false

example

$this->is_option('my_option',['this_value','that_value']) - returns 'this_value' or 'that_value' or false

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

Tags
example

$this->is_site_option('my_option')

example

$this->is_site_option('my_option','this_value')

example

$this->is_site_option('my_option',['this_value','that_value'])

Return values
bool|mixed

option is set and has value

isAjaxRequest()

detect an ajax request

public isAjaxRequest() : bool
Return values
bool

isCurrentScreen()

get or check the current screen name

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

isExtension()

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

isPluginsPage()

when we're on the plugins page

public isPluginsPage() : 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

Tags
example

$this->isReservedOption('my_option',true);

example

if ($this->isReservedOption('my_option')) {...}

Return values
bool

isSettingsPage()

when we're on our settings page

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

check specific tab

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()

public log(mixed $var[, mixed $context = null ]) : bool
Parameters
$var : mixed
$context : mixed = null
Return values
bool

log_write()

console/file logging

public log_write(int $level[, mixed $var = null ][, scalar $context = null ]) : bool
Parameters
$level : int

the debugging log level

$var : mixed = null

variable to log or WP_Error object

$context : scalar = null

optional, source id

Return values
bool

logAlways()

console/file logging - always

public logAlways(mixed $var[, scalar $context = null ]) : bool
Parameters
$var : mixed

variable to log or WP_Error object

$context : scalar = null

optional, source id

Return values
bool

logData()

console/file logging - data (warning)

public logData(mixed $var[, scalar $context = null ]) : bool
Parameters
$var : mixed

variable to log or WP_Error object

$context : scalar = null

optional, source id

Return values
bool

logDebug()

console/file logging - debug

public logDebug(mixed $var[, scalar $context = null ]) : bool
Parameters
$var : mixed

variable to log or WP_Error object

$context : scalar = null

optional, source id

Return values
bool

logError()

console/file logging - error

public logError(mixed $var[, scalar $context = null ]) : bool
Parameters
$var : mixed

variable to log or WP_Error object

$context : scalar = null

optional, source id

Return values
bool

logInfo()

console/file logging - info (notice)

public logInfo(mixed $var[, scalar $context = null ]) : bool
Parameters
$var : mixed

variable to log or WP_Error object

$context : scalar = null

optional, source id

Return values
bool

logNotice()

console/file logging - notice

public logNotice(mixed $var[, scalar $context = null ]) : bool
Parameters
$var : mixed

variable to log or WP_Error object

$context : scalar = null

optional, source id

Return values
bool

logv()

public logv(mixed $var[, mixed $context = null ]) : bool
Parameters
$var : mixed
$context : mixed = null
Return values
bool

logWarning()

console/file logging - warning

public logWarning(mixed $var[, scalar $context = null ]) : bool
Parameters
$var : mixed

variable to log or WP_Error object

$context : scalar = null

optional, source id

Return values
bool

minifyString()

conservative minify for JS or CSS content

public minifyString(string $content) : string
Parameters
$content : string
Return values
string

minified content

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_help_enabled()

plugin_help_enabled - set or test enabled for use

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

enable/disable tabs

$fields : bool = null

enable/disable fields

Return values
bool

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

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 input $name suitable for storing in WP options

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

override default prefix

Return values
string

option name 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

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

rename_network_option()

rename a network option (only network enabled)

public rename_network_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_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 $input[, int|callable $filter = FILTER_CALLBACK ][, int|array<string|int, mixed>|callable $options = null ]) : mixed
Parameters
$input : scalar

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

Tags
example

$data = $this->sanitize($variable);

example

$data = $this->sanitize($variable,'my_sanitizer');

Return values
mixed

the filtered value, false if filter failed

scheduleEvent()

schedule a single event with callback

public scheduleEvent(string $eventName, int $secondsFromNow, array<string|int, mixed> $arguments, mixed $callback) : void
Parameters
$eventName : string
$secondsFromNow : int

time in seconds in the future

$arguments : array<string|int, mixed>

passed to callback

$callback : mixed
Return values
void

set()

set a stored variable

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

stored key

$default : mixed = null
Tags
deprecated

use setVariable

Return values
string

stored variable (serialized)

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

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 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

stdOptions_post_networkCache()

When _btnNetworkCache button is posted, display notice

public stdOptions_post_networkCache() : void
Return values
void

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

uninstall_autoloader()

Deactivate the plugin (via register_deactivation_hook), uninstall autoloader

public uninstall_autoloader() : void
Return values
void

unprefixOptionName()

Remove the prefix from the input $name

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

override default prefix

Return values
string

option name without prefix

update_network_option()

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

public update_network_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_network_option_encrypt()

encrypt and update_network_option() with prefixed option name

public update_network_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_option()

update_option() with prefixed option name

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

option name

$value : mixed

option value

$autoload : bool = true

WordPress autoload/cache

Return values
bool

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

Search results