API Documentation
\

\ReduxFramework

Main ReduxFramework class

Summary

Methods
Properties
Constants
init()
__construct()
_update_check()
_admin_notices()
_dismiss_admin_notice()
_internationalization()
get_instance()
_tracking()
_get_default()
get()
set()
set_global_variable()
set_options()
get_options()
get_wordpress_data()
show()
_default_values()
_fold_values()
get_fold()
_default_cleanup()
_options_page()
_admin_bar_menu()
_enqueue_output()
_enqueue()
_load_page()
admin_head()
admin_footer_text()
get_default_output_string()
get_header_html()
_register_settings()
_register_extensions()
_validate_options()
_validate_values()
section_menu()
_options_page_html()
_section_desc()
_field_input()
_can_output_css()
check_dependencies()
create_data_string()
$_version
$_dir
$_url
$_properties
$_is_plugin
$framework_url
$instance
$admin_notices
$page
$args
$sections
$errors
$warnings
$options
$options_defaults
$localize_data
$folds
$path
$output
$outputCSS
$compilerCSS
$customizerCSS
$fieldsValues
$fieldsHidden
$toHide
$typography
$import_export
$debug
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$show_hints
N/A

Properties

$_version

$_version

$_dir

$_dir

$_url

$_url

$_properties

$_properties

$_is_plugin

$_is_plugin

$framework_url

$framework_url

$instance

$instance

$admin_notices

$admin_notices

$page

$page

$args

$args

$sections

$sections

$errors

$errors

$warnings

$warnings

$options

$options

$options_defaults

$options_defaults

$localize_data

$localize_data

$folds

$folds

$path

$path

$output

$output

$outputCSS

$outputCSS

$compilerCSS

$compilerCSS

$customizerCSS

$customizerCSS

$fieldsValues

$fieldsValues

$fieldsHidden

$fieldsHidden

$toHide

$toHide

$typography

$typography

$import_export

$import_export

$debug

$debug

$show_hints

$show_hints

Methods

init()

init()

__construct()

__construct(array $sections, array $args, array $extra_tabs) : \ReduxFramework

Class Constructor. Defines the args for the theme options class

Parameters

array $sections

Panel sections.
array $args

Class constructor arguments.
array $extra_tabs

Extra panel tabs. // REMOVE

Returns

\ReduxFramework

_update_check()

_update_check()

_admin_notices()

_admin_notices()

_dismiss_admin_notice()

_dismiss_admin_notice()

_internationalization()

_internationalization()

Load the plugin text domain for translation.

_tracking()

_tracking()

_get_default()

_get_default(string $opt_name, mixed $default) : mixed

->_get_default(); This is used to return the default value if default_show is set

Parameters

string $opt_name

The option name to return
mixed $default

(null) The value to return if default not set

Returns

mixed —

$default

get()

get(string $opt_name, mixed $default) : mixed

->get(); This is used to return and option value from the options array

Parameters

string $opt_name

The option name to return
mixed $default

(null) The value to return if option not set

Returns

mixed

set()

set(string $opt_name, mixed $value) : void

->set(); This is used to set an arbitrary option in the options array

Parameters

string $opt_name

The name of the option being added
mixed $value

The value of the option being added

set_global_variable()

set_global_variable() : bool

Set a global variable by the global_variable argument

Returns

bool —

(global was set)

set_options()

set_options(mixed $value)

->set_options(); This is used to set an arbitrary option in the options array

Parameters

mixed $value

the value of the option being added

get_options()

get_options()

->get_options(); This is used to get options from the database

get_wordpress_data()

get_wordpress_data( $type,  $args)

->get_wordpress_date() - Get Wordpress specific data from the DB and return in a usable array

Parameters

$type
$args

show()

show(string $opt_name, mixed $default) : void

->show(); This is used to echo and option value from the options array

Parameters

string $opt_name

The name of the option being shown
mixed $default

The value to show if $opt_name isn't set

_default_values()

_default_values() : array

Get default options into an array suitable for the settings API

Returns

array —

$this->options_defaults

_fold_values()

_fold_values()

Get fold values into an array suitable for setting folds

get_fold()

get_fold(array $field) : array

get_fold() - Get the fold values

Parameters

array $field

Returns

array

_default_cleanup()

_default_cleanup() : void

Set default options on admin_init if option doesn't exist

_options_page()

_options_page() : void

Class Options Page Function, creates main options page.

_admin_bar_menu()

_admin_bar_menu() : void

Add admin bar menu

_enqueue_output()

_enqueue_output() : void

Enqueue CSS/JS for options page

_enqueue()

_enqueue() : void

Enqueue CSS/JS for options page

_load_page()

_load_page() : void

Show page help

admin_head()

admin_head() : void

Do action redux-admin-head for options page

admin_footer_text()

admin_footer_text() : string

Return footer text

Returns

string —

$this->args['footer_credit']

get_default_output_string()

get_default_output_string( $field) : string

Return default output string for use in panel

Parameters

$field

Returns

string —

default_output

get_header_html()

get_header_html( $field)

Parameters

$field

_register_settings()

_register_settings() : void

Register Option for use

_register_extensions()

_register_extensions() : void

Register Extensions for use

_validate_options()

_validate_options(array $plugin_options) : array|mixed|string|void

Validate the Options options before insertion

Parameters

array $plugin_options

The options array

Returns

array|mixed|string|void

_validate_values()

_validate_values(array $plugin_options, array $options,  $sections) : array

Validate values from options form (used in settings api validate function) calls the custom validation class for the field so authors can override with custom classes

Parameters

array $plugin_options
array $options
$sections

Returns

array —

$plugin_options

section_menu()

section_menu( $k,  $section,  $suffix) : void

Return Section Menu HTML

Parameters

$k
$section
$suffix

_options_page_html()

_options_page_html() : void

HTML OUTPUT.

_section_desc()

_section_desc(array $section) : void

Section HTML OUTPUT.

Parameters

array $section

_field_input()

_field_input(array $field, string $v) : void

Field HTML OUTPUT.

Gets option from options array, then calls the specific field type class - allows extending by other devs

Parameters

array $field
string $v

_can_output_css()

_can_output_css(mixed $field) : bool

Can Output CSS Check if a field meets its requirements before outputting to CSS

Parameters

mixed $field

Returns

bool

check_dependencies()

check_dependencies(array $field) : array

Checks dependencies between objects based on the $field['required'] array

If the array is set it needs to have exactly 3 entries. The first entry describes which field should be monitored by the current field. eg: "content" The second entry describes the comparison parameter. eg: "equals, not, is_larger, is_smaller ,contains" The third entry describes the value that we are comparing against.

Example: if the required array is set to array('content','equals','Hello World'); then the current field will only be displayed if the field with id "content" has exactly the value "Hello World"

Parameters

array $field

Returns

array —

$params

create_data_string()

create_data_string(array $data) : string

converts an array into a html data string

Parameters

array $data

example input: array('id'=>'true')

Returns

string —

$data_string example output: data-id='true'