Changeset 48104 for trunk/src/wp-includes/category-template.php

Timestamp:

06/20/2020 12:00:07 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Capitalize "ID", when referring to a post ID, term ID, etc. in a more consistent way.

See #49572.

File:

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

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

@@ -38 +38 @@
  * @since 4.8.0 The `$visited` parameter was deprecated and renamed to `$deprecated`.
  *
- * @param int $id Category ID.
- * @param bool $link Optional, default is false. Whether to format with link.
- * @param string $separator Optional, default is '/'. How to separate categories.
- * @param bool $nicename Optional, default is false. Whether to use nice name for display.
- * @param array $deprecated Not used.
+ * @param int    $id         Category ID.
+ * @param bool   $link       Optional. Whether to format with link. Default false.
+ * @param string $separator  Optional. How to separate categories. Default '/'.
+ * @param bool   $nicename   Optional. Whether to use nice name for display. Default false.
+ * @param array  $deprecated Not used.
  * @return string|WP_Error A list of category parents on success, WP_Error on failure.
  */
@@ -65 +65 @@
  * Retrieves post categories.
  *
- * This tag may be used outside The Loop by passing a post id as the parameter.
+ * This tag may be used outside The Loop by passing a post ID as the parameter.
  *
  * Note: This function only returns results from the default "category" taxonomy.