wp_editor( string $content, string $editor_id, array $settings = array() )
- Since
- 3.3.0
- Source
wp-includes/general-template.php:3839
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.
Compatibility
- WordPress
- since 3.3.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$contentstring- Initial content for the editor.
$editor_idstring- HTML ID attribute value for the textarea and TinyMCE.
Should not contain square brackets. $settingsarrayoptional- See _WP_Editors::parse_settings() for description.Default:
array()
Performance profile
How much work a call to wp_editor() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 11–16
- Plugin surface
- None
- Called by
- 3
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 16.
Nothing here hands control to plugin code.
3 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_editor() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 11–16 | ::_WP_Editors() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 16 | 11–16 | 1 | |
| 8.5 | 16 | 11–16 | 1 | |
| 8.4 | 16 | 11–16 | 1 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 19 | 14–19 | 1 | |
| 8.2 | 19 | 14–19 | 1 | |
| 8.1 | 19 | 14–19 | 1 | |
| 7.4 | 19 | 14–19 | 1 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 1
- _WP_Editors::editor()Outputs the HTML for a single instance of the editor.
Used by · 3
- edit_form_image_editor()Displays the image and editor in the post editor
- the_editor()Displays an editor: TinyMCE, HTML, or both.
- wp_comment_reply()Outputs the in-line comment reply-to form in the Comments list table.
Source code
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
Introduced in 3.3.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/general-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.