wp_set_post_terms( int $post_id = 0, string|array $terms = '', string $taxonomy = 'post_tag', bool $append = false ): array|false|WP_Error

Parameters

$post_idintoptional

The Post ID. Does not default to the ID of the global $post.Default: 0

$termsstring|arrayoptional

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.Default: ''

$taxonomystringoptional

Taxonomy name. Default 'post_tag'.Default: 'post_tag'

$appendbooloptional

If true, don't delete existing terms, just add on. If false, replace the terms with the new terms. Default false.Default: false

Return

array|false|WP_Error

Array of term taxonomy IDs of affected terms. WP_Error or false on failure.

Uses · 3

• _x()Retrieves translated string with gettext context.
• is_taxonomy_hierarchical()Determines whether the taxonomy object is hierarchical.
• wp_set_object_terms()Creates term and taxonomy relationships.

Used by · 6

• set_post_format()Assign a format to a post
• wp_insert_post()Inserts or update a post.
• wp_publish_post()Publishes a post by transitioning the post status.
• wp_set_post_categories()Sets categories for a post.
• wp_set_post_tags()Sets the tags for a post.
• wp_set_unique_slug_on_create_template_part()Sets a custom slug when creating auto-draft template parts.

Source

View on Trac ↗View on GitHub ↗

5627function wp_set_post_terms( $post_id = 0, $terms = '', $taxonomy = 'post_tag', $append = false ) {5628	$post_id = (int) $post_id;5629 5630	if ( ! $post_id ) {5631		return false;5632	}5633 5634	if ( empty( $terms ) ) {5635		$terms = array();5636	}5637 5638	if ( ! is_array( $terms ) ) {5639		$comma = _x( ',', 'tag delimiter' );5640		if ( ',' !== $comma ) {5641			$terms = str_replace( $comma, ',', $terms );5642		}5643		$terms = explode( ',', trim( $terms, " \n\t\r\0\x0B," ) );5644	}5645 5646	/*5647	 * Hierarchical taxonomies must always pass IDs rather than names so that5648	 * children with the same names but different parents aren't confused.5649	 */5650	if ( is_taxonomy_hierarchical( $taxonomy ) ) {5651		$terms = array_unique( array_map( 'intval', $terms ) );5652	}5653 5654	return wp_set_object_terms( $post_id, $terms, $taxonomy, $append );5655}

History

Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/post.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.