Changeset 55870

Timestamp:

05/30/2023 05:43:27 PM (19 months ago)

Author:

johnbillion

Message:

Docs: Miscellaneous corrections and improvements to docblocks.

See #57840

Location:

trunk/src/wp-includes

Files:

• functions.php (modified) (3 diffs)
• general-template.php (modified) (3 diffs)
• script-loader.php (modified) (1 diff)

trunk/src/wp-includes/functions.php

@@ -7576 +7576 @@
              * @since 4.6.0 The default now takes the original `memory_limit` into account.
              *
-             * @param int|string $filtered_limit Maximum memory limit to allocate for images.
+             * @param int|string $filtered_limit Maximum memory limit to allocate for image processing.
              *                                   Default `WP_MAX_MEMORY_LIMIT` or the original
              *                                   php.ini `memory_limit`, whichever is higher.
@@ -7587 +7587 @@
         default:
             /**
-             * Filters the memory limit allocated for arbitrary contexts.
+             * Filters the memory limit allocated for an arbitrary context.
              *
              * The dynamic portion of the hook name, `$context`, refers to an arbitrary
@@ -7595 +7595 @@
              * @since 4.6.0
              *
-             * @param int|string $filtered_limit Maximum memory limit to allocate for images.
-             *                                   Default '256M' or the original php.ini `memory_limit`,
+             * @param int|string $filtered_limit Maximum memory limit to allocate for this context.
+             *                                   Default WP_MAX_MEMORY_LIMIT` or the original php.ini `memory_limit`,
              *                                   whichever is higher. Accepts an integer (bytes), or a
              *                                   shorthand string notation, such as '256M'.

trunk/src/wp-includes/general-template.php

@@ -159 +159 @@
  * @since 5.5.0 The `$args` parameter was added.
  *
- * @param string $slug The slug name for the generic template.
- * @param string $name The name of the specialized template.
- * @param array  $args Optional. Additional arguments passed to the template.
- *                     Default empty array.
+ * @param string      $slug The slug name for the generic template.
+ * @param string|null $name Optional. The name of the specialized template.
+ * @param array       $args Optional. Additional arguments passed to the template.
+ *                          Default empty array.
  * @return void|false Void on success, false if the template does not exist.
  */
@@ -176 +176 @@
      *
      * @param string      $slug The slug name for the generic template.
-     * @param string|null $name The name of the specialized template.
+     * @param string|null $name The name of the specialized template or null if
+     *                          there is none.
      * @param array       $args Additional arguments passed to the template.
      */
@@ -196 +197 @@
      *
      * @param string   $slug      The slug name for the generic template.
-     * @param string   $name      The name of the specialized template.
+     * @param string   $name      The name of the specialized template or an empty
+     *                            string if there is none.
      * @param string[] $templates Array of template files to search for, in order.
      * @param array    $args      Additional arguments passed to the template.

trunk/src/wp-includes/script-loader.php

@@ -3088 +3088 @@
  *
  * @param string $block_name The block-name, including namespace.
- * @param array  $args       An array of arguments [handle,src,deps,ver,media].
+ * @param array  $args       {
+ *     An array of arguments. See wp_register_style() for full information about each argument.
+ *
+ *     @type string           $handle The handle for the stylesheet.
+ *     @type string|false     $src    The source URL of the stylesheet.
+ *     @type string[]         $deps   Array of registered stylesheet handles this stylesheet depends on.
+ *     @type string|bool|null $ver    Stylesheet version number.
+ *     @type string           $media  The media for which this stylesheet has been defined.
+ * }
  */
 function wp_enqueue_block_style( $block_name, $args ) {