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 insert term

Contents

Description

Adds a new term to the database. Optionally marks it as an alias of an existing term.

Usage

<?php wp_insert_term$term$taxonomy$args = array() ); ?>

Parameters

$term
(int|string) (required) The term to add or update.
Default: None
$taxonomy
(string) (required) The taxonomy to which to add the term.
Default: None
$args
(array|string) (optional) Change the values of the inserted term
Default: None

Return Values

(array|WP_Error) 
The Term ID and Term Taxonomy ID. (Example: array('term_id'=>12,'term_taxonomy_id'=>34))

The arguments decide how the term is handled based on the $args parameter. The following is a list of the available overrides and the defaults.

'alias_of'
(string) (optional) There is no default, but if added, expected is the slug that the term will be an alias of.
Default: None
'description'
(string) (optional) If exists, will be added to the database along with the term.
Default: None
'parent'
(numeric) (optional) Will assign value of 'parent' to the term.
Default: 0 (zero)
'slug'
(string) (optional)
Default: None

If 'slug' argument exists then the slug will be checked to see if it is not a valid term. If that check succeeds (it is not a valid term), then it is added and the term id is given. If it fails, then a check is made to whether the taxonomy is hierarchical and the parent argument is not empty. If the second check succeeds, the term will be inserted and the term id will be given. If the slug argument is empty, then it will be calculated from the term name.

Error handling is assigned for the nonexistence of the $taxonomy and $term parameters before inserting. If both the term id and taxonomy exist previously, then an array will be returned that contains the term id and the contents of what is returned. The keys of the array are 'term_id' and 'term_taxonomy_id' containing numeric values.

It is assumed that the term does not yet exist or the above will apply. The term will be first added to the term table and then related to the taxonomy if everything is well. If everything is correct, then several actions will be run prior to a filter and then several actions will be run after the filter is run.

Example

$parent_term = term_exists( 'fruits', 'product' ); // array is returned if taxonomy is given
$parent_term_id = $parent_term['term_id']; // get numeric term id
wp_insert_term(
  'Apple', // the term 
  'product', // the taxonomy
  array(
    'description'=> 'A yummy apple.',
    'slug' => 'apple',
    'parent'=> $parent_term_id
  )
);

Hooks Used

  • 'pre_insert_term' filter with $term and $taxonomy as parameters

This function calls these hooks with term id and taxonomy id as parameters:

  • 'create_term' action
  • 'create_$taxonomy' action
  • 'term_id_filter' filter
  • 'created_term' action
  • 'created_$taxonomy' action

Change Log

Since: 2.3.0

Source File

wp_insert_term() is located in wp-includes/taxonomy.php.

Related

wp_update_term, wp_unique_term_slug

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