PHP Class Twitter\WordPress\Admin\Settings\Embeds\Theme

Since: 1.0.0
Inheritance: implements Twitter\WordPress\Admin\Settings\SettingsSection
Mostra file Open project: twitter/wordpress

Protected Properties

Property Type Description
$hook_suffix The hook suffix of the parent settings page

Public Methods

Method Description
addHelpTab ( WP_Screen $screen ) : void Display inline help content
addToSettingsPage ( string $hook_suffix ) : boolean Add site attribution option and settings section to an existing settings page
defaultOptions ( ) : array Default options if no options exist
defineRestrictionsSection ( ) : void Add warnings settings section and fields
defineSection ( ) : void Add theme settings section and fields
defineWarningsSection ( ) : void Add warnings settings section and fields
displayBorderColor ( ) : void Choose a hex color value as the border color
displayContentSecurityPolicy ( ) : void Suppress a Content Security Policy warning
displayDoNotTrack ( ) : void Do not track visitors for use in Twitter advertisers and site suggestions
displayLinkColor ( ) : void Choose a hex color value as the link color
displayTheme ( ) : void Choose a theme
featureName ( ) : string Reference the feature by name
onload ( ) : void Store existing options. Set up page sections
restrictionsSectionHeader ( ) : void Introduction to the Twitter restrictions section
sanitizeOptions ( array $options ) : array Sanitize theme options
sectionHeader ( ) : void Introduce the settings page
themeChoices ( ) : array Theme options and labels
warningsSectionHeader ( ) : void Introduce the warnings section

Method Details

addHelpTab() public static method

Display inline help content
Since: 1.0.0
public static addHelpTab ( WP_Screen $screen ) : void
$screen WP_Screen current screen
return void

addToSettingsPage() public static method

Add site attribution option and settings section to an existing settings page
Since: 1.0.0
public static addToSettingsPage ( string $hook_suffix ) : boolean
$hook_suffix string hook suffix of an existing settings page
return boolean site attribution settings loaded

defaultOptions() public static method

Default options if no options exist
Since: 1.0.0
public static defaultOptions ( ) : array
return array associative array of option values

defineRestrictionsSection() public method

Add warnings settings section and fields
Since: 1.0.0
public defineRestrictionsSection ( ) : void
return void

defineSection() public method

Add theme settings section and fields
Since: 1.0.0
public defineSection ( ) : void
return void

defineWarningsSection() public method

Add warnings settings section and fields
Since: 1.0.0
public defineWarningsSection ( ) : void
return void

displayBorderColor() public method

Choose a hex color value as the border color
Since: 1.0.0
public displayBorderColor ( ) : void
return void

displayContentSecurityPolicy() public method

Suppress a Content Security Policy warning
Since: 1.0.0
public displayContentSecurityPolicy ( ) : void
return void

displayDoNotTrack() public method

Do not track visitors for use in Twitter advertisers and site suggestions
Since: 1.0.0
public displayDoNotTrack ( ) : void
return void

displayLinkColor() public method

Choose a hex color value as the link color
Since: 1.0.0
public displayLinkColor ( ) : void
return void

displayTheme() public method

Choose a theme
Since: 1.0.0
public displayTheme ( ) : 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

onload() public method

Store existing options. Set up page sections
Since: 1.0.0
public onload ( ) : void
return void

restrictionsSectionHeader() public static method

Introduction to the Twitter restrictions section
Since: 1.0.0
public static restrictionsSectionHeader ( ) : void
return void

sanitizeOptions() public static method

Sanitize theme options
Since: 1.0.0
public static sanitizeOptions ( array $options ) : array
$options array submitted options
return array associative array of clean options

sectionHeader() public static method

Introduce the settings page
Since: 1.0.0
public static sectionHeader ( ) : void
return void

themeChoices() public static method

Theme options and labels
Since: 1.0.0
public static themeChoices ( ) : array
return array associative array of accepted values and the value's translated label

warningsSectionHeader() public static method

Introduce the warnings section
Since: 1.0.0
public static warningsSectionHeader ( ) : void
return void

Property Details

$hook_suffix protected_oe property

The hook suffix of the parent settings page
Since: 1.0.0
protected $hook_suffix