Settings_Controller implements Standard_Service

Handles registration of the settings manager that powers the settings page.

Tags
author

Barn2 Plugins support@barn2.com

license

GPL-3.0

copyright

Barn2 Media Ltd

Interfaces, Classes and Traits

Standard_Service

Table of Contents

$defaults  : array<string|int, mixed>
The default options.
$manager  : Settings_Manager
The settings manager.
$plugin  : Plugin
The plugin.
$settings_tabs  : array<string|int, mixed>
The settings tabs.
__construct()  : mixed
Constructor
configure_manager()  : void
Configure the settings manager.
get_manager()  : Settings_Manager
Get the settings manager.
register()  : void
{@inheritdoc}
sanitize_document_page()  : string
Sanitize the Document Page setting.
sanitize_document_slug()  : string
Sanitize the Document Slug setting.
sanitize_search_page()  : string
Sanitize the Search Page setting.
sanitize_settings()  : array<string|int, mixed>
Sanitize the settings.
sanitize_svg()  : string
Sanitize the SVG setting.
get_settings_config()  : array<string|int, mixed>
Get the settings config.
get_settings_tabs()  : array<string|int, mixed>
Retrieves the settings tab classes.

Properties

$settings_tabs

The settings tabs.

protected array<string|int, mixed> $settings_tabs
Tags

Methods

configure_manager()

Configure the settings manager.

public configure_manager() : void
Tags
Return values
void

get_manager()

Get the settings manager.

public get_manager() : Settings_Manager
Tags
Return values
Settings_Manager

sanitize_document_page()

Sanitize the Document Page setting.

public sanitize_document_page(string $page_setting) : string
Parameters
$page_setting : string
Tags
Return values
string

sanitize_document_slug()

Sanitize the Document Slug setting.

public sanitize_document_slug(string $slug_setting) : string
Parameters
$slug_setting : string
Tags
Return values
string

sanitize_search_page()

Sanitize the Search Page setting.

public sanitize_search_page(string $page_setting) : string
Parameters
$page_setting : string
Tags
Return values
string

sanitize_settings()

Sanitize the settings.

public sanitize_settings(array<string|int, mixed> $settings, WP_REST_Request $request, Settings_Manager $settings_manager, string $option_name) : array<string|int, mixed>
Parameters
$settings : array<string|int, mixed>
$request : WP_REST_Request
$settings_manager : Settings_Manager
$option_name : string
Tags
Return values
array<string|int, mixed>

sanitize_svg()

Sanitize the SVG setting.

public sanitize_svg(string $svg_setting) : string
Parameters
$svg_setting : string
Tags
Return values
string

get_settings_config()

Get the settings config.

private get_settings_config() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>

get_settings_tabs()

Retrieves the settings tab classes.

private get_settings_tabs() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>

Search results