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

Timestamp:

02/21/2023 04:37:03 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Docs: Document default values for optional parameters in various DocBlocks.

Props paulkevan, costdev, audrasjb, SergeyBiryukov.
See #56792.

File:

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

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

@@ -1452 +1452 @@
      * @param string $mce_locale The locale used for the editor.
      * @param bool   $json_only  Optional. Whether to include the JavaScript calls to tinymce.addI18n() and
-     *                           tinymce.ScriptLoader.markDone().
+     *                           tinymce.ScriptLoader.markDone(). Default false.
      * @return string Translation object, JSON encoded.
      */
@@ -1752 +1752 @@
      * @since 3.1.0
      *
-     * @param array $args Optional. Accepts 'pagenum' and 's' (search) arguments.
+     * @param array $args {
+     *     Optional. Array of link query arguments.
+     *
+     *     @type int    $pagenum Page number. Default 1.
+     *     @type string $s       Search keywords.
+     * }
      * @return array|false $results {
      *     An array of associative arrays of query results, false if there are none.