PHP Class Papi_Core_Box, papi

Afficher le fichier Open project: wp-papi/papi Class Usage Examples

Méthodes publiques

Свойство Type Description
$capabilities array Capabilities list.
$context string Context.
$display boolean Display box.
$id string The core type identifier.
$layout string Possible values are: - horizontal - vertical
$priority string Priority.
$properties array Box properties.
$site_id integer Site id.
$sort_order integer The sort order of the core box.
$title string The title of the box.

Protected Properties

Свойство Type Description
$options array Custom box options.

Méthodes publiques

Méthode Description
__construct ( array $args = [], array $properties = [] ) The constructor.
__toString ( ) : string Get a string representation of the object.
get_option ( string $key ) : mixed Get box option.
set_option ( string $key, mixed $value ) Set box option.

Méthodes protégées

Méthode Description
setup_args ( array $args ) Setup arguments.
setup_properties ( array $properties ) Setup properties.

Method Details

__construct() public méthode

The constructor.
public __construct ( array $args = [], array $properties = [] )
$args array
$properties array

__toString() public méthode

Get a string representation of the object.
public __toString ( ) : string
Résultat string

get_option() public méthode

Get box option.
public get_option ( string $key ) : mixed
$key string
Résultat mixed

set_option() public méthode

Set box option.
public set_option ( string $key, mixed $value )
$key string
$value mixed

setup_args() protected méthode

Setup arguments.
protected setup_args ( array $args )
$args array

setup_properties() protected méthode

Setup properties.
protected setup_properties ( array $properties )
$properties array

Property Details

$capabilities public_oe property

Capabilities list.
public array $capabilities
Résultat array

$context public_oe property

Context.
public string $context
Résultat string

$display public_oe property

Display box.
public bool $display
Résultat boolean

$id public_oe property

The core type identifier.
public string $id
Résultat string

$layout public_oe property

Possible values are: - horizontal - vertical
public string $layout
Résultat string

$options protected_oe property

Custom box options.
protected array $options
Résultat array

$priority public_oe property

Priority.
public string $priority
Résultat string

$properties public_oe property

Box properties.
public array $properties
Résultat array

$site_id public_oe property

Site id.
public int $site_id
Résultat integer

$sort_order public_oe property

The sort order of the core box.
public int $sort_order
Résultat integer

$title public_oe property

The title of the box.
public string $title
Résultat string