sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

Browse Source 
Props AramZS for initial patch.
Fixes #34866.

git-svn-id: https://develop.svn.wordpress.org/trunk@35904 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Pascal Birchler 2015-12-13 19:21:32 +00:00
parent 81a9fe9c09
commit 94da64bff3
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/wp-includes/class-wp-editor.php
View File

@ -261,7 +261,9 @@ final class _WP_Editors {
* *
* @since 2.1.0 * @since 2.1.0
* *
* @param string $content Default editor content. * @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 ); $content = apply_filters( 'the_editor_content', $content, $default_editor );

10
src/wp-includes/formatting.php
View File

@ -3268,7 +3268,11 @@ function ent2ncr( $text ) {
* *
* @since 4.3.0 * @since 4.3.0
* *
* @param string $text The text to be formatted. * @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. * @return string The formatted text after filter is applied.
*/ */
function format_for_editor( $text, $default_editor = null ) { function format_for_editor( $text, $default_editor = null ) {
@ -3281,7 +3285,9 @@ function format_for_editor( $text, $default_editor = null ) {
* *
* @since 4.3.0 * @since 4.3.0
* *
* @param string $text The formatted text. * @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 ); return apply_filters( 'format_for_editor', $text, $default_editor );
} }