Changeset 47865

Timestamp:

05/29/2020 10:41:25 PM (4 years ago)

Author:

whyisjake

Message:

Taxonomy: Extend get_term_by to accept ID as a term parameter.

Similar to get_user_by, both ID and id should be able to accepted.

Fixes #45163.
Props emrikol, esoj.

Location:

trunk

Files:

• src/wp-includes/taxonomy.php (modified) (2 diffs)
• tests/phpunit/tests/term/getTermBy.php (modified) (1 diff)

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.
  *
  * @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 'term_taxonomy_id'
+ * @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     $taxonomy Taxonomy name. Optional, if `$field` is 'term_taxonomy_id'.
@@ -942 +943 @@
     }
 
-    if ( 'id' === $field || 'term_id' === $field ) {
+    if ( 'id' === $field || 'term_id' === $field || 'ID' === $field ) {
         $term = get_term( (int) $value, $taxonomy, $output, $filter );
         if ( is_wp_error( $term ) || null === $term ) {

trunk/tests/phpunit/tests/term/getTermBy.php

@@ -32 +32 @@
         $this->assertEquals( get_term( $term1['term_id'], 'category' ), $term2 );
     }
+
+    /**
+     * @ticket 45163
+     */
+    function test_get_term_by_uppercase_id() {
+        $term1 = wp_insert_term( 'Foo', 'category', array( 'slug' => 'foo' ) );
+        $term2 = get_term_by( 'ID', $term1['term_id'], 'category' );
+        $this->assertEquals( get_term( $term1['term_id'], 'category' ), $term2 );
+    }   
 
     /**