Docs: Improve documentation for `format_for_editor()` and the `'the_editor_content'` filter it is hooked to.

Props AramZS for initial patch.
Fixes #34866.
Built from https://develop.svn.wordpress.org/trunk@35904


git-svn-id: http://core.svn.wordpress.org/trunk@35868 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Pascal Birchler 2015-12-13 19:22:26 +00:00
parent d5d5d64e3d
commit 47306630ca
3 changed files with 12 additions and 4 deletions

View File

@ -262,6 +262,8 @@ final class _WP_Editors {
* @since 2.1.0
*
* @param string $content Default editor content.
* @param string $default_editor The default editor for the current user.
* Either 'html' or 'tinymce'.
*/
$content = apply_filters( 'the_editor_content', $content, $default_editor );

View File

@ -3268,7 +3268,11 @@ function ent2ncr( $text ) {
*
* @since 4.3.0
*
* @see _WP_Editors::editor()
*
* @param string $text The text to be formatted.
* @param string $default_editor The default editor for the current user.
* It is usually either 'html' or 'tinymce'.
* @return string The formatted text after filter is applied.
*/
function format_for_editor( $text, $default_editor = null ) {
@ -3282,6 +3286,8 @@ function format_for_editor( $text, $default_editor = null ) {
* @since 4.3.0
*
* @param string $text The formatted text.
* @param string $default_editor The default editor for the current user.
* It is usually either 'html' or 'tinymce'.
*/
return apply_filters( 'format_for_editor', $text, $default_editor );
}

View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.5-alpha-35903';
$wp_version = '4.5-alpha-35904';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.