Changeset 55870 for trunk/src/wp-includes/general-template.php

Timestamp:

05/30/2023 05:43:27 PM (2 years ago)

Author:

johnbillion

Message:

Docs: Miscellaneous corrections and improvements to docblocks.

See #57840

File:

• trunk/src/wp-includes/general-template.php (modified) (3 diffs)

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.