From 94da64bff3c3901360134bef1f244a4ab3650e64 Mon Sep 17 00:00:00 2001
From: Pascal Birchler <swissspidy@git.wordpress.org>
Date: Sun, 13 Dec 2015 19:21:32 +0000
Subject: [PATCH] Docs: Improve documentation for `format_for_editor()` and the
 `'the_editor_content'` filter it is hooked to.

Props AramZS for initial patch.
Fixes #34866.

git-svn-id: https://develop.svn.wordpress.org/trunk@35904 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/class-wp-editor.php |  4 +++-
 src/wp-includes/formatting.php      | 10 ++++++++--
 2 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/src/wp-includes/class-wp-editor.php b/src/wp-includes/class-wp-editor.php
index a6504d4ea9..ee877a3aaf 100644
--- a/src/wp-includes/class-wp-editor.php
+++ b/src/wp-includes/class-wp-editor.php
@@ -261,7 +261,9 @@ final class _WP_Editors {
 		 *
 		 * @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 );
 
diff --git a/src/wp-includes/formatting.php b/src/wp-includes/formatting.php
index b9383f5028..91690d8f4b 100644
--- a/src/wp-includes/formatting.php
+++ b/src/wp-includes/formatting.php
@@ -3268,7 +3268,11 @@ function ent2ncr( $text ) {
  *
  * @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.
  */
 function format_for_editor( $text, $default_editor = null ) {
@@ -3281,7 +3285,9 @@ function format_for_editor( $text, $default_editor = null ) {
 	 *
 	 * @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 );
 }