wp_editor( string $content, string $editor_id, array $settings = array() )

Renders an editor.

Description
- See also
Parameters
Source
Related
- Uses
- Used By
Changelog
User Contributed Notes
- Feedback

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.

Top ↑

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 bool
Whether to use wpautop() . Default true.
media_buttons bool
Whether to show the Add Media/other media buttons.
default_editor string
When both TinyMCE and Quicktags are used, set which editor is shown on page load. Default empty.
drag_drop_upload bool
Whether to enable drag & drop on the editor uploading. Default false.
Requires the media modal.
textarea_name string
Give the textarea a unique name here. Square brackets can be used here. Default $editor_id.
textarea_rows int
Number rows in the editor textarea. Default 20.
tabindex string|int
Tabindex value to use. Default empty.
tabfocus_elements string
The previous and next element ID to move the focus to when pressing the Tab key in TinyMCE. Default ':prev,:next'.
editor_css string
Intended for extra styles for both Visual and Text editors.
Should include <style> tags, and can use "scoped". Default empty.
editor_class string
Extra classes to add to the editor textarea element. Default empty.
teeny bool
Whether to output the minimal editor config. Examples include Press This and the Comment editor. Default false.
dfw bool
Deprecated in 4.1. Unused.
tinymce bool|array
Whether to load TinyMCE. Can be used to pass settings directly to TinyMCE using an array. Default true.
quicktags bool|array
Whether to load Quicktags. Can be used to pass settings directly to Quicktags using an array. Default true.

Default: array()

Top ↑

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 );
}

View on Trac View on GitHub

Top ↑

Uses

Uses
Uses	Description
_WP_Editors::editor() wp-includes/class-wp-editor.php	Outputs the HTML for a single instance of the editor.

Top ↑

Used By

Used By
Used By	Description
wp_comment_reply() wp-admin/includes/template.php	Outputs the in-line comment reply-to form in the Comments list table.
edit_form_image_editor() wp-admin/includes/media.php	Displays the image and editor in the post editor
the_editor() wp-includes/deprecated.php	Displays an editor: TinyMCE, HTML, or both.

Top ↑

Changelog

Changelog
Version	Description
3.3.0	Introduced.

Top ↑

User Contributed Notes

Skip to note 1 content

You must log in to vote on the helpfulness of this noteVote results for this note: 9You must log in to vote on the helpfulness of this note

Contributed by M A Vinoth Kumar — 6 years ago
Get the wp_editor through AJAX Call,
```
add_action( 'wp_ajax_bc_ajax_request', 'bc_ajax_request_fn' ); 
function bc_ajax_request_fn(){
$html ='';
$html .= bc_get_wp_editor('Test Message','primary_editor',array());
return $html;
}
```
```
function bc_get_wp_editor( $content = '', $editor_id, $options = array() ) {
	ob_start();

	wp_editor( $content, $editor_id, $options );

	$temp = ob_get_clean();
	$temp .= \_WP_Editors::enqueue_scripts();
	$temp .= print_footer_scripts();
	$temp .= \_WP_Editors::editor_js();

	return $temp;
}
```
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 — 2 years ago
Log in to add feedback
Skip to note 2 content

You must log in to vote on the helpfulness of this noteVote results for this note: 6You must log in to vote on the helpfulness of this note

Contributed by Mário Valney — 7 years ago
To edit tinymce Visual Buttons, you should use toolbar instead of TinyMCE documentation’s theme_advanced_buttons attribute:
```
$args = array(
    'tinymce'       => array(
        'toolbar1'      => 'bold,italic,underline,separator,alignleft,aligncenter,alignright,separator,link,unlink,undo,redo',
        'toolbar2'      => '',
        'toolbar3'      => '',
    ),
);
wp_editor( $content, $editor_id, $args );
```
Log in to add feedback
Skip to note 3 content

You must log in to vote on the helpfulness of this noteVote results for this note: 5You must log in to vote on the helpfulness of this note

Contributed by Ricardo Moraleida — 7 years ago

The $settings array is actually described on the [_WP_Editors::parse_settings()](https://developer.wordpress.org/reference/classes/_wp_editors/parse_settings/) method

Log in to add feedback
Skip to note 4 content

You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

Contributed by Codex — 8 years ago
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.
```
$content   = '';
$editor_id = 'mycustomeditor';
$settings  = array( 'media_buttons' => false );

wp_editor( $content, $editor_id, $settings );
```
Log in to add feedback
Skip to note 5 content

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

Contributed by Codex — 8 years ago
Display an empty editor using the default settings
```
$content   = '';
$editor_id = 'mycustomeditor';

wp_editor( $content, $editor_id );
```
Log in to add feedback
Skip to note 6 content

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

Contributed by Codex — 8 years ago
Fill an editor with the content for a particular post
```
$post_id   = 51;
$post      = get_post( $post_id, OBJECT, 'edit' );
$content   = $post->post_content;
$editor_id = 'editpost';

wp_editor( $content, $editor_id );
```
Log in to add feedback

Contributed by Mustafa BOŞNAK — 2 years ago

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.

$content = "";
$custom_editor_id = "editorid";
$custom_editor_name = "editorname";
$args = array(
		'media_buttons' => false, // This setting removes the media button.
		'textarea_name' => $custom_editor_name, // Set custom name.
		'textarea_rows' => get_option('default_post_edit_rows', 10), //Determine the number of rows.
		'quicktags' => false, // Remove view as HTML button.
	);
wp_editor( $content, $custom_editor_id, $args );

You must log in before being able to contribute a note or feedback.

Developer Resources

wp_editor( string $content, string $editor_id, array $settings = array() )

Contents

Description

See also

Parameters

Source

Changelog

User Contributed Notes

Feedback