]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/category.php
WordPress 4.6.2
[autoinstalls/wordpress.git] / wp-includes / category.php
index 6bf7bac6c0f6e07e3803036ac6f666febc0f064b..08d18c0a657b72f26217eb5e7d5d019bc237ea3f 100644 (file)
@@ -1,39 +1,26 @@
 <?php
 /**
- * WordPress Category API
+ * Taxonomy API: Core category-specific functionality
  *
  * @package WordPress
+ * @subpackage Taxonomy
  */
 
-/**
- * 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.
  *
  * If you change the type to 'link' in the arguments, then the link categories
- * will be returned instead. Also all categories will be updated to be backwards
+ * will be returned instead. Also all categories will be updated to be backward
  * compatible with pre-2.3 plugins and themes.
  *
  * @since 2.1.0
  * @see get_terms() Type of arguments that can be changed.
- * @link http://codex.wordpress.org/Function_Reference/get_categories
  *
- * @param string|array $args Optional. Change the defaults retrieving categories.
+ * @param string|array $args {
+ *     Optional. Arguments to retrieve categories. See get_terms() for additional options.
+ *
+ *     @type string $taxonomy Taxonomy to retrieve terms for. In this case, default 'category'.
+ * }
  * @return array List of categories.
  */
 function get_categories( $args = '' ) {
@@ -41,26 +28,39 @@ function get_categories( $args = '' ) {
        $args = wp_parse_args( $args, $defaults );
 
        $taxonomy = $args['taxonomy'];
+
        /**
-        * Filter the taxonomy used to retrieve terms when calling get_categories().
+        * Filters 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()
+        * @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'] ) {
-               _deprecated_argument( __FUNCTION__, '3.0', '' );
+               /* translators: 1: "type => link", 2: "taxonomy => link_category" alternative */
+               _deprecated_argument( __FUNCTION__, '3.0.0',
+                       sprintf( __( '%1$s is deprecated. Use %2$s instead.' ),
+                               '<code>type => link</code>',
+                               '<code>taxonomy => link_category</code>'
+                       )
+               );
                $taxonomy = $args['taxonomy'] = 'link_category';
        }
 
-       $categories = (array) get_terms( $taxonomy, $args );
+       $categories = get_terms( $taxonomy, $args );
 
-       foreach ( array_keys( $categories ) as $k )
-               _make_cat_compat( $categories[$k] );
+       if ( is_wp_error( $categories ) ) {
+               $categories = array();
+       } else {
+               $categories = (array) $categories;
+               foreach ( array_keys( $categories ) as $k ) {
+                       _make_cat_compat( $categories[ $k ] );
+               }
+       }
 
        return $categories;
 }
@@ -77,18 +77,19 @@ function get_categories( $args = '' ) {
  * If you look at get_term(), then both types will be passed through several
  * filters and finally sanitized based on the $filter parameter value.
  *
- * The category will converted to maintain backwards compatibility.
+ * The category will converted to maintain backward compatibility.
  *
  * @since 1.5.1
- * @uses get_term() Used to get the category data from the taxonomy.
  *
  * @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' ) {
        $category = get_term( $category, 'category', $output, $filter );
+
        if ( is_wp_error( $category ) )
                return $category;
 
@@ -114,7 +115,7 @@ function get_category( $category, $output = OBJECT, $filter = 'raw' ) {
  * @param string $category_path URL containing category slugs.
  * @param bool $full_match Optional. Whether full path should be matched.
  * @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
- * @return null|object|array Null on failure. Type is based on $output value.
+ * @return object|array|WP_Error|void Type is based on $output value.
  */
 function get_category_by_path( $category_path, $full_match = true, $output = OBJECT ) {
        $category_path = rawurlencode( urldecode( $category_path ) );
@@ -124,21 +125,23 @@ function get_category_by_path( $category_path, $full_match = true, $output = OBJ
        $leaf_path  = sanitize_title( basename( $category_paths ) );
        $category_paths = explode( '/', $category_paths );
        $full_path = '';
-       foreach ( (array) $category_paths as $pathdir )
+       foreach ( (array) $category_paths as $pathdir ) {
                $full_path .= ( $pathdir != '' ? '/' : '' ) . sanitize_title( $pathdir );
-
+       }
        $categories = get_terms( 'category', array('get' => 'all', 'slug' => $leaf_path) );
 
-       if ( empty( $categories ) )
-               return null;
+       if ( empty( $categories ) ) {
+               return;
+       }
 
        foreach ( $categories as $category ) {
                $path = '/' . $leaf_path;
                $curcategory = $category;
                while ( ( $curcategory->parent != 0 ) && ( $curcategory->parent != $curcategory->term_id ) ) {
                        $curcategory = get_term( $curcategory->parent, 'category' );
-                       if ( is_wp_error( $curcategory ) )
+                       if ( is_wp_error( $curcategory ) ) {
                                return $curcategory;
+                       }
                        $path = '/' . $curcategory->slug . $path;
                }
 
@@ -155,8 +158,6 @@ function get_category_by_path( $category_path, $full_match = true, $output = OBJ
                _make_cat_compat( $category );
                return $category;
        }
-
-       return null;
 }
 
 /**
@@ -226,7 +227,6 @@ function cat_is_ancestor_of( $cat1, $cat2 ) {
  * Sanitizes category data based on context.
  *
  * @since 2.3.0
- * @uses sanitize_term() See this function for what context are supported.
  *
  * @param object|array $category Category data
  * @param string $context Optional. Default is 'display'.
@@ -240,7 +240,6 @@ function sanitize_category( $category, $context = 'display' ) {
  * Sanitizes data in single category key field.
  *
  * @since 2.3.0
- * @uses sanitize_term_field() See function for more details.
  *
  * @param string $field Category key to sanitize
  * @param mixed $value Category value to sanitize
@@ -259,7 +258,6 @@ function sanitize_category_field( $field, $value, $cat_id, $context ) {
  *
  * @since 2.3.0
  * @see get_terms() For list of arguments to pass.
- * @uses apply_filters() Calls 'get_tags' hook on array of tags and with $args.
  *
  * @param string|array $args Tag arguments to use when retrieving tags.
  * @return array List of tags.
@@ -273,7 +271,7 @@ function get_tags( $args = '' ) {
        }
 
        /**
-        * Filter the array of term objects returned for the 'post_tag' taxonomy.
+        * Filters the array of term objects returned for the 'post_tag' taxonomy.
         *
         * @since 2.3.0
         *
@@ -301,7 +299,7 @@ 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' ) {
        return get_term( $tag, 'post_tag', $output, $filter );
@@ -313,7 +311,6 @@ function get_tag( $tag, $output = OBJECT, $filter = 'raw' ) {
  * Remove the category cache data based on ID.
  *
  * @since 2.1.0
- * @uses clean_term_cache() Clears the cache for the category based on ID
  *
  * @param int $id Category ID
  */
@@ -336,18 +333,19 @@ function clean_category_cache( $id ) {
  * pass to it. This is one of the features with using pass by reference in PHP.
  *
  * @since 2.3.0
+ * @since 4.4.0 The `$category` parameter now also accepts a WP_Term object.
  * @access private
  *
- * @param array|object $category Category Row object or array
+ * @param array|object|WP_Term $category Category Row object or array
  */
 function _make_cat_compat( &$category ) {
-       if ( is_object( $category ) ) {
-               $category->cat_ID = &$category->term_id;
-               $category->category_count = &$category->count;
-               $category->category_description = &$category->description;
-               $category->cat_name = &$category->name;
-               $category->category_nicename = &$category->slug;
-               $category->category_parent = &$category->parent;
+       if ( is_object( $category ) && ! is_wp_error( $category ) ) {
+               $category->cat_ID = $category->term_id;
+               $category->category_count = $category->count;
+               $category->category_description = $category->description;
+               $category->cat_name = $category->name;
+               $category->category_nicename = $category->slug;
+               $category->category_parent = $category->parent;
        } elseif ( is_array( $category ) && isset( $category['term_id'] ) ) {
                $category['cat_ID'] = &$category['term_id'];
                $category['category_count'] = &$category['count'];