]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/category-template.php
WordPress 3.7.1
[autoinstalls/wordpress.git] / wp-includes / category-template.php
index e45734abbbaf334f9bf4110af88325df3f09a333..57f7cb9ada00745255b6701a67efa00bb2b5d60e 100644 (file)
@@ -37,11 +37,11 @@ function get_category_link( $category ) {
  * @param string $separator Optional, default is '/'. How to separate categories.
  * @param bool $nicename Optional, default is false. Whether to use nice name for display.
  * @param array $visited Optional. Already linked to categories to prevent duplicates.
- * @return string
+ * @return string|WP_Error A list of category parents on success, WP_Error on failure.
  */
 function get_category_parents( $id, $link = false, $separator = '/', $nicename = false, $visited = array() ) {
        $chain = '';
-       $parent = get_category( $id );
+       $parent = get_term( $id, 'category' );
        if ( is_wp_error( $parent ) )
                return $parent;
 
@@ -131,11 +131,11 @@ function _usort_terms_by_ID( $a, $b ) {
  * @since 0.71
  *
  * @param int $cat_ID Category ID.
- * @return string Category name.
+ * @return string|WP_Error Category name on success, WP_Error on failure.
  */
 function get_the_category_by_ID( $cat_ID ) {
        $cat_ID = (int) $cat_ID;
-       $category = get_category( $cat_ID );
+       $category = get_term( $cat_ID, 'category' );
        if ( is_wp_error( $category ) )
                return $category;
        return $category->name;
@@ -225,6 +225,7 @@ function get_the_category_list( $separator = '', $parents='', $post_id = false )
  * As of 2.7, the function can be used anywhere if it is provided a post ID or post object.
  *
  * @since 1.2.0
+ * @uses has_category()
  *
  * @param int|string|array $category Category ID, name or slug, or array of said.
  * @param int|object $post Optional. Post to check instead of the current post. (since 2.7.0)
@@ -234,7 +235,7 @@ function in_category( $category, $post = null ) {
        if ( empty( $category ) )
                return false;
 
-       return has_term( $category, 'category', $post );
+       return has_category( $category, $post );
 }
 
 /**
@@ -467,7 +468,7 @@ function wp_list_categories( $args = '' ) {
 
                if ( empty( $r['current_category'] ) && ( is_category() || is_tax() || is_tag() ) ) {
                        $current_term_object = get_queried_object();
-                       if ( $r['taxonomy'] == $current_term_object->taxonomy )
+                       if ( $current_term_object && $r['taxonomy'] === $current_term_object->taxonomy )
                                $r['current_category'] = get_queried_object_id();
                }
 
@@ -671,7 +672,7 @@ function wp_generate_tag_cloud( $tags, $args = '' ) {
                $tag_link = '#' != $tag->link ? esc_url( $tag->link ) : '#';
                $tag_id = isset($tags[ $key ]->id) ? $tags[ $key ]->id : $key;
                $tag_name = $tags[ $key ]->name;
-               $a[] = "<a href='$tag_link' class='tag-link-$tag_id' title='" . esc_attr( call_user_func( $topic_count_text_callback, $real_count ) ) . "' style='font-size: " .
+               $a[] = "<a href='$tag_link' class='tag-link-$tag_id' title='" . esc_attr( call_user_func( $topic_count_text_callback, $real_count, $tag, $args ) ) . "' style='font-size: " .
                        str_replace( ',', '.', ( $smallest + ( ( $count - $min_count ) * $font_step ) ) )
                        . "$unit;'>$tag_name</a>";
        }
@@ -765,6 +766,8 @@ function walk_category_dropdown_tree() {
  */
 class Walker_Category extends Walker {
        /**
+        * What the class handles.
+        *
         * @see Walker::$tree_type
         * @since 2.1.0
         * @var string
@@ -772,6 +775,8 @@ class Walker_Category extends Walker {
        var $tree_type = 'category';
 
        /**
+        * Database fields to use.
+        *
         * @see Walker::$db_fields
         * @since 2.1.0
         * @todo Decouple this
@@ -780,12 +785,16 @@ class Walker_Category extends Walker {
        var $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
 
        /**
+        * Starts the list before the elements are added.
+        *
         * @see Walker::start_lvl()
+        *
         * @since 2.1.0
         *
         * @param string $output Passed by reference. Used to append additional content.
-        * @param int $depth Depth of category. Used for tab indentation.
-        * @param array $args Will only append content if style argument value is 'list'.
+        * @param int    $depth  Depth of category. Used for tab indentation.
+        * @param array  $args   An array of arguments. Will only append content if style argument value is 'list'.
+        *                       @see wp_list_categories()
         */
        function start_lvl( &$output, $depth = 0, $args = array() ) {
                if ( 'list' != $args['style'] )
@@ -796,12 +805,16 @@ class Walker_Category extends Walker {
        }
 
        /**
+        * Ends the list of after the elements are added.
+        *
         * @see Walker::end_lvl()
+        *
         * @since 2.1.0
         *
         * @param string $output Passed by reference. Used to append additional content.
-        * @param int $depth Depth of category. Used for tab indentation.
-        * @param array $args Will only append content if style argument value is 'list'.
+        * @param int    $depth  Depth of category. Used for tab indentation.
+        * @param array  $args   An array of arguments. Will only append content if style argument value is 'list'.
+        *                       @wsee wp_list_categories()
         */
        function end_lvl( &$output, $depth = 0, $args = array() ) {
                if ( 'list' != $args['style'] )
@@ -812,13 +825,17 @@ class Walker_Category extends Walker {
        }
 
        /**
+        * Start the element output.
+        *
         * @see Walker::start_el()
+        *
         * @since 2.1.0
         *
-        * @param string $output Passed by reference. Used to append additional content.
+        * @param string $output   Passed by reference. Used to append additional content.
         * @param object $category Category data object.
-        * @param int $depth Depth of category in reference to parents.
-        * @param array $args
+        * @param int    $depth    Depth of category in reference to parents. Default 0.
+        * @param array  $args     An array of arguments. @see wp_list_categories()
+        * @param int    $id       ID of the current category.
         */
        function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
                extract($args);
@@ -884,13 +901,16 @@ class Walker_Category extends Walker {
        }
 
        /**
+        * Ends the element output, if needed.
+        *
         * @see Walker::end_el()
+        *
         * @since 2.1.0
         *
         * @param string $output Passed by reference. Used to append additional content.
-        * @param object $page Not used.
-        * @param int $depth Depth of category. Not used.
-        * @param array $args Only uses 'list' for whether should append to output.
+        * @param object $page   Not used.
+        * @param int    $depth  Depth of category. Not used.
+        * @param array  $args   An array of arguments. Only uses 'list' for whether should append to output. @see wp_list_categories()
         */
        function end_el( &$output, $page, $depth = 0, $args = array() ) {
                if ( 'list' != $args['style'] )
@@ -925,15 +945,17 @@ class Walker_CategoryDropdown extends Walker {
        var $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
 
        /**
+        * Start the element output.
+        *
         * @see Walker::start_el()
         * @since 2.1.0
         *
-        * @param string $output Passed by reference. Used to append additional content.
+        * @param string $output   Passed by reference. Used to append additional content.
         * @param object $category Category data object.
-        * @param int $depth Depth of category. Used for padding.
-        * @param array $args Uses 'selected' and 'show_count' keys, if they exist.
+        * @param int    $depth    Depth of category. Used for padding.
+        * @param array  $args     Uses 'selected' and 'show_count' keys, if they exist. @see wp_dropdown_categories()
         */
-       function start_el( &$output, $category, $depth, $args, $id = 0 ) {
+       function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
                $pad = str_repeat('&nbsp;', $depth * 3);
 
                $cat_name = apply_filters('list_cats', $category->name, $category);
@@ -980,7 +1002,7 @@ function get_tag_link( $tag ) {
  * @uses apply_filters() Calls 'get_the_tags' filter on the list of post tags.
  *
  * @param int $id Post ID.
- * @return array
+ * @return array|bool Array of tag objects on success, false on failure.
  */
 function get_the_tags( $id = 0 ) {
        return apply_filters( 'get_the_tags', get_the_terms( $id, 'post_tag' ) );
@@ -996,7 +1018,7 @@ function get_the_tags( $id = 0 ) {
  * @param string $sep Optional. Between tags.
  * @param string $after Optional. After tags.
  * @param int $id Optional. Post ID. Defaults to the current post.
- * @return string
+ * @return string|bool|WP_Error A list of tags on success, false or WP_Error on failure.
  */
 function get_the_tag_list( $before = '', $sep = '', $after = '', $id = 0 ) {
        return apply_filters( 'the_tags', get_the_term_list( $id, 'post_tag', $before, $sep, $after ), $before, $sep, $after, $id );
@@ -1010,7 +1032,6 @@ function get_the_tag_list( $before = '', $sep = '', $after = '', $id = 0 ) {
  * @param string $before Optional. Before list.
  * @param string $sep Optional. Separate items using this.
  * @param string $after Optional. After list.
- * @return string
  */
 function the_tags( $before = null, $sep = ', ', $after = '' ) {
        if ( null === $before )
@@ -1040,10 +1061,12 @@ function tag_description( $tag = 0 ) {
  * @return string Term description, available.
  */
 function term_description( $term = 0, $taxonomy = 'post_tag' ) {
-       if ( !$term && ( is_tax() || is_tag() || is_category() ) ) {
+       if ( ! $term && ( is_tax() || is_tag() || is_category() ) ) {
                $term = get_queried_object();
-               $taxonomy = $term->taxonomy;
-               $term = $term->term_id;
+               if ( $term ) {
+                       $taxonomy = $term->taxonomy;
+                       $term = $term->term_id;
+               }
        }
        $description = get_term_field( 'description', $term, $taxonomy );
        return is_wp_error( $description ) ? '' : $description;
@@ -1054,9 +1077,9 @@ function term_description( $term = 0, $taxonomy = 'post_tag' ) {
  *
  * @since 2.5.0
  *
- * @param mixed $post Post ID or object.
+ * @param int|object $post Post ID or object.
  * @param string $taxonomy Taxonomy name.
- * @return array|bool False on failure. Array of term objects on success.
+ * @return array|bool|WP_Error Array of term objects on success, false or WP_Error on failure.
  */
 function get_the_terms( $post, $taxonomy ) {
        if ( ! $post = get_post( $post ) )
@@ -1086,7 +1109,7 @@ function get_the_terms( $post, $taxonomy ) {
  * @param string $before Optional. Before list.
  * @param string $sep Optional. Separate items using this.
  * @param string $after Optional. After list.
- * @return string
+ * @return string|bool|WP_Error A list of terms on success, false or WP_Error on failure.
  */
 function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' ) {
        $terms = get_the_terms( $id, $taxonomy );