Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 1.46 KB

editor.md

File metadata and controls

45 lines (32 loc) · 1.46 KB
Raw

Editor (WYSIWYG)

Editor field renders a WYSIWYG editor. Due to complexities of the field, it does not have the switch between Text and Visual modes.

Example configuration

...
array(
    'title' => 'My editor field title',
    'id' => 'editor-option',
    'desc' => 'Short description for the field',
    'tab' => 'main',
    'type' => 'editor',
),
...

This will produce something similar to the following

In other words it will look like a WYSIWYG editor from the post page.

Filters

The field uses wp_kses to sanitize the value before storing it in the database. The following filters can be used to control it.

Name Description
alch_allowed_editor_html_tags Can be used to control which HTML tags are allowed.
alch_allowed_editor_protocols Can be used to control which protocols are allowed.

See the filters page for more details.

Params

Name Type Description
type string editor (required)
id string Unique ID that will be used to retrieve the value (required)
tab string Specifies in which tab this option will be rendered
title string Shows a heading to the left of the field
desc string Shows a description text (can have HTML)