Function Reference/wp editor
Description
This function renders an editor in a page in the typical fashion used in Posts and Pages.
Usage
<?php wp_editor( $content, $editor_id, $settings = array() ); ?>
Parameters
- $content
- (string) (required) Initial content for the editor.
- Default: None
- $editor_id
- (string) (required) HTML ID attribute value for the textarea and TinyMCE. (may only contain lower-case letters)
- Default: None
- $settings
- (array) (optional) An array of arguments.
- Default: None
Arguments
- wpautop
- (boolean) (optional) Whether to use wpautop for adding in paragraphs
- Default: true
- media_buttons
- (boolean) (optional) Whether to display media insert/upload buttons
- Default: true
- textarea_name
- (string) (optional) The name assigned to the generated textarea and passed parameter when the form is submitted. (may include [] to pass data as array)
- Default: $editor_id
- textarea_rows
- (integer) (optional) The number of rows to display for the textarea
- Default: get_option('default_post_edit_rows', 10)
- tabindex
- (integer) (optional) The tabindex value used for the form field
- Default: None
- editor_css
- (string) (optional) Additional CSS styling applied for both visual and HTML editors buttons, needs to include <style> tags, can use "scoped"
- Default: None
- editor_class
- (string) (optional) Any extra CSS Classes to append to the Editor textarea
- Default:
- teeny
- (boolean) (optional) Whether to output the minimal editor configuration used in PressThis
- Default: false
- dfw
- (boolean) (optional) Whether to replace the default fullscreen editor with DFW (needs specific DOM elements and css)
- Default: false
- tinymce
- (array) (optional) Load TinyMCE, can be used to pass settings directly to TinyMCE using an array()
- Default: true
- quicktags
- (array) (optional) Load Quicktags, can be used to pass settings directly to Quicktags using an array()
- Default: true
Notes
Note that the ID that is passed to the wp_editor() function can only be comprised of lower-case letters. No underscores, no hyphens. Anything else will cause the WYSIWYG editor to malfunction.
Once instantiated, the WYSIWYG editor cannot be moved around in the DOM. What this means in practical terms, is that you cannot put it in meta-boxes that can be dragged and placed elsewhere on the page.
Change Log
Source Code
wp_editor() is located in wp-includes/general-template.php
