3 * WordPress Taxonomy Administration API.
6 * @subpackage Administration
14 * {@internal Missing Short Description}}
18 * @param unknown_type $cat_name
21 function category_exists($cat_name, $parent = 0) {
22 $id = term_exists($cat_name, 'category', $parent);
29 * {@internal Missing Short Description}}
33 * @param unknown_type $id
36 function get_category_to_edit( $id ) {
37 $category = get_category( $id, OBJECT, 'edit' );
42 * {@internal Missing Short Description}}
46 * @param unknown_type $cat_name
47 * @param unknown_type $parent
50 function wp_create_category( $cat_name, $parent = 0 ) {
51 if ( $id = category_exists($cat_name, $parent) )
54 return wp_insert_category( array('cat_name' => $cat_name, 'category_parent' => $parent) );
58 * {@internal Missing Short Description}}
62 * @param unknown_type $categories
63 * @param unknown_type $post_id
66 function wp_create_categories($categories, $post_id = '') {
68 foreach ($categories as $category) {
69 if ($id = category_exists($category))
72 if ($id = wp_create_category($category))
77 wp_set_post_categories($post_id, $cat_ids);
83 * Deletes one existing category.
88 * @return mixed Returns true if completes delete action; false if term doesnt exist; Zero on attempted deletion of default Category; WP_Error object is also a possibility.
90 function wp_delete_category($cat_ID) {
91 $cat_ID = (int) $cat_ID;
92 $default = get_option('default_category');
94 // Don't delete the default cat
95 if ( $cat_ID == $default )
98 return wp_delete_term($cat_ID, 'category', array('default' => $default));
102 * Updates an existing Category or creates a new Category.
106 * @param mixed $catarr See defaults below. Set 'cat_ID' to a non-zero value to update an existing category. The 'taxonomy' key was added in 3.0.0.
107 * @param bool $wp_error Optional, since 2.5.0. Set this to true if the caller handles WP_Error return values.
108 * @return 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.
110 function wp_insert_category($catarr, $wp_error = false) {
111 $cat_defaults = array('cat_ID' => 0, 'taxonomy' => 'category', 'cat_name' => '', 'category_description' => '', 'category_nicename' => '', 'category_parent' => '');
112 $catarr = wp_parse_args($catarr, $cat_defaults);
113 extract($catarr, EXTR_SKIP);
115 if ( trim( $cat_name ) == '' ) {
119 return new WP_Error( 'cat_name', __('You did not enter a category name.') );
122 $cat_ID = (int) $cat_ID;
124 // Are we updating or creating?
125 if ( !empty ($cat_ID) )
131 $description = $category_description;
132 $slug = $category_nicename;
133 $parent = $category_parent;
135 $parent = (int) $parent;
139 if ( empty($parent) || !category_exists( $parent ) || ($cat_ID && cat_is_ancestor_of($cat_ID, $parent) ) )
142 $args = compact('name', 'slug', 'parent', 'description');
145 $cat_ID = wp_update_term($cat_ID, $taxonomy, $args);
147 $cat_ID = wp_insert_term($cat_name, $taxonomy, $args);
149 if ( is_wp_error($cat_ID) ) {
156 return $cat_ID['term_id'];
160 * Aliases wp_insert_category() with minimal args.
162 * If you want to update only some fields of an existing category, call this
163 * function with only the new values set inside $catarr.
167 * @param array $catarr The 'cat_ID' value is required. All other keys are optional.
168 * @return int|bool The ID number of the new or updated Category on success. Zero or FALSE on failure.
170 function wp_update_category($catarr) {
171 $cat_ID = (int) $catarr['cat_ID'];
173 if ( isset($catarr['category_parent']) && ($cat_ID == $catarr['category_parent']) )
176 // First, get all of the original fields
177 $category = get_category($cat_ID, ARRAY_A);
179 // Escape data pulled from DB.
180 $category = add_magic_quotes($category);
182 // Merge old and new fields with new fields overwriting old ones.
183 $catarr = array_merge($category, $catarr);
185 return wp_insert_category($catarr);
193 * {@internal Missing Short Description}}
197 * @param unknown_type $post_id
200 function get_tags_to_edit( $post_id, $taxonomy = 'post_tag' ) {
201 return get_terms_to_edit( $post_id, $taxonomy);
205 * {@internal Missing Short Description}}
209 * @param unknown_type $post_id
212 function get_terms_to_edit( $post_id, $taxonomy = 'post_tag' ) {
213 $post_id = (int) $post_id;
217 $tags = wp_get_post_terms($post_id, $taxonomy, array());
222 if ( is_wp_error($tags) )
225 foreach ( $tags as $tag )
226 $tag_names[] = $tag->name;
227 $tags_to_edit = join( ',', $tag_names );
228 $tags_to_edit = esc_attr( $tags_to_edit );
229 $tags_to_edit = apply_filters( 'terms_to_edit', $tags_to_edit, $taxonomy );
231 return $tags_to_edit;
235 * {@internal Missing Short Description}}
239 * @param unknown_type $tag_name
242 function tag_exists($tag_name) {
243 return term_exists($tag_name, 'post_tag');
247 * {@internal Missing Short Description}}
251 * @param unknown_type $tag_name
254 function wp_create_tag($tag_name) {
255 return wp_create_term( $tag_name, 'post_tag');
259 * {@internal Missing Short Description}}
263 * @param unknown_type $tag_name
266 function wp_create_term($tag_name, $taxonomy = 'post_tag') {
267 if ( $id = term_exists($tag_name, $taxonomy) )
270 return wp_insert_term($tag_name, $taxonomy);