wp_editor( string $content, string $editor_id, array $settings = array() )
Renders an editor.
Contents
Description
Using this function is the proper way to output all needed components for both TinyMCE and Quicktags.
_WP_Editors should not be used directly. See https://core.trac.wordpress.org/ticket/17144.
NOTE: Once initialized the TinyMCE editor cannot be safely moved in the DOM. For that reason running wp_editor() inside of a meta box is not a good idea unless only Quicktags is used.
On the post edit screen several actions can be used to include additional editors containing TinyMCE: ‘edit_page_form’, ‘edit_form_advanced’ and ‘dbx_post_sidebar’.
See https://core.trac.wordpress.org/ticket/19173 for more information.
See also
Parameters
-
$content
string Required -
Initial content for the editor.
-
$editor_id
string Required -
HTML ID attribute value for the textarea and TinyMCE.
Should not contain square brackets. -
$settings
array Optional -
See _WP_Editors::parse_settings() for description.
More Arguments from _WP_Editors::parse_settings( ... $settings )
Array of editor arguments.
wpautop
boolWhether to use wpautop() . Default true.media_buttons
boolWhether to show the Add Media/other media buttons.default_editor
stringWhen both TinyMCE and Quicktags are used, set which editor is shown on page load. Default empty.drag_drop_upload
boolWhether to enable drag & drop on the editor uploading. Default false.
Requires the media modal.textarea_name
stringGive the textarea a unique name here. Square brackets can be used here. Default $editor_id.textarea_rows
intNumber rows in the editor textarea. Default 20.tabindex
string|intTabindex value to use. Default empty.tabfocus_elements
stringThe previous and next element ID to move the focus to when pressing the Tab key in TinyMCE. Default':prev,:next'
.editor_css
stringIntended for extra styles for both Visual and Text editors.
Should include<style>
tags, and can use "scoped". Default empty.editor_class
stringExtra classes to add to the editor textarea element. Default empty.teeny
boolWhether to output the minimal editor config. Examples include Press This and the Comment editor. Default false.dfw
boolDeprecated in 4.1. Unused.tinymce
bool|arrayWhether to load TinyMCE. Can be used to pass settings directly to TinyMCE using an array. Default true.quicktags
bool|arrayWhether to load Quicktags. Can be used to pass settings directly to Quicktags using an array. Default true.
Default:
array()
Source
File: wp-includes/general-template.php
.
View all references
function wp_editor( $content, $editor_id, $settings = array() ) {
if ( ! class_exists( '_WP_Editors', false ) ) {
require ABSPATH . WPINC . '/class-wp-editor.php';
}
_WP_Editors::editor( $content, $editor_id, $settings );
}
Changelog
Version | Description |
---|---|
3.3.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Get the wp_editor through AJAX Call,
Top ↑
Feedback
print_footer_scripts() outputs an array and results in the error ” Array to string conversion”. Since WP4.8 it is also possible to call the editor directly in JS, see https://make.wordpress.org/core/2017/05/20/editor-api-changes-in-4-8/. — By Edith Allison —
To edit tinymce Visual Buttons, you should use
toolbar
instead of TinyMCE documentation’stheme_advanced_buttons
attribute:The $settings array is actually described on the [_WP_Editors::parse_settings()](https://developer.wordpress.org/reference/classes/_wp_editors/parse_settings/) method
Modify the editor’s default settings when initializing it
You can pass an array of one or more settings to modify for this editor instance, such as hiding the insert media buttons.
Display an empty editor using the default settings
Fill an editor with the content for a particular post
Remove HTML button and media button in editor. Create blank content. Define a custom name and id for the editor. Determine your editor’s row count.