General implements Registerable, Standard_Service
General Setting Tab
Tags
Interfaces, Classes and Traits
- Registerable
- Standard_Service
Table of Contents
- $id : mixed
- $license_setting : mixed
- $plugin : mixed
- __construct() : mixed
- Constructor.
- get_id() : string
- Return the ID of the settings tab.
- get_settings() : array<string|int, mixed>
- Retrieves the setp settings.
- handle_license() : string
- Handle license activation
- handle_login_page() : string
- Adds shortcode to the login page if it doesn't exist
- register() : mixed
- {@inheritdoc}
- sanitize_login_redirect() : string
- Sanitizes the Login Redirect URL setting.
- sanitize_registration_redirect() : string
- Sanitizes the Registration Redirect URL setting.
- sanitize_tinymce_editor_field() : string
- Sanitizes TinyMCE settings field.
- tinymce_editor_field() : mixed
- Outputs a TinyMCE settings field.
- update_login_page() : string
- Update the login page when settings related to it's display change.
- sanitize_url() : string
- Sanitize and ensure a valid URL.
Properties
$id
private
mixed
$id
Tags
$license_setting
private
mixed
$license_setting
Tags
$plugin
private
mixed
$plugin
Tags
Methods
__construct()
Constructor.
public
__construct(string $id, Plugin $plugin) : mixed
Parameters
- $id : string
- $plugin : Plugin
Tags
Return values
mixed —get_id()
Return the ID of the settings tab.
public
get_id() : string
Tags
Return values
string —get_settings()
Retrieves the setp settings.
public
get_settings() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —handle_license()
Handle license activation
public
handle_license(string $value) : string
Parameters
- $value : string
Tags
Return values
string —$value
handle_login_page()
Adds shortcode to the login page if it doesn't exist
public
handle_login_page(string $value) : string
Parameters
- $value : string
Tags
Return values
string —$value
register()
{@inheritdoc}
public
register() : mixed
Tags
Return values
mixed —sanitize_login_redirect()
Sanitizes the Login Redirect URL setting.
public
sanitize_login_redirect(string $value) : string
Parameters
- $value : string
Tags
Return values
string —sanitize_registration_redirect()
Sanitizes the Registration Redirect URL setting.
public
sanitize_registration_redirect(string $value) : string
Parameters
- $value : string
Tags
Return values
string —sanitize_tinymce_editor_field()
Sanitizes TinyMCE settings field.
public
sanitize_tinymce_editor_field(mixed $value, mixed $option, mixed $raw_value) : string
Parameters
- $value : mixed
- $option : mixed
- $raw_value : mixed
Tags
Return values
string —tinymce_editor_field()
Outputs a TinyMCE settings field.
public
tinymce_editor_field(mixed $value) : mixed
Parameters
- $value : mixed
Tags
Return values
mixed —update_login_page()
Update the login page when settings related to it's display change.
public
update_login_page(string $value) : string
This allows for additional cache clearing with environments not supporting WP DONOTCACHE constants.
Parameters
- $value : string
Tags
Return values
string —$value
sanitize_url()
Sanitize and ensure a valid URL.
private
sanitize_url(string $url) : string
Parameters
- $url : string