]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-admin/includes/taxonomy.php
WordPress 3.3.2-scripts
[autoinstalls/wordpress.git] / wp-admin / includes / taxonomy.php
index b490ed639ca47ce30bc1ca5f7a2e827eaa09e9af..12e231a8179a4f2e8c62efc83c4fd0fbc1336e60 100644 (file)
@@ -1,28 +1,68 @@
 <?php
+/**
+ * WordPress Taxonomy Administration API.
+ *
+ * @package WordPress
+ * @subpackage Administration
+ */
 
 //
 // Category
 //
 
-function category_exists($cat_name) {
-       $id = is_term($cat_name, 'category');
+/**
+ * {@internal Missing Short Description}}
+ *
+ * @since 2.0.0
+ *
+ * @param unknown_type $cat_name
+ * @return unknown
+ */
+function category_exists($cat_name, $parent = 0) {
+       $id = term_exists($cat_name, 'category', $parent);
        if ( is_array($id) )
                $id = $id['term_id'];
        return $id;
 }
 
+/**
+ * {@internal Missing Short Description}}
+ *
+ * @since 2.0.0
+ *
+ * @param unknown_type $id
+ * @return unknown
+ */
 function get_category_to_edit( $id ) {
        $category = get_category( $id, OBJECT, 'edit' );
        return $category;
 }
 
+/**
+ * {@internal Missing Short Description}}
+ *
+ * @since 2.0.0
+ *
+ * @param unknown_type $cat_name
+ * @param unknown_type $parent
+ * @return unknown
+ */
 function wp_create_category( $cat_name, $parent = 0 ) {
-       if ( $id = category_exists($cat_name) )
+       if ( $id = category_exists($cat_name, $parent) )
                return $id;
 
        return wp_insert_category( array('cat_name' => $cat_name, 'category_parent' => $parent) );
 }
 
+/**
+ * {@internal Missing Short Description}}
+ *
+ * @since 2.0.0
+ *
+ * @param unknown_type $categories
+ * @param unknown_type $post_id
+ * @return unknown
+ */
 function wp_create_categories($categories, $post_id = '') {
        $cat_ids = array ();
        foreach ($categories as $category) {
@@ -33,26 +73,24 @@ function wp_create_categories($categories, $post_id = '') {
                                $cat_ids[] = $id;
        }
 
-       if ($post_id)
+       if ( $post_id )
                wp_set_post_categories($post_id, $cat_ids);
 
        return $cat_ids;
 }
 
-function wp_delete_category($cat_ID) {
-       $cat_ID = (int) $cat_ID;
-       $default = get_option('default_category');
-
-       // Don't delete the default cat
-       if ( $cat_ID == $default )
-               return 0;
-
-       return wp_delete_term($cat_ID, 'category', "default=$default");
-}
-
+/**
+ * Updates an existing Category or creates a new Category.
+ *
+ * @since 2.0.0
+ *
+ * @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.
+ * @param bool $wp_error Optional, since 2.5.0. Set this to true if the caller handles WP_Error return values.
+ * @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.
+ */
 function wp_insert_category($catarr, $wp_error = false) {
-       $cat_defaults = array('cat_ID' => 0, 'cat_name' => '', 'category_description' => '', 'category_nicename' => '', 'category_parent' => '');
-       $cat_arr = wp_parse_args($cat_arr, $cat_defaults);
+       $cat_defaults = array('cat_ID' => 0, 'taxonomy' => 'category', 'cat_name' => '', 'category_description' => '', 'category_nicename' => '', 'category_parent' => '');
+       $catarr = wp_parse_args($catarr, $cat_defaults);
        extract($catarr, EXTR_SKIP);
 
        if ( trim( $cat_name ) == '' ) {
@@ -85,9 +123,9 @@ function wp_insert_category($catarr, $wp_error = false) {
        $args = compact('name', 'slug', 'parent', 'description');
 
        if ( $update )
-               $cat_ID = wp_update_term($cat_ID, 'category', $args);
+               $cat_ID = wp_update_term($cat_ID, $taxonomy, $args);
        else
-               $cat_ID = wp_insert_term($cat_name, 'category', $args);
+               $cat_ID = wp_insert_term($cat_name, $taxonomy, $args);
 
        if ( is_wp_error($cat_ID) ) {
                if ( $wp_error )
@@ -99,10 +137,21 @@ function wp_insert_category($catarr, $wp_error = false) {
        return $cat_ID['term_id'];
 }
 
+/**
+ * Aliases wp_insert_category() with minimal args.
+ *
+ * If you want to update only some fields of an existing category, call this
+ * function with only the new values set inside $catarr.
+ *
+ * @since 2.0.0
+ *
+ * @param array $catarr The 'cat_ID' value is required.  All other keys are optional.
+ * @return int|bool The ID number of the new or updated Category on success. Zero or FALSE on failure.
+ */
 function wp_update_category($catarr) {
        $cat_ID = (int) $catarr['cat_ID'];
 
-       if ( $cat_ID == $catarr['category_parent'] )
+       if ( isset($catarr['category_parent']) && ($cat_ID == $catarr['category_parent']) )
                return false;
 
        // First, get all of the original fields
@@ -121,33 +170,83 @@ function wp_update_category($catarr) {
 // Tags
 //
 
-function get_tags_to_edit( $post_id ) {
+/**
+ * {@internal Missing Short Description}}
+ *
+ * @since 2.3.0
+ *
+ * @param unknown_type $tag_name
+ * @return unknown
+ */
+function tag_exists($tag_name) {
+       return term_exists($tag_name, 'post_tag');
+}
+
+/**
+ * {@internal Missing Short Description}}
+ *
+ * @since 2.3.0
+ *
+ * @param unknown_type $tag_name
+ * @return unknown
+ */
+function wp_create_tag($tag_name) {
+       return wp_create_term( $tag_name, 'post_tag');
+}
+
+/**
+ * {@internal Missing Short Description}}
+ *
+ * @since 2.3.0
+ *
+ * @param unknown_type $post_id
+ * @return unknown
+ */
+function get_tags_to_edit( $post_id, $taxonomy = 'post_tag' ) {
+       return get_terms_to_edit( $post_id, $taxonomy);
+}
+
+/**
+ * {@internal Missing Short Description}}
+ *
+ * @since 2.8.0
+ *
+ * @param unknown_type $post_id
+ * @return unknown
+ */
+function get_terms_to_edit( $post_id, $taxonomy = 'post_tag' ) {
        $post_id = (int) $post_id;
        if ( !$post_id )
                return false;
 
-       $tags = wp_get_post_tags($post_id);
+       $tags = wp_get_post_terms($post_id, $taxonomy, array());
 
        if ( !$tags )
                return false;
 
+       if ( is_wp_error($tags) )
+               return $tags;
+
        foreach ( $tags as $tag )
                $tag_names[] = $tag->name;
-       $tags_to_edit = join( ', ', $tag_names );
-       $tags_to_edit = attribute_escape( $tags_to_edit );
-       $tags_to_edit = apply_filters( 'tags_to_edit', $tags_to_edit );
-       return $tags_to_edit;
-}
+       $tags_to_edit = join( ',', $tag_names );
+       $tags_to_edit = esc_attr( $tags_to_edit );
+       $tags_to_edit = apply_filters( 'terms_to_edit', $tags_to_edit, $taxonomy );
 
-function tag_exists($tag_name) {
-       return is_term($tag_name, 'post_tag');
+       return $tags_to_edit;
 }
 
-function wp_create_tag($tag_name) {
-       if ( $id = tag_exists($tag_name) )
+/**
+ * {@internal Missing Short Description}}
+ *
+ * @since 2.8.0
+ *
+ * @param unknown_type $tag_name
+ * @return unknown
+ */
+function wp_create_term($tag_name, $taxonomy = 'post_tag') {
+       if ( $id = term_exists($tag_name, $taxonomy) )
                return $id;
 
-       return wp_insert_term($tag_name, 'post_tag');
+       return wp_insert_term($tag_name, $taxonomy);
 }
-
-?>