SettingsSubTab extends SettingsTab
in package

Table of Contents

$description  : string
$groups  : array<string|int, SettingsGroup>
$label  : string
$name  : string
$nonceName  : string
$nonceSaveAction  : string
$optionGroupName  : string
$pageName  : string
$subTabs  : array<string|int, SettingsSubTab>
$tabName  : string
$subTabName  : mixed
__construct()  : mixed
addGroup()  : mixed
addGroups()  : mixed
addSubTab()  : mixed
detectSubTab()  : mixed
findField()  : InputField|null
getDescription()  : string
getGroups()  : array<string|int, SettingsGroup>
getLabel()  : string
getName()  : string
getNonceName()  : string
getNonceSaveAction()  : string
getOptionGroupName()  : string
getPageName()  : string
register()  : mixed
render()  : mixed
save()  : mixed
setDescription()  : mixed
renderNavs()  : mixed
renderTab()  : mixed
checkNonce()  : bool
saveTab()  : mixed

Properties

$description

protected string $description

$groups

protected array<string|int, SettingsGroup> $groups = array()

$label

protected string $label

$name

protected string $name

$nonceName

protected string $nonceName

$nonceSaveAction

protected string $nonceSaveAction

$optionGroupName

protected string $optionGroupName

$pageName

protected string $pageName

$subTabs

protected array<string|int, SettingsSubTab> $subTabs = array()

$tabName

protected string $tabName

$subTabName

private mixed $subTabName

Methods

__construct()

public __construct(string $name, string $label, string $pageName[, string $tabName = '' ]) : mixed
Parameters
$name : string
$label : string
$pageName : string
$tabName : string = ''
Return values
mixed —

addGroup()

public addGroup(SettingsGroup $group) : mixed
Parameters
$group : SettingsGroup
Return values
mixed —

addGroups()

public addGroups(mixed $groups) : mixed
Parameters
$groups : mixed
Return values
mixed —

addSubTab()

public addSubTab(SettingsSubTab $subTab) : mixed
Parameters
$subTab : SettingsSubTab
Return values
mixed —

detectSubTab()

public detectSubTab() : mixed
Return values
mixed —

findField()

public findField(string $name[, int $groupIndex = -1 ]) : InputField|null
Parameters
$name : string

Field name.

$groupIndex : int = -1

Optional. The group to search in. All (-1) by default.

Tags
since
3.5.1
Return values
InputField|null —

Searched field or null if nothing found.

getDescription()

public getDescription() : string
Return values
string —

getGroups()

public getGroups() : array<string|int, SettingsGroup>
Return values
array<string|int, SettingsGroup> —

getLabel()

public getLabel() : string
Return values
string —

getName()

public getName() : string
Return values
string —

getNonceName()

public getNonceName() : string
Return values
string —

getNonceSaveAction()

public getNonceSaveAction() : string
Return values
string —

getOptionGroupName()

public getOptionGroupName() : string
Return values
string —

getPageName()

public getPageName() : string
Return values
string —

register()

public register() : mixed
Return values
mixed —

render()

public render() : mixed
Tags
since
3.7.0

added new action - "mphb_settings_tab_after_submit_button".

Return values
mixed —

save()

public save() : mixed
Return values
mixed —

setDescription()

public setDescription(string $description) : mixed
Parameters
$description : string
Return values
mixed —

renderNavs()

protected renderNavs(mixed $currentSubTab) : mixed
Parameters
$currentSubTab : mixed
Return values
mixed —

renderTab()

protected renderTab() : mixed
Tags
since
3.7.0

added new action - "mphb_settings_tab_after_submit_button".

Return values
mixed —

checkNonce()

private checkNonce() : bool
Return values
bool —

saveTab()

private saveTab() : mixed
Return values
mixed —

Search results