# Editor
The Editor field offers WYSIWYG editing capability, using the same editing interface as WordPress.
Table of Contents
# Arguments
Name | Type | Default | Description |
---|---|---|---|
type | string | editor | Value identifying the field type. |
default | string | Text to appear inside the editor window by default. | |
args | array | Sets the default WordPress editor arguments. See WP Editor Options below. |
Also See
# WP Editor Options
Name | Type | Default | Description |
---|---|---|---|
wpautop | bool | true | Flags to set wpautop for adding paragraphs. |
media_buttons | bool | true | Flag to set the display of media upload/inset buttons. |
textarea_rows | int | 10 | Number of rows to display or the textarea. |
tabindex | int | The tabindex value used for the form field. | |
editor_css | string | Additional CSS styling applied for both visual and HTML editor buttons. <style> tags need to be included. | |
teeny | bool | true | Flag to set the editor with minimal configuration. |
dfw | bool | false | Flag to replace the default fullscreen editor with DFW. Needs specific DOM elements and CSS. This is an advanced setting for use by advanced users. |
tinymce | array | Flag to load TinyMCE. Can be used to pass settings directly to TinyMCE using an array. | |
quicktags | array | Flag to load Quicktags. Can be used to pass settings directly to Quicktags using an array. Set to false to remove the editor's Visual and Text tabs. |
TIP
While the textarea_name
value is available for the WP Editor options, Redux automatically sets this value for you. There is no real need to set it
manually. The editor_class
value, also part of the WP Editor settings does not need to be set via the args
array. It can be set via the class
type.
# Build Config
Build a Custom Configuration →
Changes you make to this form will be reflected in the generated code.
Redux::set_field( 'OPT_NAME', 'SECTION_ID', array(
'type' => 'editor'
) );
# Example Config
Redux::set_field( 'OPT_NAME', 'SECTION_ID', array(
'id' => 'editor-text',
'type' => 'editor',
'title' => esc_html__('Editor Text', 'your-textdomain-here'),
'subtitle' => esc_html__('Subtitle text would go here.', 'your-textdomain-here'),
'default' => 'Powered by Redux.',
'args' => array(
'teeny' => true,
'textarea_rows' => 10
)
) );
# Example Usage
This example in based on the example usage provided above. Be sure to change $redux_demo
to the value you specified in your opt_name argument.
global $redux_demo;
echo 'Editor text: ' . $redux_demo['editor-text'];