wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_insert_category › WordPress Function

Since2.0.0
Deprecatedn/a
wp_insert_category ( $catarr, $wp_error = false )
Parameters: (2)
  • (array) $catarr { Array of arguments for inserting a new category. @type int $cat_ID Category ID. A non-zero value updates an existing category. Default 0. @type string $taxonomy Taxonomy slug. Default 'category'. @type string $cat_name Category name. Default empty. @type string $category_description Category description. Default empty. @type string $category_nicename Category nice (display) name. Default empty. @type int|string $category_parent Category parent ID. Default empty. }
    Required: Yes
  • (bool) $wp_error Optional. Default false.
    Required: No
    Default: false
Returns:
  • (int|WP_Error) The ID number of the new or updated Category on success. Zero or a WP_Error on failure, depending on param `$wp_error`.
Defined at:
Codex:
Change Log:
  • 2.5.0
  • 3.0.0

Updates an existing Category or creates a new Category.



Source

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'];
}