From 2213bfba0c3adb84d4e220aebeceea87988cacae Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 20 Dec 2015 21:20:14 +0000 Subject: [PATCH] Docs: Add missing notations for the optional `$tab_index` and `$extended` parameters in the DocBlock for the deprecated `the_editor()` function. See #32246. git-svn-id: https://develop.svn.wordpress.org/trunk@36033 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/deprecated.php | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/src/wp-includes/deprecated.php b/src/wp-includes/deprecated.php index 8b6ee1690e..c4d866ca22 100644 --- a/src/wp-includes/deprecated.php +++ b/src/wp-includes/deprecated.php @@ -2555,16 +2555,18 @@ function wp_timezone_supported() { } /** - * Display editor: TinyMCE, HTML, or both. + * Displays an editor: TinyMCE, HTML, or both. * * @since 2.1.0 * @deprecated 3.3.0 Use wp_editor() * @see wp_editor() * - * @param string $content Textarea content. - * @param string $id Optional, default is 'content'. HTML ID attribute value. - * @param string $prev_id Optional, not used - * @param bool $media_buttons Optional, default is true. Whether to display media buttons. + * @param string $content Textarea content. + * @param string $id Optional. HTML ID attribute value. Default 'content'. + * @param string $prev_id Optional. Unused. + * @param bool $media_buttons Optional. Whether to display media buttons. Default true. + * @param int $tab_index Optional. Unused. + * @param bool $extended Optional. Unused. * @param int $tab_index Optional, not used */ function the_editor($content, $id = 'content', $prev_id = 'title', $media_buttons = true, $tab_index = 2, $extended = true) {