Changeset 46675

Timestamp:

11/07/2019 07:10:38 AM (7 years ago)

Author:

SergeyBiryukov

Message:

Docs: Make @param tags in mce_buttons and related filters consistent with the variable names.

Props upadalavipul, isabel_brison.
Fixes #41456.

File:

• trunk/src/wp-includes/class-wp-editor.php (modified) (6 diffs)

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

@@ -578 +578 @@
 
                         if ( $set['teeny'] ) {
+                                $mce_buttons = array( 'bold', 'italic', 'underline', 'blockquote', 'strikethrough', 'bullist', 'numlist', 'alignleft', 'aligncenter', 'alignright', 'undo', 'redo', 'link', 'fullscreen' );
 
                                 /**
@@ -584 +585 @@
                                  * @since 2.7.0
                                  *
-                                 * @param array  $buttons   An array of teenyMCE buttons.
-                                 * @param string $editor_id Unique editor identifier, e.g. 'content'.
+                                 * @param array  $mce_buttons An array of teenyMCE buttons.
+                                 * @param string $editor_id   Unique editor identifier, e.g. 'content'.
                                  */
-                                $mce_buttons   = apply_filters( 'teeny_mce_buttons', array( 'bold', 'italic', 'underline', 'blockquote', 'strikethrough', 'bullist', 'numlist', 'alignleft', 'aligncenter', 'alignright', 'undo', 'redo', 'link', 'fullscreen' ), $editor_id );
+                                $mce_buttons   = apply_filters( 'teeny_mce_buttons', $mce_buttons, $editor_id );
                                 $mce_buttons_2 = array();
                                 $mce_buttons_3 = array();
@@ -611 +612 @@
                                  * @since 2.0.0
                                  *
-                                 * @param array  $buttons   First-row list of buttons.
-                                 * @param string $editor_id Unique editor identifier, e.g. 'content'.
+                                 * @param array  $mce_buttons First-row list of buttons.
+                                 * @param string $editor_id   Unique editor identifier, e.g. 'content'.
                                  */
                                 $mce_buttons = apply_filters( 'mce_buttons', $mce_buttons, $editor_id );
@@ -627 +628 @@
                                  * @since 2.0.0
                                  *
-                                 * @param array  $buttons   Second-row list of buttons.
-                                 * @param string $editor_id Unique editor identifier, e.g. 'content'.
+                                 * @param array  $mce_buttons_2 Second-row list of buttons.
+                                 * @param string $editor_id     Unique editor identifier, e.g. 'content'.
                                  */
                                 $mce_buttons_2 = apply_filters( 'mce_buttons_2', $mce_buttons_2, $editor_id );
@@ -637 +638 @@
                                  * @since 2.0.0
                                  *
-                                 * @param array  $buttons   Third-row list of buttons.
-                                 * @param string $editor_id Unique editor identifier, e.g. 'content'.
+                                 * @param array  $mce_buttons_3 Third-row list of buttons.
+                                 * @param string $editor_id     Unique editor identifier, e.g. 'content'.
                                  */
                                 $mce_buttons_3 = apply_filters( 'mce_buttons_3', array(), $editor_id );
@@ -647 +648 @@
                                  * @since 2.5.0
                                  *
-                                 * @param array  $buttons   Fourth-row list of buttons.
-                                 * @param string $editor_id Unique editor identifier, e.g. 'content'.
+                                 * @param array  $mce_buttons_4 Fourth-row list of buttons.
+                                 * @param string $editor_id     Unique editor identifier, e.g. 'content'.
                                  */
                                 $mce_buttons_4 = apply_filters( 'mce_buttons_4', array(), $editor_id );