Tkt_Template_Builder_Declarations
in package

The Declarations Class.

Description

This is used both in public and admin when we need an instance of all shortcodes, or a centrally managed list of object properties or array members where we cannot already get it from the code (such as user object, which is a entangled mess, or get_bloginfo which is a case switcher).

Tags
since
1.0.0
author

Beda Schmid beda@tukutoi.com

Table of Contents

$sanitization_options  : array<string|int, mixed>
The Sanitization options and callbacks.
$shortcodes  : array<string|int, mixed>
The ShortCodes of this plugin.
$plugin_prefix  : string
The unique prefix of this plugin.
$version  : string
The version of this plugin.
__construct()  : mixed
Initialize the class and set its properties.
data_map()  : array<string|int, mixed>
Register an array of object properties, array members to re-use as configurations.
declare_shortcodes_add_filter()  : array<string|int, mixed>
Provide a public facing method to add ShortCodes to the TukuToi ShortCodes library
declare_shortcodes_types_add_filter()  : array<string|int, mixed>
Provide a public facing method to add ShortCode Types to the TukuToi ShortCodes GUI.
declare_shortcodes()  : array<string|int, mixed>
Register an array of Shortcodes of this plugin
sanitize_options()  : array<string|int, mixed>
All Sanitization Options.

Properties

$sanitization_options

The Sanitization options and callbacks.

public array<string|int, mixed> $sanitization_options
Description

All Sanitization Options of this plugin and their callbacks.

Tags
since
1.0.0
access

public

$shortcodes

The ShortCodes of this plugin.

public array<string|int, mixed> $shortcodes
Description

All ShortCode tags, methods and labels of this plugin.

Tags
since
1.0.0
access

public

$plugin_prefix

The unique prefix of this plugin.

private string $plugin_prefix
Description

The string used to uniquely prefix technical functions of this plugin.

Tags
since
1.0.0
access

private

Methods

data_map()

Register an array of object properties, array members to re-use as configurations.

public data_map(string $map) : array<string|int, mixed>
Description

Adds Array Maps for:

  • 'site_infos': Members and corresponding GUI labels of get_bloginfo.
  • 'user_data': Keys of WP_User object property "data".
  • 'valid_operators': Members represent valid math operatiors and their GUI label.
  • 'valid_comparison': Members represent valid comparison operators and their GUI label.
  • 'valid_round_constants': Members represent valid PHP round() directions and their GUI label.
  • 'shortcode_types': Members represent valid ShortCode Types.
Parameters
$map
(string) the data map to retrieve. Accepts: 'site_infos', 'user_data', 'valid_operators', 'valid_comparison', 'valid_round_constants', 'shortcode_types'.
Tags
since
1.0.0
Return
(array<string|int, mixed>) $$map The Array Map requested.

declare_shortcodes_add_filter()

Provide a public facing method to add ShortCodes to the TukuToi ShortCodes library

public declare_shortcodes_add_filter(array<string|int, mixed> $external_shortcodes) : array<string|int, mixed>
Description

Adds ShortCodes to tkt_scs_register_shortcode Filter.

Parameters
$external_shortcodes
(array<string|int, mixed>) The array of shortcodes being added.
Tags
since
2.0.0
Return
(array<string|int, mixed>) $$external_shortcodes The ShortCodes array.

declare_shortcodes_types_add_filter()

Provide a public facing method to add ShortCode Types to the TukuToi ShortCodes GUI.

public declare_shortcodes_types_add_filter(array<string|int, mixed> $external_shortcode_types) : array<string|int, mixed>
Description

Adds ShortCode Types to tkt_scs_register_shortcode_type Filter.

Parameters
$external_shortcode_types
(array<string|int, mixed>) The array of Shortcode Types being added.
Tags
since
2.0.0
Return
(array<string|int, mixed>) $$external_shortcode_types The ShortCode Types array.

declare_shortcodes()

Register an array of Shortcodes of this plugin

private declare_shortcodes() : array<string|int, mixed>
Description

Multidimensional array keyed by ShortCode tagname, each holding an array of ShortCode data:

  • Label
  • Type
Tags
since
1.0.0
Return
(array<string|int, mixed>) $shortcodes The ShortCodes array.

sanitize_options()

All Sanitization Options.

private sanitize_options() : array<string|int, mixed>
Tags
since
1.0.0
Return
(array<string|int, mixed>) { Multidimensional Array keyed by Sanitization options. @type array $sanitization_option { Single sanitization option array, holding label and callback of sanitization option. @type string $label Label of Sanitization option as used in GUI. @type string $callback The callback to the Sanitization function. } }

Search results