Admin extends Component
Implements integration with WordPress admin.
Table of Contents
- $meta_boxes : array<string|int, mixed>
- Meta boxes.
- $post_states : array<string|int, mixed>
- Post states.
- __call() : mixed
- Catches calls to undefined methods.
- __construct() : mixed
- Class constructor.
- add_admin_pages() : mixed
- Adds admin pages.
- add_meta_boxes() : mixed
- Adds meta boxes.
- add_post_states() : array<string|int, mixed>
- Adds post states.
- add_term_boxes() : mixed
- Adds term boxes.
- check_access() : mixed
- Checks user access.
- enqueue_scripts() : mixed
- Enqueues scripts.
- init_settings() : mixed
- Initializes settings.
- order_admin_pages() : array<string|int, mixed>
- Orders admin pages.
- register_post_states() : mixed
- Registers post states.
- register_post_types() : mixed
- Registers post types.
- register_settings() : mixed
- Registers settings.
- register_taxonomies() : mixed
- Registers taxonomies.
- remove_meta_boxes() : mixed
- Removes meta boxes.
- render_footer() : mixed
- Renders footer.
- render_links() : array<string|int, mixed>
- Renders plugin links.
- render_meta_box() : mixed
- Renders meta box fields.
- render_notice() : string
- Renders notice.
- render_notices() : mixed
- Renders notices.
- render_settings_field() : mixed
- Renders settings field.
- render_settings_section() : mixed
- Renders settings section.
- render_term_box() : mixed
- Renders term box fields.
- render_user_boxes() : mixed
- Renders user box fields.
- share_usage_data() : mixed
- Shares usage data.
- update_meta_box() : mixed
- Updates meta box values.
- update_term_box() : mixed
- Updates term box values.
- update_user_boxes() : mixed
- Updates user box values.
- validate_image_size_field() : mixed
- Validates image size field.
- boot() : mixed
- Bootstraps component properties.
- get_extensions() : array<string|int, mixed>
- Gets HivePress extensions.
- get_extensions_tab() : string
- Gets current extensions page tab.
- get_extensions_tabs() : array<string|int, mixed>
- Gets extensions page tabs.
- get_meta_boxes() : array<string|int, mixed>
- Gets meta boxes.
- get_settings_tab() : string
- Gets current settings page tab.
- get_settings_tabs() : array<string|int, mixed>
- Gets settings page tabs.
- get_themes() : array<string|int, mixed>
- Gets HivePress themes.
- render_tooltip() : string
- Renders tooltip.
- set_callbacks() : mixed
- Sets the action and filter callbacks.
- set_property() : mixed
- Sets a property value.
- validate_settings_field() : mixed
- Validates settings field.
Properties
$meta_boxes
Meta boxes.
protected
array<string|int, mixed>
$meta_boxes
= []
$post_states
Post states.
protected
array<string|int, mixed>
$post_states
= []
Methods
__call()
Catches calls to undefined methods.
public
__call(string $name, array<string|int, mixed> $args) : mixed
Parameters
- $name : string
-
Method name.
- $args : array<string|int, mixed>
-
Method arguments.
Tags
Return values
mixed —__construct()
Class constructor.
public
__construct([array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $args : array<string|int, mixed> = []
-
Component arguments.
Return values
mixed —add_admin_pages()
Adds admin pages.
public
add_admin_pages() : mixed
Return values
mixed —add_meta_boxes()
Adds meta boxes.
public
add_meta_boxes(string $post_type, WP_Post $post) : mixed
Parameters
- $post_type : string
-
Post type.
- $post : WP_Post
-
Post object.
Return values
mixed —add_post_states()
Adds post states.
public
add_post_states(array<string|int, mixed> $states, WP_Post $post) : array<string|int, mixed>
Parameters
- $states : array<string|int, mixed>
-
Post states.
- $post : WP_Post
-
Post object.
Return values
array<string|int, mixed> —add_term_boxes()
Adds term boxes.
public
add_term_boxes() : mixed
Return values
mixed —check_access()
Checks user access.
public
check_access() : mixed
Return values
mixed —enqueue_scripts()
Enqueues scripts.
public
enqueue_scripts() : mixed
Return values
mixed —init_settings()
Initializes settings.
public
init_settings() : mixed
Return values
mixed —order_admin_pages()
Orders admin pages.
public
order_admin_pages(array<string|int, mixed> $menu) : array<string|int, mixed>
Parameters
- $menu : array<string|int, mixed>
-
Menu items.
Return values
array<string|int, mixed> —register_post_states()
Registers post states.
public
register_post_states() : mixed
Return values
mixed —register_post_types()
Registers post types.
public
register_post_types() : mixed
Return values
mixed —register_settings()
Registers settings.
public
register_settings() : mixed
Return values
mixed —register_taxonomies()
Registers taxonomies.
public
register_taxonomies() : mixed
Return values
mixed —remove_meta_boxes()
Removes meta boxes.
public
remove_meta_boxes() : mixed
Return values
mixed —render_footer()
Renders footer.
public
render_footer() : mixed
Return values
mixed —render_links()
Renders plugin links.
public
render_links(array<string|int, mixed> $links) : array<string|int, mixed>
Parameters
- $links : array<string|int, mixed>
-
Plugin links.
Return values
array<string|int, mixed> —render_meta_box()
Renders meta box fields.
public
render_meta_box(WP_Post $post, array<string|int, mixed> $args) : mixed
Parameters
- $post : WP_Post
-
Post object.
- $args : array<string|int, mixed>
-
Meta box arguments.
Return values
mixed —render_notice()
Renders notice.
public
render_notice(array<string|int, mixed> $args) : string
Parameters
- $args : array<string|int, mixed>
-
Notice arguments.
Return values
string —render_notices()
Renders notices.
public
render_notices() : mixed
Return values
mixed —render_settings_field()
Renders settings field.
public
render_settings_field(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
-
Field arguments.
Return values
mixed —render_settings_section()
Renders settings section.
public
render_settings_section(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
-
Section arguments.
Return values
mixed —render_term_box()
Renders term box fields.
public
render_term_box(mixed $term[, string $taxonomy = '' ]) : mixed
Parameters
- $term : mixed
-
Term object.
- $taxonomy : string = ''
-
Taxonomy name.
Return values
mixed —render_user_boxes()
Renders user box fields.
public
render_user_boxes(WP_User $user) : mixed
Parameters
- $user : WP_User
-
User object.
Return values
mixed —share_usage_data()
Shares usage data.
public
share_usage_data() : mixed
Return values
mixed —update_meta_box()
Updates meta box values.
public
update_meta_box(int $post_id) : mixed
Parameters
- $post_id : int
-
Post ID.
Return values
mixed —update_term_box()
Updates term box values.
public
update_term_box(int $term_id) : mixed
Parameters
- $term_id : int
-
Term ID.
Return values
mixed —update_user_boxes()
Updates user box values.
public
update_user_boxes(int $user_id) : mixed
Parameters
- $user_id : int
-
User ID.
Return values
mixed —validate_image_size_field()
Validates image size field.
public
validate_image_size_field(mixed $value) : mixed
Parameters
- $value : mixed
-
Field value.
Return values
mixed —boot()
Bootstraps component properties.
protected
boot() : mixed
Return values
mixed —get_extensions()
Gets HivePress extensions.
protected
get_extensions([string $status = 'all' ]) : array<string|int, mixed>
Parameters
- $status : string = 'all'
-
Extensions status.
Return values
array<string|int, mixed> —get_extensions_tab()
Gets current extensions page tab.
protected
get_extensions_tab() : string
Return values
string —get_extensions_tabs()
Gets extensions page tabs.
protected
get_extensions_tabs() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_meta_boxes()
Gets meta boxes.
protected
get_meta_boxes(string $screen) : array<string|int, mixed>
Parameters
- $screen : string
-
Screen name.
Return values
array<string|int, mixed> —get_settings_tab()
Gets current settings page tab.
protected
get_settings_tab() : string
Return values
string —get_settings_tabs()
Gets settings page tabs.
protected
get_settings_tabs() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_themes()
Gets HivePress themes.
protected
get_themes() : array<string|int, mixed>
Return values
array<string|int, mixed> —render_tooltip()
Renders tooltip.
protected
render_tooltip(string $text) : string
Parameters
- $text : string
-
Tooltip text.
Return values
string —set_callbacks()
Sets the action and filter callbacks.
protected
final set_callbacks(array<string|int, mixed> $callbacks) : mixed
Parameters
- $callbacks : array<string|int, mixed>
-
Callback arguments.
Return values
mixed —set_property()
Sets a property value.
protected
final set_property(string $name, mixed $value[, string $prefix = '' ]) : mixed
Parameters
- $name : string
-
Property name.
- $value : mixed
-
Property value.
- $prefix : string = ''
-
Method prefix.
Return values
mixed —validate_settings_field()
Validates settings field.
protected
validate_settings_field(string $name, mixed $value) : mixed
Parameters
- $name : string
-
Field name.
- $value : mixed
-
Field value.