Allow the_terms() and get_the_terms() to accept an array of taxonomies

[ramiy]

The the_terms() can accept array of taxonomies (several taxonomies) but the phpDocs say it can accept only a string (one taxonomy). This wrong documentation could save me a lot of time.

I fix the documentation in the code for other developers. See the attached file. After the ticket will be accepted, i will fix the Codex.

[DrewAPicture]

After taking a closer look at this, I think the only way the_terms() is able to accept an array is by the cache get failing in get_object_term_cache(), thereby passing the array of taxonomies to wp_get_object_terms() in get_the_terms() instead.

Seems like rather than continuing to allow an array to be passed in the_terms() we should explicitly check for a string in get_the_terms().

[SergeyBiryukov]

Passing an array of taxonomies to the_terms() leads to some issues:

1. It causes array to string conversion for term_links-$taxonomy​ filter, making it 'term_links-Array'.
2. It causes the same conversion in get_object_term_cache()​ and get_the_terms()​, resulting in 'Array_relationships' cache key.
3. It breaks anyone's code using the_terms​ or get_the_terms​ filters and only expecting a string in $taxonomy argument.

So, the documentation is correct, string is the only valid option currently here.

[ramiy]

Hi guys, thanks for the clarification.

Do you think we need to change the ticket target, from documentation to bug fix?
To solve all the array issues in the_terms() and all other functions?

[SergeyBiryukov]

Replying to ramiy:

Do you think we need to change the ticket target, from documentation to bug fix?

It would be an enhancement (allow the_terms() and get_the_terms() accept an array as $taxonomy argument), since it currently works as intended with a string argument.

[wonderboymusic]

This can stay alive but will need someone to champion it with some .diff files

[wonderboymusic]

Should be tackled along with: #26234

[philbuchanan]

Just a quick note, unlike the_terms(), the get_the_terms() documentation currently says that it accepts an array for the taxonomy parameter. Can that be updated until the function is patched to accept arrays?

[sem101]

Hi guys, is this a bug? I just found this ticket after posting to the forums...
​http://wordpress.org/support/topic/get_the_terms-taxonomy-array-to-string-conversion

Thanks for any update.

[wonderboymusic]

The docs for the_terms() and - get_the_term_list(), get_the_terms(), and get_object_term_cache() (which are written in the context of only one taxonomy) - all take string as the value of $taxonomy.

This would result in some bizarre churn in those funcs, just so they can pass an array to wp_get_object_terms() down the chain - I vote no