PHP Class Twitter\WordPress\Admin\Settings\Buttons\Tweet

Since: 1.0.0
Inheritance: implements Twitter\WordPress\Admin\Settings\SettingsSection
Afficher le fichier Open project: twitter/wordpress

Protected Properties

Свойство Type Description
$hook_suffix The hook suffix of the parent settings page

Méthodes publiques

Méthode Description
addToSettingsPage ( string $hook_suffix ) : boolean Add Tweet button content wrapper option and settings section to an existing settings page
defineSection ( ) : void Define Tweet button section and the fields within
displayPosition ( ) : void Choose to display a Tweet button before, after, or before & after every public post
displaySize ( ) : void Choose a large button size, overriding the default
featureName ( ) : string Reference the feature by name
getPositionOptions ( ) : array Get option values and labels for dropdown display
onload ( ) : void Set up settings section
sanitizeOption ( array $options ) : array Sanitize posted option before saving
sectionHeader ( ) : void Introduce the settings section

Method Details

addToSettingsPage() public static méthode

Add Tweet button content wrapper 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
Résultat boolean site attribution settings loaded

defineSection() public méthode

Define Tweet button section and the fields within
Since: 1.0.0
public defineSection ( ) : void
Résultat void

displayPosition() public méthode

Choose to display a Tweet button before, after, or before & after every public post
Since: 1.0.0
public displayPosition ( ) : void
Résultat void

displaySize() public méthode

Choose a large button size, overriding the default
Since: 1.0.0
public displaySize ( ) : void
Résultat void

featureName() public static méthode

Reference the feature by name
Since: 1.0.0
public static featureName ( ) : string
Résultat string translated feature name

getPositionOptions() public static méthode

Get option values and labels for dropdown display
Since: 1.0.0
public static getPositionOptions ( ) : array
Résultat array option values and labels { @type string option value @type string translated option label }

onload() public méthode

Set up settings section
Since: 1.0.0
public onload ( ) : void
Résultat void

sanitizeOption() public static méthode

Sanitize posted option before saving
Since: 1.0.0
public static sanitizeOption ( array $options ) : array
$options array submitted option { @type string option name @type mixed option value }
Résultat array $options cleaned option { @type string option name @type string option value }

sectionHeader() public static méthode

Introduce the settings section
Since: 1.0.0
public static sectionHeader ( ) : void
Résultat void

Property Details

$hook_suffix protected_oe property

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