PHP Класс Pressbooks\Options

Показать файл Открыть проект

Открытые методы

Метод Описание
display ( ) Display the options page or tab description.
filterDefaults ( array $defaults ) : array Filter the array of default values for this set of options
getDefaults ( ) : array Get an array of default values for this set of options
getSlug ( ) : string Get the slug for this options page or tab.
getTitle ( ) : string Get the localized title of this options page or tab.
init ( ) Configure the options page or tab using the settings API.
render ( ) Render the options page or tab.
sanitize ( array $input ) : array Sanitize various options (boolean, string, integer, float).
upgrade ( integer $version ) Upgrade handler for the options page or tab.

Защищенные методы

Метод Описание
renderCheckbox ( string $id, string $name, string $option, string $value = '', string $description ) Render a checkbox.
renderCustomSelect ( string $id, string $name, string $value = '', string $args, boolean $multiple = false ) Render a custom select element.
renderField ( string $id, string $name, string $option, string $value = '', string $description = '', string $append = '', string $type = 'text', $class = 'regular-text', boolean $disabled = false ) Render an input.
renderRadioButtons ( string $id, string $name, string $option, string $value = '', string $args, boolean $custom = false ) Render radio buttons.
renderSelect ( string $id, string $name, string $option, string $value = '', string $args, boolean $multiple = false ) Render a select element.

Описание методов

display() абстрактный публичный Метод

Display the options page or tab description.
abstract public display ( )

filterDefaults() абстрактный статический публичный Метод

Filter the array of default values for this set of options
abstract static public filterDefaults ( array $defaults ) : array
$defaults array
Результат array $defaults

getDefaults() абстрактный статический публичный Метод

Get an array of default values for this set of options
abstract static public getDefaults ( ) : array
Результат array $defaults

getSlug() абстрактный статический публичный Метод

Get the slug for this options page or tab.
abstract static public getSlug ( ) : string
Результат string $slug

getTitle() абстрактный статический публичный Метод

Get the localized title of this options page or tab.
abstract static public getTitle ( ) : string
Результат string $title

init() абстрактный публичный Метод

Configure the options page or tab using the settings API.
abstract public init ( )

render() абстрактный публичный Метод

Render the options page or tab.
abstract public render ( )

renderCheckbox() защищенный Метод

Render a checkbox.
protected renderCheckbox ( string $id, string $name, string $option, string $value = '', string $description )
$id string
$name string
$option string
$value string
$description string

renderCustomSelect() защищенный Метод

Render a custom select element.
protected renderCustomSelect ( string $id, string $name, string $value = '', string $args, boolean $multiple = false )
$id string
$name string
$value string
$args string
$multiple boolean

renderField() защищенный Метод

Render an input.
protected renderField ( string $id, string $name, string $option, string $value = '', string $description = '', string $append = '', string $type = 'text', $class = 'regular-text', boolean $disabled = false )
$id string
$name string
$option string
$value string
$description string
$append string
$type string
$disabled boolean

renderRadioButtons() защищенный Метод

Render radio buttons.
protected renderRadioButtons ( string $id, string $name, string $option, string $value = '', string $args, boolean $custom = false )
$id string
$name string
$option string
$value string
$args string
$custom boolean

renderSelect() защищенный Метод

Render a select element.
protected renderSelect ( string $id, string $name, string $option, string $value = '', string $args, boolean $multiple = false )
$id string
$name string
$option string
$value string
$args string
$multiple boolean

sanitize() публичный Метод

Sanitize various options (boolean, string, integer, float).
public sanitize ( array $input ) : array
$input array
Результат array $options

upgrade() абстрактный публичный Метод

Upgrade handler for the options page or tab.
abstract public upgrade ( integer $version )
$version integer