WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Function Reference/wp set post terms

Contents

Description

Set terms for a post.

Uses wp_set_object_terms().

Usage

<?php wp_set_post_terms$post_id$terms$taxonomy$append ?>

Parameters

$post_id
(integer) (required) Post ID.
Default: 0
$terms
(string,array) (optional) List of terms. Can be an array or a comma separated string. If you want to enter terms of a hierarchical taxonomy like categories, then use IDs. If you want to add non-hierarchical terms like tags, then use names.
Default: array
$taxonomy
(string) (optional) Possible values for example: 'category', 'post_tag', 'taxonomy slug'
Default: post_tag
$append
(boolean) (optional) If true, tags will be appended to the post. If false, tags will replace existing tags.
Default: false

Return Values

(array|boolean|WP_Error|string) 
  • (array) An array of the terms affected if successful,
  • (boolean) false if integer value of $post_id evaluates as false (if ( ! (int) $post_id )),
  • (WP_Error) The WordPress Error object on invalid taxonomy ('invalid_taxonomy').
  • (string) The first offending term if a term given in the $terms parameter is named incorrectly. (Invalid term ids are accepted and inserted).

Hooks


Examples

Notes

For hierarchical terms (such as categories), you must always pass the id rather than the term name to avoid confusion where there may be another child with the same name.

To get the term id you can use:

$term_id = term_exists( $term, $taxonomy, $parent );

You may also need to pass by reference:

wp_set_post_terms( $post_id, $term, &$taxonomy );

For non-hierarchical terms (such as tags), you can pass either the term name or id. If you pass the id there is only one caveat: You must pass it as an integer, and it must be in an array. This is necessary because any non-array value passed will be converted to a string, which will be interpreted as a term name.

$tag = '5'; // Wrong. This will add the tag with the *name* '5'.
$tag = 5; // Wrong. This will also add the tag with the name '5'.
$tag = array( '5' ); // Wrong. Again, this will be interpreted as a term name rather than an id.

$tag = array( 5 ); // Correct. This will add the tag with the id 5.
wp_set_post_terms( $post_id, $tag, $taxonomy );

This function will only work on the native post type. For a taxonomy on a custom post type use wp_set_object_terms()

Change Log

Since: 2.8.0

Source File

wp_set_post_terms() is located in wp-includes/post.php.

Related

See also index of Function Reference and index of Template Tags.