WordPress 4.0

[autoinstalls/wordpress.git] / wp-includes / category.php

diff --git a/wp-includes/category.php b/wp-includes/category.php
index 17283d01a9186b587bce76b76e7fb25d992a5a50..fddaa6f66d43b9b7bef57666b071260c3eda5d88 100644 (file)
--- a/wp-includes/category.php
+++ b/wp-includes/category.php
@@ -5,23 +5,6 @@
  * @package WordPress
  */
 
-/**
- * Retrieves all category IDs.
- *
- * @since 2.0.0
- * @link http://codex.wordpress.org/Function_Reference/get_all_category_ids
- *
- * @return object List of all of the category IDs.
- */
-function get_all_category_ids() {
-       if ( ! $cat_ids = wp_cache_get( 'all_category_ids', 'category' ) ) {
-               $cat_ids = get_terms( 'category', array('fields' => 'ids', 'get' => 'all') );
-               wp_cache_add( 'all_category_ids', $cat_ids, 'category' );
-       }
-
-       return $cat_ids;
-}
-
 /**
  * Retrieve list of category objects.
  *
@@ -36,11 +19,20 @@ function get_all_category_ids() {
  * @param string|array $args Optional. Change the defaults retrieving categories.
  * @return array List of categories.
  */
-function &get_categories( $args = '' ) {
+function get_categories( $args = '' ) {
        $defaults = array( 'taxonomy' => 'category' );
        $args = wp_parse_args( $args, $defaults );
 
-       $taxonomy = apply_filters( 'get_categories_taxonomy', $args['taxonomy'], $args );
+       $taxonomy = $args['taxonomy'];
+       /**
+        * Filter the taxonomy used to retrieve terms when calling get_categories().
+        *
+        * @since 2.7.0
+        *
+        * @param string $taxonomy Taxonomy to retrieve terms from.
+        * @param array  $args     An array of arguments. @see get_terms()
+        */
+       $taxonomy = apply_filters( 'get_categories_taxonomy', $taxonomy, $args );
 
        // Back compat
        if ( isset($args['type']) && 'link' == $args['type'] ) {
@@ -76,10 +68,11 @@ function &get_categories( $args = '' ) {
  * @param int|object $category Category ID or Category row object
  * @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
  * @param string $filter Optional. Default is raw or no WordPress defined filter will applied.
- * @return mixed Category data in type defined by $output parameter.
+ * @return object|array|WP_Error|null Category data in type defined by $output parameter. WP_Error if $category is empty, null if it does not exist.
  */
-function &get_category( $category, $output = OBJECT, $filter = 'raw' ) {
+function get_category( $category, $output = OBJECT, $filter = 'raw' ) {
        $category = get_term( $category, 'category', $output, $filter );
+
        if ( is_wp_error( $category ) )
                return $category;
 
@@ -133,13 +126,19 @@ function get_category_by_path( $category_path, $full_match = true, $output = OBJ
                        $path = '/' . $curcategory->slug . $path;
                }
 
-               if ( $path == $full_path )
-                       return get_category( $category->term_id, $output );
+               if ( $path == $full_path ) {
+                       $category = get_term( $category->term_id, 'category', $output );
+                       _make_cat_compat( $category );
+                       return $category;
+               }
        }
 
        // If full matching is not required, return the first cat that matches the leaf.
-       if ( ! $full_match )
-               return get_category( $categories[0]->term_id, $output );
+       if ( ! $full_match ) {
+               $category = get_term( reset( $categories )->term_id, 'category', $output );
+               _make_cat_compat( $category );
+               return $category;
+       }
 
        return null;
 }
@@ -165,10 +164,10 @@ function get_category_by_slug( $slug  ) {
  *
  * @since 1.0.0
  *
- * @param string $cat_name Optional. Default is 'General' and can be any category name.
+ * @param string $cat_name Category name.
  * @return int 0, if failure and ID of category on success.
  */
-function get_cat_ID( $cat_name='General' ) {
+function get_cat_ID( $cat_name ) {
        $cat = get_term_by( 'name', $cat_name, 'category' );
        if ( $cat )
                return $cat->term_id;
@@ -185,7 +184,7 @@ function get_cat_ID( $cat_name='General' ) {
  */
 function get_cat_name( $cat_id ) {
        $cat_id = (int) $cat_id;
-       $category = &get_category( $cat_id );
+       $category = get_term( $cat_id, 'category' );
        if ( ! $category || is_wp_error( $category ) )
                return '';
        return $category->name;
@@ -249,7 +248,7 @@ function sanitize_category_field( $field, $value, $cat_id, $context ) {
  * @param string|array $args Tag arguments to use when retrieving tags.
  * @return array List of tags.
  */
-function &get_tags( $args = '' ) {
+function get_tags( $args = '' ) {
        $tags = get_terms( 'post_tag', $args );
 
        if ( empty( $tags ) ) {
@@ -257,6 +256,14 @@ function &get_tags( $args = '' ) {
                return $return;
        }
 
+       /**
+        * Filter the array of term objects returned for the 'post_tag' taxonomy.
+        *
+        * @since 2.3.0
+        *
+        * @param array $tags Array of 'post_tag' term objects.
+        * @param array $args An array of arguments. @see get_terms()
+        */
        $tags = apply_filters( 'get_tags', $tags, $args );
        return $tags;
 }
@@ -278,9 +285,9 @@ function &get_tags( $args = '' ) {
  * @param int|object $tag
  * @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
  * @param string $filter Optional. Default is raw or no WordPress defined filter will applied.
- * @return object|array Return type based on $output value.
+ * @return object|array|WP_Error|null Tag data in type defined by $output parameter. WP_Error if $tag is empty, null if it does not exist.
  */
-function &get_tag( $tag, $output = OBJECT, $filter = 'raw' ) {
+function get_tag( $tag, $output = OBJECT, $filter = 'raw' ) {
        return get_term( $tag, 'post_tag', $output, $filter );
 }