Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-23 01:27:36 +01:00
Code Issues Projects Releases Wiki Activity

More phpdoc for wp_editor(), see #17144

Browse Source 
git-svn-id: http://svn.automattic.com/wordpress/trunk@19239 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
azaozz 2011-11-10 17:46:23 +00:00
parent 6e62008a14
commit 5869b4d388
2 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
wp-includes/general-template.php
View File

@ -1733,13 +1733,23 @@ function user_can_richedit() {
}
/**
* Loads and initializes WP_Editor class if needed, passes the settings for an instance of the editor
* Loads and initializes WP_Editor class (if needed), passes the settings for an instance of the editor
*
* Using this function is the proper way to output all needed components for both TinyMCE and Quicktags.
* WP_Editor shouldn't be instantiated separately as it keeps track of loaded scripts.
* See http://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 metabox 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 http://core.trac.wordpress.org/ticket/19173 for more information.
*
* @see wp-includes/class-wp-editor.php
* @since 3.3
*
* @param string $content Initial content for the editor.
* @param string $editor_id HTML ID attribute value for the textarea and TinyMCE.
* @param string $editor_id HTML ID attribute value for the textarea and TinyMCE. Can only be /[a-z]+/.
* @param array $settings See WP_Editor::editor().
*/
function wp_editor( $content, $editor_id, $settings = array() ) {