Changeset 47210 for trunk/src/wp-includes/class-wp-editor.php

Timestamp:

02/07/2020 11:28:22 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve description for the $editor_id parameter of wp_editor() and _WP_Editors::editor().

The restictions mentioned for the parameter value should be consistenct.

Props pbiron, SergeyBiryukov.
Fixes #49384.

File:

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

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

@@ -37 +37 @@
      * @since 3.3.0
      *
-     * @param string $editor_id ID for the current editor instance.
+     * @param string $editor_id HTML ID for the textarea and TinyMCE and Quicktags instances.
+     *                          Should not contain square brackets.
      * @param array  $settings {
      *     Array of editor arguments.
@@ -76 +77 @@
          *
          * @param array  $settings  Array of editor arguments.
-         * @param string $editor_id ID for the current editor instance. Accepts 'classic-block'
+         * @param string $editor_id Unique editor identifier, e.g. 'content'. Accepts 'classic-block'
          *                          when called from block editor's Classic block.
          */
@@ -148 +149 @@
      * @since 3.3.0
      *
-     * @param string $content The initial content of the editor.
-     * @param string $editor_id ID for the textarea and TinyMCE and Quicktags instances (can contain only ASCII letters and numbers).
-     * @param array $settings See _WP_Editors::parse_settings() for description.
+     * @param string $content   Initial content for the editor.
+     * @param string $editor_id HTML ID for the textarea and TinyMCE and Quicktags instances.
+     *                          Should not contain square brackets.
+     * @param array  $settings  See _WP_Editors::parse_settings() for description.
      */
     public static function editor( $content, $editor_id, $settings = array() ) {
@@ -311 +313 @@
      * @global string $tinymce_version
      *
-     * @param string $editor_id
-     * @param array  $set
+     * @param string $editor_id Unique editor identifier, e.g. 'content'.
+     * @param array  $set       Array of editor arguments.
      */
     public static function editor_settings( $editor_id, $set ) {
@@ -354 +356 @@
              *
              * @param array  $qtInit    Quicktags settings.
-             * @param string $editor_id The unique editor ID, e.g. 'content'.
+             * @param string $editor_id Unique editor identifier, e.g. 'content'.
              */
             $qtInit = apply_filters( 'quicktags_settings', $qtInit, $editor_id );