PHP Class Twitter\WordPress\Admin\Settings\SinglePage

Since: 1.0.0
Mostra file Open project: twitter/wordpress

Protected Properties

Property Type Description
$SETTINGS_COMPONENTS The addToSettingsPage method is called on each class to initialize its components
$hook_suffix The hook suffix assigned by add_utility_page()

Public Methods

Method Description
addContextualHelp ( ) : void Add contextual help content to the settings screen
featureName ( ) : string Reference the feature by name
getSettingsComponentsForEnabledFeatures ( ) : array Do not display a settings section if the related feature has been disabled by the site
menuItem ( ) : string | null Add a submenu item to WordPress admin.
settingsPage ( ) : void Load the settings page

Method Details

addContextualHelp() public method

Add contextual help content to the settings screen
Since: 1.0.0
public addContextualHelp ( ) : void
return void

featureName() public static method

Reference the feature by name
Since: 1.0.0
public static featureName ( ) : string
return string translated feature name

getSettingsComponentsForEnabledFeatures() public static method

Do not display a settings section if the related feature has been disabled by the site
Since: 1.3.0
public static getSettingsComponentsForEnabledFeatures ( ) : array
return array { Settings component full qualified class names @type string fully qualified class name }

menuItem() public static method

Add a submenu item to WordPress admin.
Since: 1.0.0
public static menuItem ( ) : string | null
return string | null page hook or null if page capability requirements not met

settingsPage() public method

Load the settings page
Since: 1.0.0
public settingsPage ( ) : void
return void

Property Details

$SETTINGS_COMPONENTS protected_oe static_oe property

The addToSettingsPage method is called on each class to initialize its components
Since: 1.0.0
protected static $SETTINGS_COMPONENTS

$hook_suffix protected_oe property

The hook suffix assigned by add_utility_page()
Since: 1.0.0
protected $hook_suffix