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

Renders an editor.

Contents

Description 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 See also

Top ↑

Parameters 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.

Default value: array()

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
wp-admin/includes/template.php: wp_comment_reply()

Outputs the in-line comment reply-to form in the Comments list table.
wp-admin/includes/media.php: edit_form_image_editor()

Displays the image and editor in the post editor
wp-includes/deprecated.php: the_editor()

Displays an editor: TinyMCE, HTML, or both.

Top ↑

Source Source

File: wp-includes/general-template.php 

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

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
3.3.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  3. Skip to note 3 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 M A Vinoth Kumar —

    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;
}
  5. Skip to note 5 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    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 );
  6. Skip to note 6 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by Mario Valney —

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

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