wp_set_post_tags()
Set the tags for a post.
Uses: wp_set_post_terms()
No Hooks.
Return
Array|false|WP_Error
. Array of term taxonomy IDs of affected terms. WP_Error or false on failure.
Usage
wp_set_post_tags( $post_id, $tags, $append );
- $post_id(int)
- The Post ID. Does not default to the ID of the global $post.
- $tags(string|array)
- An array of tags to set for the post, or a string of tags separated by commas.
Default: '' - $append(true|false)
- If true, don't delete existing tags, just add on. If false, replace the tags with the new tags.
Default: false
Examples
#1 Add tags for the post
This example adds post 42 to the "feelings" and "life" tags (current post tags remains). If the specified tags do not exist, they will be created:
wp_set_post_tags( 42, 'feelings,life', true );
#2 Add array of tags to post with ID 100
Current post tags will be unset and specified ones will be set.
$post_id = 100; $tags = [ 'Mango', 'Apple', 'Banana' ]; wp_set_post_tags( $post_id, $tags );
Notes
Changelog
Since 2.3.0 | Introduced. |
wp_set_post_tags() wp set post tags code WP 6.1.1
function wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) { return wp_set_post_terms( $post_id, $tags, 'post_tag', $append ); }