PHP Class Pressbooks\Modules\ThemeOptions\WebOptions

Inheritance: extends Pressbooks\Options
Afficher le fichier Open project: pressbooks/pressbooks

Méthodes publiques

Свойство Type Description
$currentVersion integer The value for option: pressbooks_theme_options_web_version
$defaults array Web theme defaults.
$options array Web theme options.

Méthodes publiques

Méthode Description
__construct ( array $options ) Constructor.
display ( ) Display the web options tab description.
doInitialUpgrade ( ) Remove deprecated keys from web options.
filterDefaults ( array $defaults ) : array Filter the array of default values for the web options tab.
getBooleanOptions ( ) : array Get an array of options which return booleans.
getDefaults ( ) : array Get an array of default values for the web options tab.
getSlug ( ) : string Get the slug for the web options tab.
getTitle ( ) : string Get the localized title of the web options tab.
init ( ) Configure the web options tab using the settings API.
render ( ) Render the web options tab form (NOT USED).
renderPartTitle ( array $args ) Render the social_media checkbox.
renderSocialMediaField ( array $args ) Render the social_media checkbox.
upgrade ( integer $version ) Upgrade handler for web options.

Method Details

__construct() public méthode

Constructor.
public __construct ( array $options )
$options array

display() public méthode

Display the web options tab description.
public display ( )

doInitialUpgrade() public méthode

Remove deprecated keys from web options.
public doInitialUpgrade ( )

filterDefaults() static public méthode

Filter the array of default values for the web options tab.
static public filterDefaults ( array $defaults ) : array
$defaults array
Résultat array $defaults

getBooleanOptions() static public méthode

Get an array of options which return booleans.
static public getBooleanOptions ( ) : array
Résultat array $options

getDefaults() static public méthode

Get an array of default values for the web options tab.
static public getDefaults ( ) : array
Résultat array $defaults

getSlug() static public méthode

Get the slug for the web options tab.
static public getSlug ( ) : string
Résultat string $slug

getTitle() static public méthode

Get the localized title of the web options tab.
static public getTitle ( ) : string
Résultat string $title

init() public méthode

Configure the web options tab using the settings API.
public init ( )

render() public méthode

Render the web options tab form (NOT USED).
public render ( )

renderPartTitle() public méthode

Render the social_media checkbox.
public renderPartTitle ( array $args )
$args array

renderSocialMediaField() public méthode

Render the social_media checkbox.
public renderSocialMediaField ( array $args )
$args array

upgrade() public méthode

Upgrade handler for web options.
public upgrade ( integer $version )
$version integer

Property Details

$currentVersion static_oe public_oe property

The value for option: pressbooks_theme_options_web_version
See also: upgrade()
static public int $currentVersion
Résultat integer

$defaults public_oe property

Web theme defaults.
public array $defaults
Résultat array

$options public_oe property

Web theme options.
public array $options
Résultat array