Changeset 60120

Timestamp:

04/02/2025 12:57:40 PM (11 months ago)

Author:

audrasjb

Message:

Docs: Update inline docs for various general template functions.

Props dilipbheda, mukesh27.
Fixes #63215.
See #63166.

File:

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

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

@@ -20 +20 @@
  * @since 5.5.0 The `$args` parameter was added.
  *
- * @param string $name The name of the specialized header.
- * @param array  $args Optional. Additional arguments passed to the header template.
- *                     Default empty array.
+ * @param string|null $name The name of the specialized header. Default null.
+ * @param array       $args Optional. Additional arguments passed to the header template.
+ *                          Default empty array.
  * @return void|false Void on success, false if the template does not exist.
  */
@@ -64 +64 @@
  * @since 5.5.0 The `$args` parameter was added.
  *
- * @param string $name The name of the specialized footer.
- * @param array  $args Optional. Additional arguments passed to the footer template.
- *                     Default empty array.
+ * @param string|null $name The name of the specialized footer. Default null.
+ * @param array       $args Optional. Additional arguments passed to the footer template.
+ *                          Default empty array.
  * @return void|false Void on success, false if the template does not exist.
  */
@@ -108 +108 @@
  * @since 5.5.0 The `$args` parameter was added.
  *
- * @param string $name The name of the specialized sidebar.
- * @param array  $args Optional. Additional arguments passed to the sidebar template.
- *                     Default empty array.
+ * @param string|null $name The name of the specialized sidebar. Default null.
+ * @param array       $args Optional. Additional arguments passed to the sidebar template.
+ *                          Default empty array.
  * @return void|false Void on success, false if the template does not exist.
  */
@@ -160 +160 @@
  *
  * @param string      $slug The slug name for the generic template.
- * @param string|null $name Optional. The name of the specialized template.
+ * @param string|null $name Optional. The name of the specialized template. Default null.
  * @param array       $args Optional. Additional arguments passed to the template.
  *                          Default empty array.
@@ -196 +196 @@
      * @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 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.
+     * @param string      $slug      The slug name for the generic template.
+     * @param string|null $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.
      */
     do_action( 'get_template_part', $slug, $name, $templates, $args );
@@ -1917 +1917 @@
  * @param string $before   Optional. Content to prepend to the description. Default empty.
  * @param string $after    Optional. Content to append to the description. Default empty.
- * @param bool   $selected Optional. Set to true if the current page is the selected archive page.
+ * @param bool   $selected Optional. Set to true if the current page is the selected archive page. Default false.
  * @return string HTML link content for archive.
  */