SettingsPage extends AbstractCustomPage
in package

Tags
since
1.0

Table of Contents

$capability  : string
$currentSection  : string|null
Don't access directly. This is a cache field. Use getCurrentSection() instead.
$currentTab  : string|null
Don't access directly. This is a cache field. Use getCurrentTab() instead.
$fields  : array<string|int, AbstractField>
$id  : string
$menuIcon  : string
$menuTitle  : string
$name  : string
$pageTitle  : string
$parentMenu  : string
$position  : int
$saved  : bool
$screenId  : string
__construct()  : mixed
__get()  : mixed|null
addActions()  : mixed
addMenu()  : mixed
display()  : mixed
enqueueScripts()  : mixed
getCurrentSection()  : string
getCurrentTab()  : string
getFields()  : array<string|int, mixed>
getId()  : string
getUrl()  : string
isCurrentPage()  : bool
<b>Note:</b> use the method after 'admin_init' hook ('current_screen' for example).
load()  : mixed
maybeEnqueueScripts()  : mixed
canSave()  : bool
getDefaults()  : array<string|int, mixed>
getMenuTitle()  : string
getPageTitle()  : string
maybeSave()  : mixed
parseRequest()  : array<string|int, mixed>
renderForm()  : string
renderNotice()  : string
renderTabs()  : string

Properties

$capability

protected string $capability
Tags
since
1.0

$currentSection

Don't access directly. This is a cache field. Use getCurrentSection() instead.

protected string|null $currentSection = null
Tags
see
SettingsPage::getCurrentSection()
since
1.1.0

$currentTab

Don't access directly. This is a cache field. Use getCurrentTab() instead.

protected string|null $currentTab = null
Tags
see
SettingsPage::getCurrentTab()
since
1.0

$fields

protected array<string|int, AbstractField> $fields = array()
Tags
since
1.0

$id

protected string $id
Tags
since
1.0

$menuTitle

protected string $menuTitle
Tags
since
1.0

$name

protected string $name
Tags
since
1.0

$pageTitle

protected string $pageTitle
Tags
since
1.0

$parentMenu

protected string $parentMenu
Tags
since
1.0

$position

protected int $position
Tags
since
1.0

$saved

protected bool $saved = false
Tags
since
1.0

$screenId

protected string $screenId
Tags
since
1.0

Methods

__construct()

public __construct(string $name[, array<string|int, mixed> $args = array() ]) : mixed
Parameters
$name : string
$args : array<string|int, mixed> = array()

Optional.

Tags
since
1.0
todo

Add parent menu slug.

Return values
mixed —

__get()

public __get(string $name) : mixed|null
Parameters
$name : string
Tags
since
1.0
Return values
mixed|null —

addActions()

public addActions() : mixed
Tags
since
1.0
Return values
mixed —

addMenu()

public addMenu() : mixed
Tags
access

protected

since
1.0
Return values
mixed —

display()

public display() : mixed
Tags
access

protected

since
1.0
Return values
mixed —

enqueueScripts()

public enqueueScripts() : mixed
Tags
access

protected

since
1.1.0
Return values
mixed —

getCurrentSection()

public getCurrentSection() : string
Tags
since
1.1.0
Return values
string —

getCurrentTab()

public getCurrentTab() : string
Tags
since
1.0
Return values
string —

getFields()

public getFields([string $tab = '' ][, string $section = '' ]) : array<string|int, mixed>
Parameters
$tab : string = ''

Optional. Current tab by default.

$section : string = ''

Optional. No section by default.

Tags
since
1.1.0
Return values
array<string|int, mixed> —

getId()

public getId() : string
Tags
since
1.0
Return values
string —

getUrl()

public getUrl([array<string|int, mixed> $additionalArgs = array() ]) : string
Parameters
$additionalArgs : array<string|int, mixed> = array()

Optional.

Tags
since
1.0
Return values
string —

isCurrentPage()

<b>Note:</b> use the method after 'admin_init' hook ('current_screen' for example).

public isCurrentPage() : bool
Tags
since
1.0
Return values
bool —

load()

public load() : mixed
Tags
access

protected

since
1.0
Return values
mixed —

maybeEnqueueScripts()

public maybeEnqueueScripts() : mixed
Tags
access

protected

since
1.1.0
Return values
mixed —

canSave()

protected canSave() : bool
Tags
since
1.0
Return values
bool —

getDefaults()

protected getDefaults() : array<string|int, mixed>
Tags
since
1.0
Return values
array<string|int, mixed> —

getMenuTitle()

protected getMenuTitle() : string
Tags
since
1.0
Return values
string —

getPageTitle()

protected getPageTitle() : string
Tags
since
1.0
Return values
string —

maybeSave()

protected maybeSave() : mixed
Tags
since
1.0
Return values
mixed —

parseRequest()

protected parseRequest() : array<string|int, mixed>
Tags
since
1.0
Return values
array<string|int, mixed> —

Values to save: [Option name => New value].

renderForm()

protected renderForm() : string
Tags
since
1.0
Return values
string —

renderNotice()

protected renderNotice() : string
Tags
since
1.0
Return values
string —

renderTabs()

protected renderTabs() : string
Tags
since
1.0
Return values
string —

Search results