Question

wp_insert_category( array $catarr,  bool $wp_error = false )

Updates an existing Category or creates a new Category.

---

description

---

参数

$catarr

(array) (Required) Array of arguments for inserting a new category.

• 'cat_ID'
  (int) Category ID. A non-zero value updates an existing category. Default 0.
• 'taxonomy'
  (string) Taxonomy slug. Default 'category'.
• 'cat_name'
  (string) Category name. Default empty.
• 'category_description'
  (string) Category description. Default empty.
• 'category_nicename'
  (string) Category nice (display) name. Default empty.
• 'category_parent'
  (int|string) Category parent ID. Default empty.

$wp_error

(bool) (Optional)

Default value: false

---

返回值

(int|object) The ID number of the new or updated Category on success. Zero or a WP_Error on failure, depending on param $wp_error.

---

源代码

File: wp-admin/includes/taxonomy.php

function wp_insert_category( $catarr, $wp_error = false ) {
	$cat_defaults = array( 'cat_ID' => 0, 'taxonomy' => 'category', 'cat_name' => '', 'category_description' => '', 'category_nicename' => '', 'category_parent' => '' );
	$catarr = wp_parse_args( $catarr, $cat_defaults );

	if ( trim( $catarr['cat_name'] ) == '' ) {
		if ( ! $wp_error ) {
			return 0;
		} else {
			return new WP_Error( 'cat_name', __( 'You did not enter a category name.' ) );
		}
	}

	$catarr['cat_ID'] = (int) $catarr['cat_ID'];

	// Are we updating or creating?
	$update = ! empty ( $catarr['cat_ID'] );

	$name = $catarr['cat_name'];
	$description = $catarr['category_description'];
	$slug = $catarr['category_nicename'];
	$parent = (int) $catarr['category_parent'];
	if ( $parent < 0 ) {
		$parent = 0;
	}

	if ( empty( $parent )
		|| ! term_exists( $parent, $catarr['taxonomy'] )
		|| ( $catarr['cat_ID'] && term_is_ancestor_of( $catarr['cat_ID'], $parent, $catarr['taxonomy'] ) ) ) {
		$parent = 0;
	}

	$args = compact('name', 'slug', 'parent', 'description');

	if ( $update ) {
		$catarr['cat_ID'] = wp_update_term( $catarr['cat_ID'], $catarr['taxonomy'], $args );
	} else {
		$catarr['cat_ID'] = wp_insert_term( $catarr['cat_name'], $catarr['taxonomy'], $args );
	}

	if ( is_wp_error( $catarr['cat_ID'] ) ) {
		if ( $wp_error ) {
			return $catarr['cat_ID'];
		} else {
			return 0;
		}
	}
	return $catarr['cat_ID']['term_id'];
}

---

更新日志

Version	description
3.0.0	The 'taxonomy' argument was added.
2.5.0	$wp_error parameter was added.
2.0.0	Introduced.

---

相关函数

Uses

• wp-includes/l10n.php: __()
• wp-includes/functions.php: wp_parse_args()
• wp-includes/taxonomy.php: wp_update_term()
• wp-includes/taxonomy.php: wp_insert_term()
• wp-includes/taxonomy.php: term_exists()
• wp-includes/taxonomy.php: term_is_ancestor_of()
• wp-includes/load.php: is_wp_error()
• wp-includes/class-wp-error.php: WP_Error::__construct()
Show 3 more uses Hide more uses

---

Used By

• wp-admin/includes/taxonomy.php: wp_create_category()
• wp-admin/includes/taxonomy.php: wp_update_category()
• wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_newCategory()

---

User Contributed Notes

1. Skip to note content You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note Contributed by Codex

   To insert a new category:

   
   //Define the category
   $wpdocs_cat = array('cat_name' => 'Wpdocs Category', 'category_description' => 'A Cool Category', 'category_nicename' => 'category-slug', 'category_parent' => '');
   
   // Create the category
   $wpdocs_cat_id = wp_insert_category($wpdocs_cat);