Changeset 60271

Timestamp:

06/01/2025 07:20:42 AM (9 months ago)

Author:

audrasjb

Message:

Docs: Improve inline docs params for various category template tags functions.

Props dilipbheda, audrasjb, mukesh27.
Fixes #63225.
See #63166.

File:

• trunk/src/wp-includes/category-template.php (modified) (4 diffs)

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

@@ -72 +72 @@
  * @since 0.71
  *
- * @param int $post_id Optional. The post ID. Defaults to current post ID.
+ * @param int|false $post_id Optional. The post ID. Defaults to current post ID.
  * @return WP_Term[] Array of WP_Term objects, one for each category assigned to the post.
  */
@@ -132 +132 @@
  * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
  *
- * @param string $separator Optional. Separator between the categories. By default, the links are placed
- *                          in an unordered list. An empty string will result in the default behavior.
- * @param string $parents   Optional. How to display the parents. Accepts 'multiple', 'single', or empty.
- *                          Default empty string.
- * @param int    $post_id   Optional. ID of the post to retrieve categories for. Defaults to the current post.
+ * @param string    $separator Optional. Separator between the categories. By default, the links are placed
+ *                             in an unordered list. An empty string will result in the default behavior.
+ * @param string    $parents   Optional. How to display the parents. Accepts 'multiple', 'single', or empty.
+ *                             Default empty string.
+ * @param int|false $post_id   Optional. ID of the post to retrieve categories for. Defaults to the current post.
  * @return string Category list for a post.
  */
@@ -252 +252 @@
  * @param int|string|int[]|string[] $category Category ID, name, slug, or array of such
  *                                            to check against.
- * @param int|WP_Post               $post     Optional. Post to check. Defaults to the current post.
+ * @param int|null|WP_Post          $post     Optional. Post to check. Defaults to the current post.
  * @return bool True if the current post is in any of the given categories.
  */
@@ -268 +268 @@
  * @since 0.71
  *
- * @param string $separator Optional. Separator between the categories. By default, the links are placed
- *                          in an unordered list. An empty string will result in the default behavior.
- * @param string $parents   Optional. How to display the parents. Accepts 'multiple', 'single', or empty.
- *                          Default empty string.
- * @param int    $post_id   Optional. ID of the post to retrieve categories for. Defaults to the current post.
+ * @param string    $separator Optional. Separator between the categories. By default, the links are placed
+ *                             in an unordered list. An empty string will result in the default behavior.
+ * @param string    $parents   Optional. How to display the parents. Accepts 'multiple', 'single', or empty.
+ *                             Default empty string.
+ * @param int|false $post_id   Optional. ID of the post to retrieve categories for. Defaults to the current post.
  */
 function the_category( $separator = '', $parents = '', $post_id = false ) {