PHP Class TitanFrameworkOptionCode

Since: 1.3
Inheritance: extends TitanFrameworkOption
Mostra file Open project: gambitph/titan-framework

Public Properties

Property Type Description
$defaultSecondarySettings array Default settings specific for this container

Public Methods

Method Description
__construct ( $settings, $owner ) Constructor
cleanValueForGetting ( string $value ) : mixes Cleans the value for getOption
display ( ) : void Displays the option for admin pages and meta boxes
generateCSSCode ( string $css, TitanFrameworkOption $option ) : void Generates CSS to be included in our dynamically generated CSS file in TitanFrameworkCSS, using tf_generate_css_code
loadAdminScripts ( ) : void Loads the ACE library for displaying our syntax highlighted code editor
printCSSForPagesAndPosts ( ) : void Prints CSS styles in the header for meta options using wp_print_scripts
printJS ( ) : void Prints javascript code in the header using wp_print_scripts
printJSForPagesAndPosts ( ) : void Prints javascript code in the header for meta options using wp_print_scripts
registerCustomizerControl ( $wp_customize, TitanFrameworkCustomizerSection $section, integer $priority = 1 ) : void Registers the theme customizer control, for displaying the option

Method Details

__construct() public method

Constructor
Since: 1.3
public __construct ( $settings, $owner )

cleanValueForGetting() public method

Cleans the value for getOption
Since: 1.3
public cleanValueForGetting ( string $value ) : mixes
$value string The raw value of the option
return mixes The cleaned value

display() public method

Displays the option for admin pages and meta boxes
Since: 1.3
public display ( ) : void
return void

generateCSSCode() public method

Generates CSS to be included in our dynamically generated CSS file in TitanFrameworkCSS, using tf_generate_css_code
Since: 1.3
public generateCSSCode ( string $css, TitanFrameworkOption $option ) : void
$css string The CSS to output
$option TitanFrameworkOption The option object being generated
return void

loadAdminScripts() public method

Loads the ACE library for displaying our syntax highlighted code editor
Since: 1.3
public loadAdminScripts ( ) : void
return void

printCSSForPagesAndPosts() public method

Prints CSS styles in the header for meta options using wp_print_scripts
Since: 1.3
public printCSSForPagesAndPosts ( ) : void
return void

printJS() public method

Prints javascript code in the header using wp_print_scripts
Since: 1.3
public printJS ( ) : void
return void

printJSForPagesAndPosts() public method

Prints javascript code in the header for meta options using wp_print_scripts
Since: 1.3
public printJSForPagesAndPosts ( ) : void
return void

registerCustomizerControl() public method

Registers the theme customizer control, for displaying the option
Since: 1.3
public registerCustomizerControl ( $wp_customize, TitanFrameworkCustomizerSection $section, integer $priority = 1 ) : void
$section TitanFrameworkCustomizerSection The section where this option will be placed
$priority integer The order of this control in the section
return void

Property Details

$defaultSecondarySettings public_oe property

Default settings specific for this container
public array $defaultSecondarySettings
return array