Confusing argument name in `wp_set_post_terms()`

[desrosj]

The wp_set_post_terms() function updates the terms for a taxonomy assigned to a given post based on the arguments supplied.

The second argument is $tags. This name makes sense when using the default value of post_tag for the taxonomy argument, but feels weird when any other taxonomy is passed.

At the core, tags are just terms. Changing $tags to $terms would make the function more generic, interchangeable, and less confusing.

[hilayt24]

@desrosj , I agree with your suggestion here I am adding patch for the same here.

[hilayt24]

Argument name changed along with comment

[costdev]

Hi @hilayt24, thanks for the patch! You'll also need to change all occurrences of $tags inside the function to $terms.

[hilayt24]

@costdev, Thank you for spotting that.

[hilayt24]

$tags changed to $terms in the function

[costdev]

Thanks @hilayt24! There's also the "tag delimiter" string, which should be changed to "term delimiter"

[hilayt24]

@costdev, Ohh thanks !!

[hilayt24]

Every Instance of tags changed to tems

[costdev]

LGTM! 👍

[SergeyBiryukov]

Thanks for the patch!

The context for _x( ',', 'tag delimiter' ); should not be changed here, as this string is used in other places of core, and changing the context will unnecessarily duplicate it.

[krishaweb]

Here is the updated patch per the @SergeyBiryukov suggestion.

[costdev]

My mistake! 😅

[desrosj]

Thanks for the patches, everyone!

This is looking good to go. There is one more instance of $tags that needs to change near the end. But I can fix that one before committing to avoid having to create another patch.

[desrosj]

In 53825:

Posts, Post Types: Change variable name in wp_set_post_terms() for clarity.

This changes the $tags variable used within wp_set_post_terms() to $terms.

While the default for the $taxonomy argument is post_tag, the function can be used to assign terms to a post for any taxonomy. When a different taxonomy is passed, $tags is an inaccurate name and could be confusing.

Props hilayt24, costdev, SergeyBiryukov, krishaweb, desrosj.
Fixes #56331.