Changeset 37656

Timestamp:

06/08/2016 04:07:47 AM (8 years ago)

Author:

boonebgorges

Message:

Add a note about uniqueness to the doc block for get_term_by().

get_term_by() always returns a single term, even when more than one term
matches the query parameters. The new note warns developers to use
get_terms() when such ambiguity may result.

Fixes #36878.

File:

• trunk/src/wp-includes/taxonomy.php (modified) (1 diff)

trunk/src/wp-includes/taxonomy.php

@@ -902 +902 @@
  * If $value does not exist, the return value will be false. If $taxonomy exists
  * and $field and $value combinations exist, the Term will be returned.
+ *
+ * This function will always return the first term that matches the `$field`-
+ * `$value`-`$taxonomy` combination specified in the parameters. If your query
+ * is likely to match more than one term (as is likely to be the case when
+ * `$field` is 'name', for example), consider using get_terms() instead; that
+ * way, you will get all matching terms, and can provide your own logic for
+ * deciding which one was intended.
  *
  * @todo Better formatting for DocBlock.