Changeset 47870

Timestamp:

05/30/2020 10:06:49 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Adjust the documentation for the new ID alias in get_term_by() for consistency with get_user_by().

Follow-up to [47865].

See #45163.

File:

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

trunk/src/wp-includes/taxonomy.php

@@ -914 +914 @@
  * @since 4.4.0 `$taxonomy` is optional if `$field` is 'term_taxonomy_id'. Converted to return
  *              a WP_Term object if `$output` is `OBJECT`.
- * @since 5.5.0 ID is an alias of id.
+ * @since 5.5.0 Added 'ID' as an alias of 'id' for the `$field` parameter.
  *
  * @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param.
  *
- * @param string     $field    Either 'slug', 'name', 'id' (term_id or ID), or 'term_taxonomy_id'
- * @param string|int $value    Search for this term value
+ * @param string     $field    Either 'slug', 'name', 'id' or 'ID' (term_id), or 'term_taxonomy_id'.
+ * @param string|int $value    Search for this term value.
  * @param string     $taxonomy Taxonomy name. Optional, if `$field` is 'term_taxonomy_id'.
  * @param string     $output   Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
@@ -943 +943 @@
     }
 
-    if ( 'id' === $field || 'term_id' === $field || 'ID' === $field ) {
+    if ( 'id' === $field || 'ID' === $field || 'term_id' === $field ) {
         $term = get_term( (int) $value, $taxonomy, $output, $filter );
         if ( is_wp_error( $term ) || null === $term ) {