Changeset 35904

Timestamp:

12/13/2015 07:21:32 PM (11 years ago)

Author:

swissspidy

Message:

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

Props AramZS for initial patch.
Fixes #34866.

Location:

trunk/src/wp-includes

Files:

• class-wp-editor.php (modified) (1 diff)
• formatting.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-editor.php

@@ -262 +262 @@
                  * @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 );

trunk/src/wp-includes/formatting.php

@@ -3269 +3269 @@
  * @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.
  */
@@ -3282 +3286 @@
          * @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 );