WP_Customize_Code_Editor_Control WordPress Class
The WP_Customize_Code_Editor_Control class allows you to add a code editor to the WordPress customizer. This can be used to add CSS, HTML, JavaScript, or any other code to your WordPress site.
WP_Customize_Code_Editor_Control #
Customize Code Editor Control class.
Description
See also
Source
File: wp-includes/customize/class-wp-customize-code-editor-control.php
class WP_Customize_Code_Editor_Control extends WP_Customize_Control { /** * Customize control type. * * @since 4.9.0 * @var string */ public $type = 'code_editor'; /** * Type of code that is being edited. * * @since 4.9.0 * @var string */ public $code_type = ''; /** * Code editor settings. * * @see wp_enqueue_code_editor() * @since 4.9.0 * @var array|false */ public $editor_settings = array(); /** * Enqueue control related scripts/styles. * * @since 4.9.0 */ public function enqueue() { $this->editor_settings = wp_enqueue_code_editor( array_merge( array( 'type' => $this->code_type, 'codemirror' => array( 'indentUnit' => 2, 'tabSize' => 2, ), ), $this->editor_settings ) ); } /** * Refresh the parameters passed to the JavaScript via JSON. * * @since 4.9.0 * * @see WP_Customize_Control::json() * * @return array Array of parameters passed to the JavaScript. */ public function json() { $json = parent::json(); $json['editor_settings'] = $this->editor_settings; $json['input_attrs'] = $this->input_attrs; return $json; } /** * Don't render the control content from PHP, as it's rendered via JS on load. * * @since 4.9.0 */ public function render_content() {} /** * Render a JS template for control display. * * @since 4.9.0 */ public function content_template() { ?> <# var elementIdPrefix = 'el' + String( Math.random() ); #> <# if ( data.label ) { #> <label for="{{ elementIdPrefix }}_editor" class="customize-control-title"> {{ data.label }} </label> <# } #> <# if ( data.description ) { #> <span class="description customize-control-description">{{{ data.description }}}</span> <# } #> <div class="customize-control-notifications-container"></div> <textarea id="{{ elementIdPrefix }}_editor" <# _.each( _.extend( { 'class': 'code' }, data.input_attrs ), function( value, key ) { #> {{{ key }}}="{{ value }}" <# }); #> ></textarea> <?php } }
Expand full source codeCollapse full source codeView on TracView on GitHub
Methods
- content_template— Render a JS template for control display.
- enqueue— Enqueue control related scripts/styles.
- json— Refresh the parameters passed to the JavaScript via JSON.
- render_content— Don't render the control content from PHP, as it's rendered via JS on load.
Changelog
Version | Description |
---|---|
4.9.0 | Introduced. |