Changeset 35028

Timestamp:

10/12/2015 04:13:25 AM (9 years ago)

Author:

boonebgorges

Message:

Don't require a $taxonomy to be specified in get_term_field().

After [34997], the $taxonomy parameter of get_term() is optional. This
changeset brings get_term_field() in line with the new usage.

Adds unit tests for get_term_field().

Props DrewAPicture.
See #34245.

Location:

trunk

Files:

• src/wp-includes/taxonomy-functions.php (modified) (2 diffs)
• tests/phpunit/tests/term/getTermField.php (added)

trunk/src/wp-includes/taxonomy-functions.php

@@ -921 +921 @@
  * Get sanitized Term field.
  *
- * Does checks for $term, based on the $taxonomy. The function is for contextual
- * reasons and for simplicity of usage. See sanitize_term_field() for more
- * information.
+ * The function is for contextual reasons and for simplicity of usage.
  *
  * @since 2.3.0
- *
- * @param string $field    Term field to fetch.
- * @param int    $term     Term ID.
- * @param string $taxonomy Taxonomy Name.
+ * @since 4.4.0 The `$taxonomy` parameter was made optional. `$term` can also now accept a WP_Term object.
+ *
+ * @see sanitize_term_field()
+ *
+ * @param string $field Term field to fetch.
+ * @param int|WP_Term $term Term ID or object.
+ * @param string $taxonomy Optional. Taxonomy Name. Default empty.
  * @param string $context  Optional, default is display. Look at sanitize_term_field() for available options.
  * @return string|int|null|WP_Error Will return an empty string if $term is not an object or if $field is not set in $term.
  */
-function get_term_field( $field, $term, $taxonomy, $context = 'display' ) {
-    $term = (int) $term;
+function get_term_field( $field, $term, $taxonomy = '', $context = 'display' ) {
     $term = get_term( $term, $taxonomy );
     if ( is_wp_error($term) )
@@ -945 +945 @@
         return '';
 
-    return sanitize_term_field($field, $term->$field, $term->term_id, $taxonomy, $context);
+    return sanitize_term_field( $field, $term->$field, $term->term_id, $term->taxonomy, $context );
 }