PHP Класс EP_Module

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

Открытые свойства

Свойство Тип Описание
$active boolean True if the module is active
$dependencies_met_cb callback Contains registered callback to determine if a modules dependencies are met
$module_box_long_cb callback Contains registered callback to output module long description in module box
$module_box_summary_cb callback Contains registered callback to output module summary in module box
$post_activation_cb callback Contains registered callback to execute after activation
$requires_install_reindex [type] True if the module requires content reindexing after activating
$setup_cb callback Contains registered callback to execute after setup
$slug string Module slug
$title string Module pretty title

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

Метод Описание
__construct ( $args ) Initiate the module, setting all relevant instance variables
dependencies_met ( ) : boolean | WP_Error Ran to see if dependencies are met. Returns true or a WP_Error containing an error message to display
is_active ( ) : boolean Returns true if the module is active
output_module_box ( ) Outputs module box
output_module_box_full ( ) Outputs module box long description
post_activation ( ) Ran after a module is activated
setup ( ) Ran after a function is activated

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

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

Initiate the module, setting all relevant instance variables
С версии: 2.1
public __construct ( $args )

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

Ran to see if dependencies are met. Returns true or a WP_Error containing an error message to display
С версии: 2.1
public dependencies_met ( ) : boolean | WP_Error
Результат boolean | WP_Error

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

Returns true if the module is active
С версии: 2.1
public is_active ( ) : boolean
Результат boolean

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

Outputs module box
С версии: 2.1
public output_module_box ( )

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

Outputs module box long description
С версии: 2.1

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

Ran after a module is activated
С версии: 2.1
public post_activation ( )

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

Ran after a function is activated
С версии: 2.1
public setup ( )

Описание свойств

$active публичное свойство

True if the module is active
С версии: 2.1
public bool $active
Результат boolean

$dependencies_met_cb публичное свойство

Contains registered callback to determine if a modules dependencies are met
С версии: 2.1
public callback $dependencies_met_cb
Результат callback

$module_box_long_cb публичное свойство

Contains registered callback to output module long description in module box
С версии: 2.1
public callback $module_box_long_cb
Результат callback

$module_box_summary_cb публичное свойство

Contains registered callback to output module summary in module box
С версии: 2.1
public callback $module_box_summary_cb
Результат callback

$post_activation_cb публичное свойство

Contains registered callback to execute after activation
С версии: 2.1
public callback $post_activation_cb
Результат callback

$requires_install_reindex публичное свойство

True if the module requires content reindexing after activating
С версии: 2.1
public [type] $requires_install_reindex
Результат [type]

$setup_cb публичное свойство

Contains registered callback to execute after setup
С версии: 2.1
public callback $setup_cb
Результат callback

$slug публичное свойство

Module slug
С версии: 2.1
public string $slug
Результат string

$title публичное свойство

Module pretty title
С версии: 2.1
public string $title
Результат string