2004-01-27 09:58:01 +00:00
< ? php
2008-09-25 14:16:27 +00:00
/**
* Category Template Tags and API .
*
* @ package WordPress
* @ subpackage Template
*/
2004-01-27 09:58:01 +00:00
2008-09-25 14:16:27 +00:00
/**
* Retrieve category children list separated before and after the term IDs .
*
* @ since 1.2 . 0
*
* @ param int $id Category ID to retrieve children .
* @ param string $before Optional . Prepend before category term ID .
* @ param string $after Optional , default is empty string . Append after category term ID .
* @ param array $visited Optional . Category Term IDs that have already been added .
* @ return string
*/
2008-08-06 21:01:46 +00:00
function get_category_children ( $id , $before = '/' , $after = '' , $visited = array () ) {
2006-06-04 21:36:52 +00:00
if ( 0 == $id )
return '' ;
2006-10-03 15:41:44 +00:00
$chain = '' ;
2008-09-25 14:16:27 +00:00
/** TODO: consult hierarchy */
2006-06-04 21:36:52 +00:00
$cat_ids = get_all_category_ids ();
2008-08-06 20:31:54 +00:00
foreach ( ( array ) $cat_ids as $cat_id ) {
2007-05-23 18:59:12 +00:00
if ( $cat_id == $id )
2006-06-04 21:36:52 +00:00
continue ;
2008-08-06 21:01:46 +00:00
$category = get_category ( $cat_id );
2007-09-18 16:32:22 +00:00
if ( is_wp_error ( $category ) )
return $category ;
2008-08-06 21:01:46 +00:00
if ( $category -> parent == $id && ! in_array ( $category -> term_id , $visited ) ) {
2008-07-09 04:57:18 +00:00
$visited [] = $category -> term_id ;
2007-05-23 18:07:53 +00:00
$chain .= $before . $category -> term_id . $after ;
2008-08-06 21:01:46 +00:00
$chain .= get_category_children ( $category -> term_id , $before , $after );
2006-06-04 21:36:52 +00:00
}
}
return $chain ;
2006-04-13 04:40:48 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Retrieve category link URL .
*
* @ since 1.0 . 0
* @ uses apply_filters () Calls 'category_link' filter on category link and category ID .
*
* @ param int $category_id Category ID .
* @ return string
*/
2008-08-06 21:01:46 +00:00
function get_category_link ( $category_id ) {
2006-06-04 21:36:52 +00:00
global $wp_rewrite ;
$catlink = $wp_rewrite -> get_category_permastruct ();
2008-08-06 21:01:46 +00:00
if ( empty ( $catlink ) ) {
$file = get_option ( 'home' ) . '/' ;
2006-06-04 21:36:52 +00:00
$catlink = $file . '?cat=' . $category_id ;
} else {
2008-08-06 21:01:46 +00:00
$category = & get_category ( $category_id );
2007-09-18 16:32:22 +00:00
if ( is_wp_error ( $category ) )
return $category ;
2007-05-23 18:07:53 +00:00
$category_nicename = $category -> slug ;
2006-06-04 21:36:52 +00:00
2008-11-02 20:53:15 +00:00
if ( $category -> parent == $category_id ) // recursive recursion
2008-10-26 18:26:45 +00:00
$category -> parent = 0 ;
2008-11-10 21:57:26 +00:00
elseif ( $category -> parent != 0 )
$category_nicename = get_category_parents ( $category -> parent , false , '/' , true ) . $category_nicename ;
2006-06-04 21:36:52 +00:00
2008-08-06 21:01:46 +00:00
$catlink = str_replace ( '%category%' , $category_nicename , $catlink );
$catlink = get_option ( 'home' ) . user_trailingslashit ( $catlink , 'category' );
2006-06-04 21:36:52 +00:00
}
2008-08-06 21:01:46 +00:00
return apply_filters ( 'category_link' , $catlink , $category_id );
2006-06-04 21:36:52 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Retrieve category parents with separator .
*
* @ since 1.2 . 0
*
* @ param int $id Category ID .
* @ param bool $link Optional , default is false . Whether to format with link .
* @ 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
*/
function get_category_parents ( $id , $link = false , $separator = '/' , $nicename = false , $visited = array () ) {
2006-06-04 21:36:52 +00:00
$chain = '' ;
2008-08-06 21:01:46 +00:00
$parent = & get_category ( $id );
2007-09-18 16:32:22 +00:00
if ( is_wp_error ( $parent ) )
return $parent ;
2006-06-04 21:36:52 +00:00
if ( $nicename )
2007-05-23 18:07:53 +00:00
$name = $parent -> slug ;
2006-06-04 21:36:52 +00:00
else
$name = $parent -> cat_name ;
2008-08-06 21:01:46 +00:00
if ( $parent -> parent && ( $parent -> parent != $parent -> term_id ) && ! in_array ( $parent -> parent , $visited ) ) {
2008-07-09 04:57:18 +00:00
$visited [] = $parent -> parent ;
2008-08-06 21:01:46 +00:00
$chain .= get_category_parents ( $parent -> parent , $link , $separator , $nicename , $visited );
2008-07-09 04:57:18 +00:00
}
2006-06-04 21:36:52 +00:00
if ( $link )
2008-08-06 21:01:46 +00:00
$chain .= '<a href="' . get_category_link ( $parent -> term_id ) . '" title="' . sprintf ( __ ( " View all posts in %s " ), $parent -> cat_name ) . '">' . $name . '</a>' . $separator ;
2006-06-04 21:36:52 +00:00
else
$chain .= $name . $separator ;
return $chain ;
2006-04-13 04:40:48 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Retrieve post categories .
*
* @ since 0.71
* @ uses $post
*
* @ param int $id Optional , default to current post ID . The post ID .
* @ return array
*/
2008-08-06 21:01:46 +00:00
function get_the_category ( $id = false ) {
2008-01-04 19:36:34 +00:00
global $post ;
2004-06-04 02:36:46 +00:00
2007-03-22 20:52:29 +00:00
$id = ( int ) $id ;
2005-03-01 09:10:12 +00:00
if ( ! $id )
2007-03-23 02:16:16 +00:00
$id = ( int ) $post -> ID ;
2004-06-04 02:36:46 +00:00
2008-08-06 21:01:46 +00:00
$categories = get_object_term_cache ( $id , 'category' );
2008-11-25 22:12:36 +00:00
if ( false === $categories ) {
2008-08-06 21:01:46 +00:00
$categories = wp_get_object_terms ( $id , 'category' );
2008-11-26 01:06:25 +00:00
wp_cache_add ( $id , $categories , 'category_relationships' );
2008-11-25 22:12:36 +00:00
}
2004-11-12 23:08:51 +00:00
2008-08-06 21:01:46 +00:00
if ( ! empty ( $categories ) )
usort ( $categories , '_usort_terms_by_name' );
2005-03-01 09:10:12 +00:00
else
$categories = array ();
2004-11-15 06:00:21 +00:00
2008-08-06 21:01:46 +00:00
foreach ( ( array ) array_keys ( $categories ) as $key ) {
_make_cat_compat ( $categories [ $key ] );
2007-08-18 17:21:51 +00:00
}
2005-03-01 09:10:12 +00:00
return $categories ;
2004-01-27 09:58:01 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Sort categories by name .
*
* Used by usort () as a callback , should not be used directly . Can actually be
* used to sort any term object .
*
* @ since 2.3 . 0
* @ access private
*
* @ param object $a
* @ param object $b
* @ return int
*/
2008-08-06 21:01:46 +00:00
function _usort_terms_by_name ( $a , $b ) {
return strcmp ( $a -> name , $b -> name );
2007-05-29 04:54:45 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Sort categories by ID .
*
* Used by usort () as a callback , should not be used directly . Can actually be
* used to sort any term object .
*
* @ since 2.3 . 0
* @ access private
*
* @ param object $a
* @ param object $b
* @ return int
*/
2008-08-06 21:01:46 +00:00
function _usort_terms_by_ID ( $a , $b ) {
2007-09-03 23:32:58 +00:00
if ( $a -> term_id > $b -> term_id )
return 1 ;
elseif ( $a -> term_id < $b -> term_id )
return - 1 ;
else
return 0 ;
2007-02-21 02:13:47 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Retrieve category name based on category ID .
*
* @ since 0.71
*
* @ param int $cat_ID Category ID .
* @ return string Category name .
*/
2008-08-06 21:01:46 +00:00
function get_the_category_by_ID ( $cat_ID ) {
2006-06-04 21:36:52 +00:00
$cat_ID = ( int ) $cat_ID ;
2008-08-06 21:01:46 +00:00
$category = & get_category ( $cat_ID );
2007-09-18 16:32:22 +00:00
if ( is_wp_error ( $category ) )
return $category ;
2007-05-23 18:07:53 +00:00
return $category -> name ;
2004-01-27 09:58:01 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Retrieve category list in either HTML list or custom format .
*
* @ since 1.5 . 1
*
* @ param string $separator Optional , default is empty string . Separator for between the categories .
* @ param string $parents Optional . How to display the parents .
* @ param int $post_id Optional . Post ID to retrieve categories .
* @ return string
*/
2008-08-06 21:01:46 +00:00
function get_the_category_list ( $separator = '' , $parents = '' , $post_id = false ) {
2007-01-23 08:21:28 +00:00
global $wp_rewrite ;
2008-08-06 21:01:46 +00:00
$categories = get_the_category ( $post_id );
if ( empty ( $categories ) )
return apply_filters ( 'the_category' , __ ( 'Uncategorized' ), $separator , $parents );
2005-10-12 17:01:50 +00:00
2008-08-06 21:01:46 +00:00
$rel = ( is_object ( $wp_rewrite ) && $wp_rewrite -> using_permalinks () ) ? 'rel="category tag"' : 'rel="category"' ;
2007-01-23 08:21:28 +00:00
2005-10-12 17:01:50 +00:00
$thelist = '' ;
if ( '' == $separator ) {
$thelist .= '<ul class="post-categories">' ;
foreach ( $categories as $category ) {
$thelist .= " \n \t <li> " ;
2008-08-06 21:01:46 +00:00
switch ( strtolower ( $parents ) ) {
2005-10-12 17:01:50 +00:00
case 'multiple' :
2008-08-06 21:01:46 +00:00
if ( $category -> parent )
2008-10-15 21:02:07 +00:00
$thelist .= get_category_parents ( $category -> parent , true , $separator );
2008-08-06 21:01:46 +00:00
$thelist .= '<a href="' . get_category_link ( $category -> term_id ) . '" title="' . sprintf ( __ ( " View all posts in %s " ), $category -> name ) . '" ' . $rel . '>' . $category -> name . '</a></li>' ;
2005-10-12 17:01:50 +00:00
break ;
case 'single' :
2008-08-06 21:01:46 +00:00
$thelist .= '<a href="' . get_category_link ( $category -> term_id ) . '" title="' . sprintf ( __ ( " View all posts in %s " ), $category -> name ) . '" ' . $rel . '>' ;
if ( $category -> parent )
2008-10-15 21:02:07 +00:00
$thelist .= get_category_parents ( $category -> parent , false , $separator );
2007-05-23 18:07:53 +00:00
$thelist .= $category -> name . '</a></li>' ;
2005-10-12 17:01:50 +00:00
break ;
case '' :
default :
2008-08-06 21:01:46 +00:00
$thelist .= '<a href="' . get_category_link ( $category -> term_id ) . '" title="' . sprintf ( __ ( " View all posts in %s " ), $category -> name ) . '" ' . $rel . '>' . $category -> cat_name . '</a></li>' ;
2005-10-12 17:01:50 +00:00
}
}
$thelist .= '</ul>' ;
} else {
$i = 0 ;
foreach ( $categories as $category ) {
if ( 0 < $i )
$thelist .= $separator . ' ' ;
2008-08-06 21:01:46 +00:00
switch ( strtolower ( $parents ) ) {
2005-10-12 17:01:50 +00:00
case 'multiple' :
2007-05-23 18:07:53 +00:00
if ( $category -> parent )
2008-10-15 21:02:07 +00:00
$thelist .= get_category_parents ( $category -> parent , true , $separator );
2008-08-06 21:01:46 +00:00
$thelist .= '<a href="' . get_category_link ( $category -> term_id ) . '" title="' . sprintf ( __ ( " View all posts in %s " ), $category -> name ) . '" ' . $rel . '>' . $category -> cat_name . '</a>' ;
2005-10-12 17:01:50 +00:00
break ;
case 'single' :
2008-08-06 21:01:46 +00:00
$thelist .= '<a href="' . get_category_link ( $category -> term_id ) . '" title="' . sprintf ( __ ( " View all posts in %s " ), $category -> name ) . '" ' . $rel . '>' ;
2007-05-23 18:07:53 +00:00
if ( $category -> parent )
2008-10-15 21:02:07 +00:00
$thelist .= get_category_parents ( $category -> parent , false , $separator );
2005-10-12 17:01:50 +00:00
$thelist .= " $category->cat_name </a> " ;
break ;
case '' :
default :
2008-08-06 21:01:46 +00:00
$thelist .= '<a href="' . get_category_link ( $category -> term_id ) . '" title="' . sprintf ( __ ( " View all posts in %s " ), $category -> name ) . '" ' . $rel . '>' . $category -> name . '</a>' ;
2005-10-12 17:01:50 +00:00
}
++ $i ;
}
}
2008-08-06 21:01:46 +00:00
return apply_filters ( 'the_category' , $thelist , $separator , $parents );
2005-02-25 15:50:55 +00:00
}
2008-12-09 23:31:11 +00:00
2008-09-25 14:16:27 +00:00
/**
2008-12-09 23:31:11 +00:00
* Check if the current post in within any of the given categories .
*
* The given categories are checked against the post 's categories' term_ids , names and slugs .
* Categories given as integers will only be checked against the post 's categories' term_ids .
2008-03-02 20:17:30 +00:00
*
2008-12-09 23:31:11 +00:00
* Prior to v2 . 5 of WordPress , category names were not supported .
* Prior to v2 . 7 , category slugs were not supported .
* Prior to v2 . 7 , only one category could be compared : in_category ( $single_category ) .
* Prior to v2 . 7 , this function could only be used in the WordPress Loop .
* As of 2.7 , the function can be used anywhere if it is provided a post ID or post object .
2008-03-02 20:17:30 +00:00
*
* @ since 1.2 . 0
*
2008-12-09 23:31:11 +00:00
* @ uses is_object_in_term ()
*
* @ param int | string | array $category . Category ID , name or slug , or array of said .
* @ param int | post object Optional . Post to check instead of the current post . @ since 2.7 . 0
* @ return bool True if the current post is in any of the given categories .
*/
function in_category ( $category , $_post = null ) {
2008-08-06 21:01:46 +00:00
if ( empty ( $category ) )
2008-03-24 20:39:05 +00:00
return false ;
2008-12-09 23:31:11 +00:00
if ( $_post ) {
$_post = get_post ( $_post );
} else {
$_post =& $GLOBALS [ 'post' ];
2008-10-22 21:31:55 +00:00
}
2008-12-09 23:31:11 +00:00
if ( ! $_post )
2006-06-04 21:36:52 +00:00
return false ;
2008-12-09 18:03:31 +00:00
2008-12-09 23:31:11 +00:00
$r = is_object_in_term ( $_post -> ID , 'category' , $category );
if ( is_wp_error ( $r ) )
return false ;
return $r ;
2004-01-27 09:58:01 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Display the category list for the post .
*
* @ since 0.71
*
* @ param string $separator Optional , default is empty string . Separator for between the categories .
* @ param string $parents Optional . How to display the parents .
* @ param int $post_id Optional . Post ID to retrieve categories .
*/
2008-08-06 21:01:46 +00:00
function the_category ( $separator = '' , $parents = '' , $post_id = false ) {
echo get_the_category_list ( $separator , $parents , $post_id );
2004-01-27 09:58:01 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Retrieve category description .
*
* @ since 1.0 . 0
*
* @ param int $category Optional . Category ID . Will use global category ID by default .
* @ return string Category description , available .
*/
2008-08-06 21:01:46 +00:00
function category_description ( $category = 0 ) {
2005-10-12 17:01:50 +00:00
global $cat ;
if ( ! $category )
$category = $cat ;
2007-06-06 16:13:12 +00:00
2008-08-06 21:01:46 +00:00
return get_term_field ( 'description' , $category , 'category' );
2004-01-27 09:58:01 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Display or retrieve the HTML dropdown list of categories .
*
* The list of arguments is below :
* 'show_option_all' ( string ) - Text to display for showing all categories .
* 'show_option_none' ( string ) - Text to display for showing no categories .
* 'orderby' ( string ) default is 'ID' - What column to use for ordering the
* categories .
* 'order' ( string ) default is 'ASC' - What direction to order categories .
* 'show_last_update' ( bool | int ) default is 0 - See { @ link get_categories ()}
* 'show_count' ( bool | int ) default is 0 - Whether to show how many posts are
* in the category .
* 'hide_empty' ( bool | int ) default is 1 - Whether to hide categories that
* don ' t have any posts attached to them .
* 'child_of' ( int ) default is 0 - See { @ link get_categories ()} .
* 'exclude' ( string ) - See { @ link get_categories ()} .
* 'echo' ( bool | int ) default is 1 - Whether to display or retrieve content .
* 'depth' ( int ) - The max depth .
* 'tab_index' ( int ) - Tab index for select element .
* 'name' ( string ) - The name attribute value for selected element .
* 'class' ( string ) - The class attribute value for selected element .
* 'selected' ( int ) - Which category ID is selected .
*
* The 'hierarchical' argument , which is disabled by default , will override the
* depth argument , unless it is true . When the argument is false , it will
* display all of the categories . When it is enabled it will use the value in
* the 'depth' argument .
*
* @ since 2.1 . 0
*
* @ param string | array $args Optional . Override default arguments .
* @ return string HTML content only if 'echo' argument is 0.
*/
2008-08-06 21:01:46 +00:00
function wp_dropdown_categories ( $args = '' ) {
2007-05-11 03:10:05 +00:00
$defaults = array (
2007-09-03 23:32:58 +00:00
'show_option_all' => '' , 'show_option_none' => '' ,
'orderby' => 'ID' , 'order' => 'ASC' ,
'show_last_update' => 0 , 'show_count' => 0 ,
'hide_empty' => 1 , 'child_of' => 0 ,
'exclude' => '' , 'echo' => 1 ,
'selected' => 0 , 'hierarchical' => 0 ,
2008-01-30 20:07:52 +00:00
'name' => 'cat' , 'class' => 'postform' ,
2008-03-22 09:14:49 +00:00
'depth' => 0 , 'tab_index' => 0
2007-05-11 03:10:05 +00:00
);
2007-06-14 02:25:30 +00:00
2008-08-06 21:01:46 +00:00
$defaults [ 'selected' ] = ( is_category () ) ? get_query_var ( 'cat' ) : 0 ;
2007-06-14 02:25:30 +00:00
2007-05-11 03:10:05 +00:00
$r = wp_parse_args ( $args , $defaults );
2006-03-02 04:51:24 +00:00
$r [ 'include_last_update_time' ] = $r [ 'show_last_update' ];
2007-05-11 03:10:05 +00:00
extract ( $r );
2006-03-02 04:51:24 +00:00
2008-03-22 09:14:49 +00:00
$tab_index_attribute = '' ;
if ( ( int ) $tab_index > 0 )
$tab_index_attribute = " tabindex= \" $tab_index\ " " ;
2008-08-06 21:01:46 +00:00
$categories = get_categories ( $r );
2006-03-02 04:51:24 +00:00
$output = '' ;
2008-08-06 21:01:46 +00:00
if ( ! empty ( $categories ) ) {
2008-03-22 09:14:49 +00:00
$output = " <select name=' $name ' id=' $name ' class=' $class ' $tab_index_attribute > \n " ;
2006-03-02 04:51:24 +00:00
if ( $show_option_all ) {
2008-08-06 21:01:46 +00:00
$show_option_all = apply_filters ( 'list_cats' , $show_option_all );
2008-12-23 12:51:12 +00:00
$selected = ( '0' === strval ( $r [ 'selected' ]) ) ? " selected='selected' " : '' ;
$output .= " \t <option value='0' $selected > $show_option_all </option> \n " ;
2006-03-02 04:51:24 +00:00
}
2008-08-06 21:01:46 +00:00
if ( $show_option_none ) {
$show_option_none = apply_filters ( 'list_cats' , $show_option_none );
2008-12-23 12:51:12 +00:00
$selected = ( '-1' === strval ( $r [ 'selected' ]) ) ? " selected='selected' " : '' ;
$output .= " \t <option value='-1' $selected > $show_option_none </option> \n " ;
2005-10-12 17:01:50 +00:00
}
2006-03-02 04:51:24 +00:00
if ( $hierarchical )
2008-01-31 00:58:54 +00:00
$depth = $r [ 'depth' ]; // Walk the full depth.
2006-03-02 04:51:24 +00:00
else
$depth = - 1 ; // Flat.
2008-08-06 21:01:46 +00:00
$output .= walk_category_dropdown_tree ( $categories , $depth , $r );
2006-03-02 04:51:24 +00:00
$output .= " </select> \n " ;
2005-10-12 17:01:50 +00:00
}
2006-03-02 04:51:24 +00:00
2008-08-06 21:01:46 +00:00
$output = apply_filters ( 'wp_dropdown_cats' , $output );
2006-03-02 04:51:24 +00:00
if ( $echo )
echo $output ;
return $output ;
}
2008-09-25 14:16:27 +00:00
/**
* Display or retrieve the HTML list of categories .
*
* The list of arguments is below :
* 'show_option_all' ( string ) - Text to display for showing all categories .
* 'orderby' ( string ) default is 'ID' - What column to use for ordering the
* categories .
* 'order' ( string ) default is 'ASC' - What direction to order categories .
2008-12-09 18:03:31 +00:00
* 'show_last_update' ( bool | int ) default is 0 - See { @ link
2008-09-25 14:16:27 +00:00
* walk_category_dropdown_tree ()}
* 'show_count' ( bool | int ) default is 0 - Whether to show how many posts are
* in the category .
* 'hide_empty' ( bool | int ) default is 1 - Whether to hide categories that
* don ' t have any posts attached to them .
* 'use_desc_for_title' ( bool | int ) default is 1 - Whether to use the
* description instead of the category title .
* 'feed' - See { @ link get_categories ()} .
* 'feed_type' - See { @ link get_categories ()} .
* 'feed_image' - See { @ link get_categories ()} .
* 'child_of' ( int ) default is 0 - See { @ link get_categories ()} .
* 'exclude' ( string ) - See { @ link get_categories ()} .
2008-12-30 22:30:36 +00:00
* 'exclude_tree' ( string ) - See { @ link get_categories ()} .
2008-09-25 14:16:27 +00:00
* 'echo' ( bool | int ) default is 1 - Whether to display or retrieve content .
* 'current_category' ( int ) - See { @ link get_categories ()} .
* 'hierarchical' ( bool ) - See { @ link get_categories ()} .
* 'title_li' ( string ) - See { @ link get_categories ()} .
* 'depth' ( int ) - The max depth .
*
* @ since 2.1 . 0
*
* @ param string | array $args Optional . Override default arguments .
* @ return string HTML content only if 'echo' argument is 0.
*/
2008-08-06 21:01:46 +00:00
function wp_list_categories ( $args = '' ) {
2007-05-11 03:10:05 +00:00
$defaults = array (
2007-09-03 23:32:58 +00:00
'show_option_all' => '' , 'orderby' => 'name' ,
'order' => 'ASC' , 'show_last_update' => 0 ,
'style' => 'list' , 'show_count' => 0 ,
'hide_empty' => 1 , 'use_desc_for_title' => 1 ,
2007-12-06 19:58:15 +00:00
'child_of' => 0 , 'feed' => '' , 'feed_type' => '' ,
2008-12-30 22:30:36 +00:00
'feed_image' => '' , 'exclude' => '' , 'exclude_tree' => '' , 'current_category' => 0 ,
2008-08-06 21:01:46 +00:00
'hierarchical' => true , 'title_li' => __ ( 'Categories' ),
2008-01-10 21:51:00 +00:00
'echo' => 1 , 'depth' => 0
2007-05-11 03:10:05 +00:00
);
2007-06-14 02:25:30 +00:00
2007-05-11 03:10:05 +00:00
$r = wp_parse_args ( $args , $defaults );
2007-06-14 02:25:30 +00:00
2007-05-11 03:10:05 +00:00
if ( ! isset ( $r [ 'pad_counts' ] ) && $r [ 'show_count' ] && $r [ 'hierarchical' ] ) {
2007-01-09 08:45:05 +00:00
$r [ 'pad_counts' ] = true ;
2007-05-11 03:10:05 +00:00
}
2007-06-14 02:25:30 +00:00
2007-05-11 03:10:05 +00:00
if ( isset ( $r [ 'show_date' ] ) ) {
2006-09-19 23:56:28 +00:00
$r [ 'include_last_update_time' ] = $r [ 'show_date' ];
2007-05-11 03:10:05 +00:00
}
2007-06-14 02:25:30 +00:00
2008-12-30 22:30:36 +00:00
if ( true == $r [ 'hierarchical' ] ) {
$r [ 'exclude_tree' ] = $r [ 'exclude' ];
$r [ 'exclude' ] = '' ;
}
2007-05-11 03:10:05 +00:00
extract ( $r );
2007-06-14 02:25:30 +00:00
2008-08-06 21:01:46 +00:00
$categories = get_categories ( $r );
2006-11-19 07:56:05 +00:00
2006-03-01 13:30:19 +00:00
$output = '' ;
2006-06-17 00:05:00 +00:00
if ( $title_li && 'list' == $style )
2006-03-01 13:30:19 +00:00
$output = '<li class="categories">' . $r [ 'title_li' ] . '<ul>' ;
2008-08-06 21:01:46 +00:00
if ( empty ( $categories ) ) {
2007-01-19 20:58:56 +00:00
if ( 'list' == $style )
2008-08-06 21:01:46 +00:00
$output .= '<li>' . __ ( " No categories " ) . '</li>' ;
2006-03-01 13:30:19 +00:00
else
2008-08-06 21:01:46 +00:00
$output .= __ ( " No categories " );
2006-03-01 13:30:19 +00:00
} else {
global $wp_query ;
2007-06-14 02:25:30 +00:00
2008-08-06 21:01:46 +00:00
if ( ! empty ( $show_option_all ) )
if ( 'list' == $style )
$output .= '<li><a href="' . get_bloginfo ( 'url' ) . '">' . $show_option_all . '</a></li>' ;
2007-04-13 23:20:14 +00:00
else
2008-08-06 21:01:46 +00:00
$output .= '<a href="' . get_bloginfo ( 'url' ) . '">' . $show_option_all . '</a>' ;
2007-06-14 02:25:30 +00:00
2008-05-07 19:10:36 +00:00
if ( empty ( $r [ 'current_category' ] ) && is_category () )
2006-12-01 18:55:27 +00:00
$r [ 'current_category' ] = $wp_query -> get_queried_object_id ();
2006-03-01 13:30:19 +00:00
if ( $hierarchical )
2008-01-10 21:51:00 +00:00
$depth = $r [ 'depth' ];
2006-03-01 13:30:19 +00:00
else
$depth = - 1 ; // Flat.
2008-08-06 21:01:46 +00:00
$output .= walk_category_tree ( $categories , $depth , $r );
2004-04-30 18:28:50 +00:00
}
2006-06-17 00:05:00 +00:00
if ( $title_li && 'list' == $style )
2006-03-01 13:30:19 +00:00
$output .= '</ul></li>' ;
2006-11-19 07:56:05 +00:00
2008-08-06 21:01:46 +00:00
$output = apply_filters ( 'wp_list_categories' , $output );
2007-09-12 02:53:27 +00:00
if ( $echo )
echo $output ;
else
return $output ;
2006-03-01 13:30:19 +00:00
}
2005-08-30 23:25:34 +00:00
2008-09-25 14:16:27 +00:00
/**
* Display tag cloud .
*
* The text size is set by the 'smallest' and 'largest' arguments , which will
* use the 'unit' argument value for the CSS text size unit . The 'format'
* argument can be 'flat' ( default ), 'list' , or 'array' . The flat value for the
* 'format' argument will separate tags with spaces . The list value for the
* 'format' argument will format the tags in a UL HTML list . The array value for
* the 'format' argument will return in PHP array type format .
*
* The 'orderby' argument will accept 'name' or 'count' and defaults to 'name' .
* The 'order' is the direction to sort , defaults to 'ASC' and can be 'DESC' .
*
* The 'number' argument is how many tags to return . By default , the limit will
* be to return the top 45 tags in the tag cloud list .
*
2008-12-11 22:20:54 +00:00
* The 'topic_count_text_callback' argument is a function , which , given the count
2008-11-21 18:12:57 +00:00
* of the posts with that tag , returns a text for the tooltip of the tag link .
2008-09-25 14:16:27 +00:00
*
* The 'exclude' and 'include' arguments are used for the { @ link get_tags ()}
* function . Only one should be used , because only one will be used and the
* other ignored , if they are both set .
*
* @ since 2.3 . 0
*
* @ param array | string $args Optional . Override default arguments .
* @ return array Generated tag cloud , only if no failures and 'array' is set for the 'format' argument .
*/
2007-04-10 19:52:15 +00:00
function wp_tag_cloud ( $args = '' ) {
$defaults = array (
2007-09-03 23:32:58 +00:00
'smallest' => 8 , 'largest' => 22 , 'unit' => 'pt' , 'number' => 45 ,
2007-04-10 19:52:15 +00:00
'format' => 'flat' , 'orderby' => 'name' , 'order' => 'ASC' ,
2009-02-11 23:41:29 +00:00
'exclude' => '' , 'include' => '' , 'link' => 'view' , 'taxonomy' => 'post_tag'
2007-04-10 19:52:15 +00:00
);
$args = wp_parse_args ( $args , $defaults );
2009-02-11 23:41:29 +00:00
$tags = get_terms ( $args [ 'taxonomy' ], array_merge ( $args , array ( 'orderby' => 'count' , 'order' => 'DESC' ) ) ); // Always query top tags
2007-04-10 19:52:15 +00:00
2008-08-06 21:01:46 +00:00
if ( empty ( $tags ) )
2007-04-10 19:52:15 +00:00
return ;
2008-08-19 16:36:18 +00:00
foreach ( $tags as $key => $tag ) {
2008-10-25 18:19:42 +00:00
if ( 'edit' == $args [ 'link' ] )
2009-02-11 23:41:29 +00:00
$link = get_edit_tag_link ( $tag -> term_id , $args [ 'taxonomy' ] );
2008-10-25 18:19:42 +00:00
else
2009-02-20 23:31:46 +00:00
$link = get_term_link ( intval ( $tag -> term_id ), $args [ 'taxonomy' ] );
2008-08-19 16:36:18 +00:00
if ( is_wp_error ( $link ) )
return false ;
2008-01-14 22:35:43 +00:00
2008-08-19 16:36:18 +00:00
$tags [ $key ] -> link = $link ;
$tags [ $key ] -> id = $tag -> term_id ;
}
$return = wp_generate_tag_cloud ( $tags , $args ); // Here's where those top tags get sorted according to $args
2008-08-18 23:40:41 +00:00
2008-01-14 22:35:43 +00:00
$return = apply_filters ( 'wp_tag_cloud' , $return , $args );
if ( 'array' == $args [ 'format' ] )
return $return ;
echo $return ;
2007-04-10 19:52:15 +00:00
}
2008-11-21 18:12:57 +00:00
/**
* Default text for tooltip for tag links
*
* @ param integer $count number of posts with that tag
* @ return string text for the tooltip of a tag link .
*/
function default_topic_count_text ( $count ) {
2009-02-20 19:35:16 +00:00
return sprintf ( _n ( '%s topic' , '%s topics' , $count ), number_format_i18n ( $count ) );
2008-11-21 18:12:57 +00:00
}
2008-08-04 21:01:09 +00:00
/**
2008-09-25 14:16:27 +00:00
* Generates a tag cloud ( heatmap ) from provided data .
2008-08-04 21:01:09 +00:00
*
2008-09-25 14:16:27 +00:00
* The text size is set by the 'smallest' and 'largest' arguments , which will
* use the 'unit' argument value for the CSS text size unit . The 'format'
* argument can be 'flat' ( default ), 'list' , or 'array' . The flat value for the
* 'format' argument will separate tags with spaces . The list value for the
* 'format' argument will format the tags in a UL HTML list . The array value for
* the 'format' argument will return in PHP array type format .
2008-08-06 21:01:46 +00:00
*
2008-09-25 14:16:27 +00:00
* The 'orderby' argument will accept 'name' or 'count' and defaults to 'name' .
* The 'order' is the direction to sort , defaults to 'ASC' and can be 'DESC' or
* 'RAND' .
2008-08-04 21:01:09 +00:00
*
2008-09-25 14:16:27 +00:00
* The 'number' argument is how many tags to return . By default , the limit will
* be to return the entire tag cloud list .
*
2008-11-21 18:12:57 +00:00
* The 'topic_count_text_callback' argument is a function , which given the count
* of the posts with that tag returns a text for the tooltip of the tag link .
2008-09-25 14:16:27 +00:00
*
* @ todo Complete functionality .
* @ since 2.3 . 0
*
* @ param array $tags List of tags .
* @ param string | array $args Optional , override default arguments .
* @ return string
*/
2007-04-10 19:52:15 +00:00
function wp_generate_tag_cloud ( $tags , $args = '' ) {
global $wp_rewrite ;
$defaults = array (
2008-08-19 16:36:18 +00:00
'smallest' => 8 , 'largest' => 22 , 'unit' => 'pt' , 'number' => 0 ,
'format' => 'flat' , 'orderby' => 'name' , 'order' => 'ASC' ,
2008-11-21 18:12:57 +00:00
'topic_count_text_callback' => 'default_topic_count_text' ,
2007-04-10 19:52:15 +00:00
);
2008-12-09 18:03:31 +00:00
2008-11-21 18:12:57 +00:00
if ( ! isset ( $args [ 'topic_count_text_callback' ] ) && isset ( $args [ 'single_text' ] ) && isset ( $args [ 'multiple_text' ] ) ) {
2008-12-09 18:03:31 +00:00
$body = ' return sprintf (
2009-02-20 19:35:16 +00:00
_n ( '.var_export($args[' single_text '], true).' , '.var_export($args[' multiple_text '], true).' , $count ),
2008-11-21 18:12:57 +00:00
number_format_i18n ( $count )); ' ;
$args [ 'topic_count_text_callback' ] = create_function ( '$count' , $body );
}
2008-12-09 18:03:31 +00:00
2007-04-10 19:52:15 +00:00
$args = wp_parse_args ( $args , $defaults );
2008-12-09 18:03:31 +00:00
2008-08-06 21:01:46 +00:00
extract ( $args );
2007-04-10 19:52:15 +00:00
2008-08-06 21:01:46 +00:00
if ( empty ( $tags ) )
2007-04-10 19:52:15 +00:00
return ;
// SQL cannot save you; this is a second (potentially different) sort on a subset of data.
if ( 'name' == $orderby )
2008-08-19 16:36:18 +00:00
uasort ( $tags , create_function ( '$a, $b' , 'return strnatcasecmp($a->name, $b->name);' ) );
2007-04-10 19:52:15 +00:00
else
2009-01-06 00:34:31 +00:00
uasort ( $tags , create_function ( '$a, $b' , 'return ($a->count > $b->count);' ) );
2007-04-10 19:52:15 +00:00
if ( 'DESC' == $order )
2008-08-19 16:36:18 +00:00
$tags = array_reverse ( $tags , true );
2008-02-13 19:12:46 +00:00
elseif ( 'RAND' == $order ) {
2008-08-19 16:36:18 +00:00
$keys = array_rand ( $tags , count ( $tags ) );
2008-02-13 19:12:46 +00:00
foreach ( $keys as $key )
2008-08-19 16:36:18 +00:00
$temp [ $key ] = $tags [ $key ];
$tags = $temp ;
2008-08-06 21:01:46 +00:00
unset ( $temp );
2008-02-13 19:12:46 +00:00
}
2007-04-10 19:52:15 +00:00
2008-08-19 16:36:18 +00:00
if ( $number > 0 )
$tags = array_slice ( $tags , 0 , $number );
$counts = array ();
foreach ( ( array ) $tags as $key => $tag )
$counts [ $key ] = $tag -> count ;
$min_count = min ( $counts );
$spread = max ( $counts ) - $min_count ;
if ( $spread <= 0 )
$spread = 1 ;
$font_spread = $largest - $smallest ;
2008-11-28 21:06:57 +00:00
if ( $font_spread < 0 )
2008-08-19 16:36:18 +00:00
$font_spread = 1 ;
$font_step = $font_spread / $spread ;
2007-04-10 19:52:15 +00:00
$a = array ();
2008-08-06 21:01:46 +00:00
$rel = ( is_object ( $wp_rewrite ) && $wp_rewrite -> using_permalinks () ) ? ' rel="tag"' : '' ;
2007-04-10 19:52:15 +00:00
2008-08-19 16:36:18 +00:00
foreach ( $tags as $key => $tag ) {
$count = $counts [ $key ];
2008-11-04 23:15:59 +00:00
$tag_link = '#' != $tag -> link ? clean_url ( $tag -> link ) : '#' ;
2008-08-19 16:36:18 +00:00
$tag_id = isset ( $tags [ $key ] -> id ) ? $tags [ $key ] -> id : $key ;
$tag_name = $tags [ $key ] -> name ;
2008-11-21 18:12:57 +00:00
$a [] = " <a href=' $tag_link ' class='tag-link- $tag_id ' title=' " . attribute_escape ( $topic_count_text_callback ( $count ) ) . " ' $rel style='font-size: " .
2007-04-10 19:52:15 +00:00
( $smallest + ( ( $count - $min_count ) * $font_step ) )
2008-08-19 16:36:18 +00:00
. " $unit ;'> $tag_name </a> " ;
2007-04-10 19:52:15 +00:00
}
switch ( $format ) :
case 'array' :
$return =& $a ;
break ;
case 'list' :
$return = " <ul class='wp-tag-cloud'> \n \t <li> " ;
2008-08-06 21:01:46 +00:00
$return .= join ( " </li> \n \t <li> " , $a );
2007-04-10 19:52:15 +00:00
$return .= " </li> \n </ul> \n " ;
break ;
default :
2008-08-06 21:01:46 +00:00
$return = join ( " \n " , $a );
2007-04-10 19:52:15 +00:00
break ;
endswitch ;
return apply_filters ( 'wp_generate_tag_cloud' , $return , $tags , $args );
}
2006-06-04 21:36:52 +00:00
//
// Helper functions
//
2006-03-01 13:30:19 +00:00
2008-09-25 14:16:27 +00:00
/**
* Retrieve HTML list content for category list .
*
* @ uses Walker_Category to create HTML list content .
* @ since 2.1 . 0
* @ see Walker_Category :: walk () for parameters and return description .
*/
2006-06-04 21:36:52 +00:00
function walk_category_tree () {
$args = func_get_args ();
2008-12-23 12:52:37 +00:00
// the user's options are the third parameter
if ( empty ( $args [ 2 ][ 'walker' ]) || ! is_a ( $args [ 2 ][ 'walker' ], 'Walker' ) )
$walker = new Walker_Category ;
else
$walker = $args [ 2 ][ 'walker' ];
2008-08-06 21:01:46 +00:00
return call_user_func_array ( array ( & $walker , 'walk' ), $args );
2006-03-01 13:30:19 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Retrieve HTML dropdown ( select ) content for category list .
*
* @ uses Walker_CategoryDropdown to create HTML dropdown content .
* @ since 2.1 . 0
* @ see Walker_CategoryDropdown :: walk () for parameters and return description .
*/
2006-06-04 21:36:52 +00:00
function walk_category_dropdown_tree () {
$args = func_get_args ();
2008-12-23 12:52:37 +00:00
// the user's options are the third parameter
if ( empty ( $args [ 2 ][ 'walker' ]) || ! is_a ( $args [ 2 ][ 'walker' ], 'Walker' ) )
$walker = new Walker_CategoryDropdown ;
else
$walker = $args [ 2 ][ 'walker' ];
2008-08-06 21:01:46 +00:00
return call_user_func_array ( array ( & $walker , 'walk' ), $args );
2006-02-27 04:57:30 +00:00
}
2007-04-10 21:23:11 +00:00
//
// Tags
//
2008-09-25 14:16:27 +00:00
/**
* Retrieve the link to the tag .
*
* @ since 2.3 . 0
* @ uses apply_filters () Calls 'tag_link' with tag link and tag ID as parameters .
*
* @ param int $tag_id Tag ( term ) ID .
* @ return string
*/
2007-04-10 21:23:11 +00:00
function get_tag_link ( $tag_id ) {
global $wp_rewrite ;
2007-05-23 03:57:20 +00:00
$taglink = $wp_rewrite -> get_tag_permastruct ();
2007-04-10 21:23:11 +00:00
2008-08-06 21:01:46 +00:00
$tag = & get_term ( $tag_id , 'post_tag' );
2007-09-18 16:32:22 +00:00
if ( is_wp_error ( $tag ) )
return $tag ;
2007-05-23 03:57:20 +00:00
$slug = $tag -> slug ;
2007-04-10 21:23:11 +00:00
2008-08-06 21:01:46 +00:00
if ( empty ( $taglink ) ) {
$file = get_option ( 'home' ) . '/' ;
2007-05-23 03:57:20 +00:00
$taglink = $file . '?tag=' . $slug ;
2007-04-10 21:23:11 +00:00
} else {
2008-08-06 21:01:46 +00:00
$taglink = str_replace ( '%tag%' , $slug , $taglink );
$taglink = get_option ( 'home' ) . user_trailingslashit ( $taglink , 'category' );
2007-04-10 21:23:11 +00:00
}
2008-08-06 21:01:46 +00:00
return apply_filters ( 'tag_link' , $taglink , $tag_id );
2007-04-10 21:23:11 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Retrieve the tags for a post .
*
* @ since 2.3 . 0
* @ uses apply_filters () Calls 'get_the_tags' filter on the list of post tags .
*
* @ param int $id Post ID .
* @ return array
*/
2007-04-10 21:23:11 +00:00
function get_the_tags ( $id = 0 ) {
2008-08-06 21:01:46 +00:00
return apply_filters ( 'get_the_tags' , get_the_terms ( $id , 'post_tag' ) );
2008-03-26 06:37:19 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Retrieve the tags for a post formatted as a string .
*
* @ since 2.3 . 0
* @ uses apply_filters () Calls 'the_tags' filter on string list of tags .
*
* @ param string $before Optional . Before tags .
* @ param string $sep Optional . Between tags .
* @ param string $after Optional . After tags .
* @ return string
*/
2008-03-26 06:37:19 +00:00
function get_the_tag_list ( $before = '' , $sep = '' , $after = '' ) {
2008-08-06 21:01:46 +00:00
return apply_filters ( 'the_tags' , get_the_term_list ( 0 , 'post_tag' , $before , $sep , $after ) );
2008-03-26 06:37:19 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Retrieve the tags for a post .
*
* @ since 2.3 . 0
*
* @ param string $before Optional . Before list .
* @ param string $sep Optional . Separate items using this .
* @ param string $after Optional . After list .
* @ return string
*/
2008-03-26 06:37:19 +00:00
function the_tags ( $before = 'Tags: ' , $sep = ', ' , $after = '' ) {
return the_terms ( 0 , 'post_tag' , $before , $sep , $after );
}
2008-09-25 14:16:27 +00:00
/**
* Retrieve the terms of the taxonomy that are attached to the post .
*
* This function can only be used within the loop .
*
* @ since 2.5 . 0
*
* @ param int $id Post ID . Is not optional .
* @ param string $taxonomy Taxonomy name .
* @ return array | bool False on failure . Array of term objects on success .
*/
2008-03-26 06:37:19 +00:00
function get_the_terms ( $id = 0 , $taxonomy ) {
2007-09-03 23:32:58 +00:00
global $post ;
2007-06-14 02:25:30 +00:00
2007-04-10 21:23:11 +00:00
$id = ( int ) $id ;
2007-09-03 23:32:58 +00:00
if ( ! $id && ! in_the_loop () )
return false ; // in-the-loop function
2007-06-14 02:25:30 +00:00
2007-09-03 23:32:58 +00:00
if ( ! $id )
2007-04-10 21:23:11 +00:00
$id = ( int ) $post -> ID ;
2008-08-06 21:01:46 +00:00
$terms = get_object_term_cache ( $id , $taxonomy );
2008-03-26 06:37:19 +00:00
if ( false === $terms )
2008-08-06 21:01:46 +00:00
$terms = wp_get_object_terms ( $id , $taxonomy );
2007-05-30 03:36:59 +00:00
2008-03-26 06:37:19 +00:00
if ( empty ( $terms ) )
2007-09-03 23:32:58 +00:00
return false ;
2008-03-26 06:37:19 +00:00
return $terms ;
2007-04-10 21:23:11 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Retrieve terms as a list with specified format .
*
* @ since 2.5 . 0
*
* @ param int $id Term ID .
* @ param string $taxonomy Taxonomy name .
* @ param string $before Optional . Before list .
* @ param string $sep Optional . Separate items using this .
* @ param string $after Optional . After list .
* @ return string
*/
2008-03-26 06:37:19 +00:00
function get_the_term_list ( $id = 0 , $taxonomy , $before = '' , $sep = '' , $after = '' ) {
2008-08-06 21:01:46 +00:00
$terms = get_the_terms ( $id , $taxonomy );
2007-04-10 21:23:11 +00:00
2008-08-06 21:01:46 +00:00
if ( is_wp_error ( $terms ) )
2008-03-26 06:37:19 +00:00
return $terms ;
if ( empty ( $terms ) )
2007-04-10 21:23:11 +00:00
return false ;
2007-06-14 02:25:30 +00:00
2008-03-26 06:37:19 +00:00
foreach ( $terms as $term ) {
2008-08-06 21:01:46 +00:00
$link = get_term_link ( $term , $taxonomy );
2007-09-18 16:32:22 +00:00
if ( is_wp_error ( $link ) )
return $link ;
2008-03-26 06:37:19 +00:00
$term_links [] = '<a href="' . $link . '" rel="tag">' . $term -> name . '</a>' ;
2007-09-18 16:32:22 +00:00
}
2007-04-10 21:23:11 +00:00
2008-03-26 06:37:19 +00:00
$term_links = apply_filters ( " term_links- $taxonomy " , $term_links );
2007-04-10 21:23:11 +00:00
2008-08-06 21:01:46 +00:00
return $before . join ( $sep , $term_links ) . $after ;
2007-08-14 03:44:49 +00:00
}
2008-09-25 14:16:27 +00:00
/**
* Display the terms in a list .
*
* @ since 2.5 . 0
*
* @ param int $id Term ID .
* @ param string $taxonomy Taxonomy name .
* @ param string $before Optional . Before list .
* @ param string $sep Optional . Separate items using this .
* @ param string $after Optional . After list .
* @ return null | bool False on WordPress error . Returns null when displaying .
*/
2008-03-26 06:37:19 +00:00
function the_terms ( $id , $taxonomy , $before = '' , $sep = '' , $after = '' ) {
2008-08-06 21:01:46 +00:00
$return = get_the_term_list ( $id , $taxonomy , $before , $sep , $after );
2007-09-18 16:32:22 +00:00
if ( is_wp_error ( $return ) )
return false ;
else
echo $return ;
2007-04-10 21:23:11 +00:00
}
2008-06-20 13:52:18 +00:00
/**
2008-12-09 23:31:11 +00:00
* Check if the current post has any of given tags .
*
* The given tags are checked against the post 's tags' term_ids , names and slugs .
* Tags given as integers will only be checked against the post 's tags' term_ids .
* If no tags are given , determines if post has any tags .
2008-06-20 13:52:18 +00:00
*
2008-12-09 23:31:11 +00:00
* Prior to v2 . 7 of WordPress , tags given as integers would also be checked against the post 's tags' names and slugs ( in addition to term_ids )
* Prior to v2 . 7 , this function could only be used in the WordPress Loop .
* As of 2.7 , the function can be used anywhere if it is provided a post ID or post object .
2008-09-25 14:16:27 +00:00
*
* @ since 2.6 . 0
2008-06-20 13:52:18 +00:00
*
2008-12-09 23:31:11 +00:00
* @ uses is_object_in_term ()
2008-06-20 13:52:18 +00:00
*
2008-12-09 23:31:11 +00:00
* @ param string | int | array $tag Optional . The tag name / term_id / slug or array of them to check for .
* @ param int | post object Optional . Post to check instead of the current post . @ since 2.7 . 0
* @ return bool True if the current post has any of the the given tags ( or any tag , if no tag specified ) .
2008-06-20 13:52:18 +00:00
*/
2008-12-09 23:31:11 +00:00
function has_tag ( $tag = '' , $_post = null ) {
if ( $_post ) {
$_post = get_post ( $_post );
} else {
$_post =& $GLOBALS [ 'post' ];
2008-06-20 13:52:18 +00:00
}
2008-12-09 23:31:11 +00:00
if ( ! $_post )
return false ;
$r = is_object_in_term ( $_post -> ID , 'post_tag' , $tag );
if ( is_wp_error ( $r ) )
return false ;
return $r ;
2008-06-20 13:52:18 +00:00
}
2005-11-01 18:22:30 +00:00
?>