A WordPress-centric search engine for devs and theme authors



wp_set_post_terms ›

Since2.8.0
Deprecatedn/a
› wp_set_post_terms ( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $append = false )
Parameters: (4)
  • (int) $post_id Optional. The Post ID. Does not default to the ID of the global $post.
    Required: No
    Default: —
  • (string|array) $tags Optional. An array of terms to set for the post, or a string of terms separated by commas. Hierarchical taxonomies must always pass IDs rather than names so that children with the same names but different parents aren't confused. Default empty.
    Required: No
    Default: (empty)
  • (string) $taxonomy Optional. Taxonomy name. Default 'post_tag'.
    Required: No
    Default: 'post_tag'
  • (bool) $append Optional. If true, don't delete existing terms, just add on. If false, replace the terms with the new terms. Default false.
    Required: No
    Default: false
See:
Returns:
  • (array|false|WP_Error) Array of term taxonomy IDs of affected terms. WP_Error or false on failure.
Defined at:
Codex:

Set the terms for a post.



Related Functions: wp_get_post_terms, wp_set_post_cats, wp_set_post_tags, wp_set_object_terms, wp_set_post_categories

Source 

function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $append = false ) {
	$post_id = (int) $post_id;

	if ( ! $post_id ) {
		return false;
	}

	if ( empty( $tags ) ) {
		$tags = array();
	}

	if ( ! is_array( $tags ) ) {
		$comma = _x( ',', 'tag delimiter' );
		if ( ',' !== $comma ) {
			$tags = str_replace( $comma, ',', $tags );
		}
		$tags = explode( ',', trim( $tags, " \n\t\r\0\x0B," ) );
	}

	/*
	 * Hierarchical taxonomies must always pass IDs rather than names so that
	 * children with the same names but different parents aren't confused.
	 */
	if ( is_taxonomy_hierarchical( $taxonomy ) ) {
		$tags = array_unique( array_map( 'intval', $tags ) );
	}

	return wp_set_object_terms( $post_id, $tags, $taxonomy, $append );
}