X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/41578db67d72562346e4dbb2a14889b23d522813..88550bc3400cc7c035ff590ecb007c7938041ded:/wp-admin/includes/taxonomy.php

diff --git a/wp-admin/includes/taxonomy.php b/wp-admin/includes/taxonomy.php
index 2953765e..c8c03848 100644
--- a/wp-admin/includes/taxonomy.php
+++ b/wp-admin/includes/taxonomy.php
@@ -11,14 +11,17 @@
 //
 
 /**
- * {@internal Missing Short Description}}
+ * Check whether a category exists.
  *
  * @since 2.0.0
  *
- * @param unknown_type $cat_name
- * @return unknown
+ * @see term_exists()
+ *
+ * @param int|string $cat_name Category name.
+ * @param int        $parent   Optional. ID of parent term.
+ * @return mixed
  */
-function category_exists($cat_name, $parent = 0) {
+function category_exists( $cat_name, $parent = null ) {
 	$id = term_exists($cat_name, 'category', $parent);
 	if ( is_array($id) )
 		$id = $id['term_id'];
@@ -30,8 +33,8 @@ function category_exists($cat_name, $parent = 0) {
  *
  * @since 2.0.0
  *
- * @param unknown_type $id
- * @return unknown
+ * @param int $id
+ * @return object
  */
 function get_category_to_edit( $id ) {
 	$category = get_term( $id, 'category', OBJECT, 'edit' );
@@ -44,9 +47,9 @@ function get_category_to_edit( $id ) {
  *
  * @since 2.0.0
  *
- * @param unknown_type $cat_name
- * @param unknown_type $parent
- * @return unknown
+ * @param int|string $cat_name
+ * @param int        $parent
+ * @return int|WP_Error
  */
 function wp_create_category( $cat_name, $parent = 0 ) {
 	if ( $id = category_exists($cat_name, $parent) )
@@ -56,15 +59,15 @@ function wp_create_category( $cat_name, $parent = 0 ) {
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Create categories for the given post.
  *
  * @since 2.0.0
  *
- * @param unknown_type $categories
- * @param unknown_type $post_id
- * @return unknown
+ * @param array $categories List of categories to create.
+ * @param int   $post_id    Optional. The post ID. Default empty.
+ * @return List of categories to create for the given post.
  */
-function wp_create_categories($categories, $post_id = '') {
+function wp_create_categories( $categories, $post_id = '' ) {
 	$cat_ids = array ();
 	foreach ($categories as $category) {
 		if ($id = category_exists($category))
@@ -84,58 +87,71 @@ function wp_create_categories($categories, $post_id = '') {
  * Updates an existing Category or creates a new Category.
  *
  * @since 2.0.0
+ * @since 2.5.0 $wp_error parameter was added.
+ * @since 3.0.0 The 'taxonomy' argument was added.
+ *
+ * @param array $catarr {
+ *     Array of arguments for inserting a new category.
  *
- * @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.
+ *     @type int        $cat_ID               Categoriy ID. A non-zero value updates an existing category.
+ *                                            Default 0.
+ *     @type string     $taxonomy             Taxonomy slug. Defualt 'category'.
+ *     @type string     $cat_nam              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.
+ * }
+ * @param bool  $wp_error Optional. Default false.
+ * @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, 'taxonomy' => 'category', 'cat_name' => '', 'category_description' => '', 'category_nicename' => '', 'category_parent' => '');
-	$catarr = wp_parse_args($catarr, $cat_defaults);
-	extract($catarr, EXTR_SKIP);
+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( $cat_name ) == '' ) {
-		if ( ! $wp_error )
+	if ( trim( $catarr['cat_name'] ) == '' ) {
+		if ( ! $wp_error ) {
 			return 0;
-		else
-			return new WP_Error( 'cat_name', __('You did not enter a category name.') );
+		} else {
+			return new WP_Error( 'cat_name', __( 'You did not enter a category name.' ) );
+		}
 	}
 
-	$cat_ID = (int) $cat_ID;
+	$catarr['cat_ID'] = (int) $catarr['cat_ID'];
 
 	// Are we updating or creating?
-	if ( !empty ($cat_ID) )
-		$update = true;
-	else
-		$update = false;
-
-	$name = $cat_name;
-	$description = $category_description;
-	$slug = $category_nicename;
-	$parent = $category_parent;
-
-	$parent = (int) $parent;
-	if ( $parent < 0 )
+	$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, $taxonomy ) || ( $cat_ID && term_is_ancestor_of( $cat_ID, $parent, $taxonomy ) ) )
+	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 )
-		$cat_ID = wp_update_term($cat_ID, $taxonomy, $args);
-	else
-		$cat_ID = wp_insert_term($cat_name, $taxonomy, $args);
+	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($cat_ID) ) {
-		if ( $wp_error )
-			return $cat_ID;
-		else
+	if ( is_wp_error( $catarr['cat_ID'] ) ) {
+		if ( $wp_error ) {
+			return $catarr['cat_ID'];
+		} else {
 			return 0;
+		}
 	}
-
-	return $cat_ID['term_id'];
+	return $catarr['cat_ID']['term_id'];
 }
 
 /**
@@ -177,8 +193,8 @@ function wp_update_category($catarr) {
  *
  * @since 2.3.0
  *
- * @param unknown_type $tag_name
- * @return unknown
+ * @param int|string $tag_name
+ * @return mixed
  */
 function tag_exists($tag_name) {
 	return term_exists($tag_name, 'post_tag');
@@ -189,8 +205,8 @@ function tag_exists($tag_name) {
  *
  * @since 2.3.0
  *
- * @param unknown_type $tag_name
- * @return unknown
+ * @param int|string $tag_name
+ * @return array|WP_Error
  */
 function wp_create_tag($tag_name) {
 	return wp_create_term( $tag_name, 'post_tag');
@@ -201,8 +217,8 @@ function wp_create_tag($tag_name) {
  *
  * @since 2.3.0
  *
- * @param unknown_type $post_id
- * @return unknown
+ * @param int $post_id
+ * @return string|bool|WP_Error
  */
 function get_tags_to_edit( $post_id, $taxonomy = 'post_tag' ) {
 	return get_terms_to_edit( $post_id, $taxonomy);
@@ -213,26 +229,32 @@ function get_tags_to_edit( $post_id, $taxonomy = 'post_tag' ) {
  *
  * @since 2.8.0
  *
- * @param unknown_type $post_id
- * @return unknown
+ * @param int $post_id
+ * @return string|bool|WP_Error
  */
 function get_terms_to_edit( $post_id, $taxonomy = 'post_tag' ) {
 	$post_id = (int) $post_id;
 	if ( !$post_id )
 		return false;
 
-	$tags = wp_get_post_terms($post_id, $taxonomy, array());
+	$terms = get_object_term_cache( $post_id, $taxonomy );
+	if ( false === $terms ) {
+		$terms = wp_get_object_terms( $post_id, $taxonomy );
+		wp_cache_add( $post_id, $terms, $taxonomy . '_relationships' );
+	}
 
-	if ( !$tags )
+	if ( ! $terms ) {
 		return false;
+	}
+	if ( is_wp_error( $terms ) ) {
+		return $terms;
+	}
+	$term_names = array();
+	foreach ( $terms as $term ) {
+		$term_names[] = $term->name;
+	}
 
-	if ( is_wp_error($tags) )
-		return $tags;
-
-	foreach ( $tags as $tag )
-		$tag_names[] = $tag->name;
-	$tags_to_edit = join( ',', $tag_names );
-	$tags_to_edit = esc_attr( $tags_to_edit );
+	$terms_to_edit = esc_attr( join( ',', $term_names ) );
 
 	/**
 	 * Filter the comma-separated list of terms available to edit.
@@ -241,12 +263,12 @@ function get_terms_to_edit( $post_id, $taxonomy = 'post_tag' ) {
 	 *
 	 * @see get_terms_to_edit()
 	 *
-	 * @param array  $tags_to_edit An array of terms.
+	 * @param array  $terms_to_edit An array of terms.
 	 * @param string $taxonomy     The taxonomy for which to retrieve terms. Default 'post_tag'.
 	 */
-	$tags_to_edit = apply_filters( 'terms_to_edit', $tags_to_edit, $taxonomy );
+	$terms_to_edit = apply_filters( 'terms_to_edit', $terms_to_edit, $taxonomy );
 
-	return $tags_to_edit;
+	return $terms_to_edit;
 }
 
 /**
@@ -254,8 +276,8 @@ function get_terms_to_edit( $post_id, $taxonomy = 'post_tag' ) {
  *
  * @since 2.8.0
  *
- * @param unknown_type $tag_name
- * @return unknown
+ * @param int|string $tag_name
+ * @return array|WP_Error
  */
 function wp_create_term($tag_name, $taxonomy = 'post_tag') {
 	if ( $id = term_exists($tag_name, $taxonomy) )