Overview

Namespaces

  • None
  • PHP

Classes

  • Sidecar
  • Sidecar_Admin_Page
  • Sidecar_Admin_Tab
  • Sidecar_Field
  • Sidecar_Form
  • Sidecar_Form_Settings
  • Sidecar_Plugin_Base
  • Sidecar_Plugin_Settings
  • Sidecar_Settings_Base
  • Sidecar_Shortcode
  • Sidecar_Singleton_Base

Functions

  • body
  • format_gmt_string
  • headers
  • output_css
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class Sidecar_Plugin_Settings

Class Sidecar_Settings_Base

ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable
Extended by Sidecar_Settings_Base
Extended by Sidecar_Plugin_Settings
Located at classes/class-plugin-settings.php
Methods summary
public
# __construct( Sidecar_Plugin_Base|Sidecar_Settings_Base $plugin, string $option_name )

Parameters

$plugin
Sidecar_Plugin_Base|Sidecar_Settings_Base
$plugin
$option_name
string
$option_name

Overrides

Sidecar_Settings_Base::__construct()
public
# register_form_settings( string $form_name )

Register a form

Register a form

Parameters

$form_name
string
$form_name
public
# register_setting( string $setting_name, boolean|string $setting_class = false )

Register a setting

Register a setting

Parameters

$setting_name
string
$setting_name
$setting_class
boolean|string
$setting_class

Overrides

Sidecar_Settings_Base::register_setting()
public Sidecar_Settings_Base|Sidecar_Form_Settings
# get_setting( string $setting_name )

Parameters

$setting_name
string
$setting_name

Returns

Sidecar_Settings_Base|Sidecar_Form_Settings

Overrides

Sidecar_Settings_Base::get_setting()
public
# shutdown( )

Autosave dirty settings on shutdown

Autosave dirty settings on shutdown

public
# delete_settings( )

Removes settings from the wp_options table in the WordPress MySQL database.

Removes settings from the wp_options table in the WordPress MySQL database.

public
# set_values( array $forms )

Accepts an array of $form objects and assigns to the internal array.

Accepts an array of $form objects and assigns to the internal array.

Parameters

$forms
array
$forms

Overrides

Sidecar_Settings_Base::set_values()
public
# set_values_deep( array $forms_values )

Accepts an array of name/value pairs and assigns the settings.

Accepts an array of name/value pairs and assigns the settings.

Parameters

$forms_values
array
$forms_values
public array
# set_data( string|object $data )

Accept an object that might have been serialized and stored in wp_options table in the WordPress MySQL database.

Accept an object that might have been serialized and stored in wp_options table in the WordPress MySQL database.

Parameters

$data
string|object
$data

Returns

array
public
# load_settings( )

Load settings from the wp_options table in the WordPress MySQL database.

Load settings from the wp_options table in the WordPress MySQL database.

public
# get_data( )

Format the settings as an object that can be serialized to the wp_options table in the WordPress MySQL database.

Format the settings as an object that can be serialized to the wp_options table in the WordPress MySQL database.

public
# save_settings( )

Save settings to the wp_options table in the WordPress MySQL database.

Save settings to the wp_options table in the WordPress MySQL database.

public boolean
# is_encrypted( )

Get a string representing the encryption status

Get a string representing the encryption status

Returns

boolean

Overrides

Sidecar_Settings_Base::is_encrypted()
public
# set_encrypted( boolean $is_encrypted )

Parameters

$is_encrypted
boolean
$is_encrypted

Overrides

Sidecar_Settings_Base::set_encrypted()
public
# decrypt_settings( )

Call decryption method if specified in plugin.

Call decryption method if specified in plugin.

public
# encrypt_settings( )

Call decryption method if specified in plugin.

Call decryption method if specified in plugin.

public
# set_dirty( mixed $is_dirty )

Parameters

$is_dirty
mixed
$is_dirty

Overrides

Sidecar_Settings_Base::set_dirty()
Methods inherited from Sidecar_Settings_Base
get_value(), get_values(), get_values_deep(), has_setting(), is_dirty(), offsetGet(), set_setting(), update_settings(), update_settings_value()
Methods inherited from ArrayObject
append(), asort(), count(), exchangeArray(), getArrayCopy(), getFlags(), getIterator(), getIteratorClass(), ksort(), natcasesort(), natsort(), offsetExists(), offsetSet(), offsetUnset(), serialize(), setFlags(), setIteratorClass(), uasort(), uksort(), unserialize()
Constants inherited from ArrayObject
ARRAY_AS_PROPS, STD_PROP_LIST
Properties summary
public string $option_name
#
public string $installed_version
#
public boolean $configured false
#
protected boolean $_is_encrypted
#
public object $_plugin
#

Mirrors $_parent so semantics are easier to understand while debugging.

Mirrors $_parent so semantics are easier to understand while debugging.

Properties inherited from Sidecar_Settings_Base
$_is_dirty, $_parent
API documentation generated by ApiGen 2.8.0