* @subpackage Template
*/
-/**
- * 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
- */
-function get_category_children( $id, $before = '/', $after = '', $visited = array() ) {
- if ( 0 == $id )
- return '';
-
- $chain = '';
- /** TODO: consult hierarchy */
- $cat_ids = get_all_category_ids();
- foreach ( (array) $cat_ids as $cat_id ) {
- if ( $cat_id == $id )
- continue;
-
- $category = get_category( $cat_id );
- if ( is_wp_error( $category ) )
- return $category;
- if ( $category->parent == $id && !in_array( $category->term_id, $visited ) ) {
- $visited[] = $category->term_id;
- $chain .= $before.$category->term_id.$after;
- $chain .= get_category_children( $category->term_id, $before, $after );
- }
- }
- return $chain;
-}
-
/**
* Retrieve category link URL.
*
$catlink = $wp_rewrite->get_category_permastruct();
if ( empty( $catlink ) ) {
- $file = get_option( 'home' ) . '/';
- $catlink = $file . '?cat=' . $category_id;
+ $catlink = home_url('?cat=' . $category_id);
} else {
$category = &get_category( $category_id );
if ( is_wp_error( $category ) )
$category_nicename = get_category_parents( $category->parent, false, '/', true ) . $category_nicename;
$catlink = str_replace( '%category%', $category_nicename, $catlink );
- $catlink = get_option( 'home' ) . user_trailingslashit( $catlink, 'category' );
+ $catlink = home_url( user_trailingslashit( $catlink, 'category' ) );
}
return apply_filters( 'category_link', $catlink, $category_id );
}
}
if ( $link )
- $chain .= '<a href="' . get_category_link( $parent->term_id ) . '" title="' . sprintf( __( "View all posts in %s" ), $parent->cat_name ) . '">'.$name.'</a>' . $separator;
+ $chain .= '<a href="' . get_category_link( $parent->term_id ) . '" title="' . esc_attr( sprintf( __( "View all posts in %s" ), $parent->cat_name ) ) . '">'.$name.'</a>' . $separator;
else
$chain .= $name.$separator;
return $chain;
function get_the_category_list( $separator = '', $parents='', $post_id = false ) {
global $wp_rewrite;
$categories = get_the_category( $post_id );
+ if ( !is_object_in_taxonomy( get_post_type( $post_id ), 'category' ) )
+ return apply_filters( 'the_category', '', $separator, $parents );
+
if ( empty( $categories ) )
return apply_filters( 'the_category', __( 'Uncategorized' ), $separator, $parents );
case 'multiple':
if ( $category->parent )
$thelist .= get_category_parents( $category->parent, true, $separator );
- $thelist .= '<a href="' . get_category_link( $category->term_id ) . '" title="' . sprintf( __( "View all posts in %s" ), $category->name ) . '" ' . $rel . '>' . $category->name.'</a></li>';
+ $thelist .= '<a href="' . get_category_link( $category->term_id ) . '" title="' . esc_attr( sprintf( __( "View all posts in %s" ), $category->name ) ) . '" ' . $rel . '>' . $category->name.'</a></li>';
break;
case 'single':
- $thelist .= '<a href="' . get_category_link( $category->term_id ) . '" title="' . sprintf( __( "View all posts in %s" ), $category->name ) . '" ' . $rel . '>';
+ $thelist .= '<a href="' . get_category_link( $category->term_id ) . '" title="' . esc_attr( sprintf( __( "View all posts in %s" ), $category->name ) ) . '" ' . $rel . '>';
if ( $category->parent )
$thelist .= get_category_parents( $category->parent, false, $separator );
$thelist .= $category->name.'</a></li>';
break;
case '':
default:
- $thelist .= '<a href="' . get_category_link( $category->term_id ) . '" title="' . sprintf( __( "View all posts in %s" ), $category->name ) . '" ' . $rel . '>' . $category->cat_name.'</a></li>';
+ $thelist .= '<a href="' . get_category_link( $category->term_id ) . '" title="' . esc_attr( sprintf( __( "View all posts in %s" ), $category->name ) ) . '" ' . $rel . '>' . $category->cat_name.'</a></li>';
}
}
$thelist .= '</ul>';
$i = 0;
foreach ( $categories as $category ) {
if ( 0 < $i )
- $thelist .= $separator . ' ';
+ $thelist .= $separator;
switch ( strtolower( $parents ) ) {
case 'multiple':
if ( $category->parent )
$thelist .= get_category_parents( $category->parent, true, $separator );
- $thelist .= '<a href="' . get_category_link( $category->term_id ) . '" title="' . sprintf( __( "View all posts in %s" ), $category->name ) . '" ' . $rel . '>' . $category->cat_name.'</a>';
+ $thelist .= '<a href="' . get_category_link( $category->term_id ) . '" title="' . esc_attr( sprintf( __( "View all posts in %s" ), $category->name ) ) . '" ' . $rel . '>' . $category->cat_name.'</a>';
break;
case 'single':
- $thelist .= '<a href="' . get_category_link( $category->term_id ) . '" title="' . sprintf( __( "View all posts in %s" ), $category->name ) . '" ' . $rel . '>';
+ $thelist .= '<a href="' . get_category_link( $category->term_id ) . '" title="' . esc_attr( sprintf( __( "View all posts in %s" ), $category->name ) ) . '" ' . $rel . '>';
if ( $category->parent )
$thelist .= get_category_parents( $category->parent, false, $separator );
$thelist .= "$category->cat_name</a>";
break;
case '':
default:
- $thelist .= '<a href="' . get_category_link( $category->term_id ) . '" title="' . sprintf( __( "View all posts in %s" ), $category->name ) . '" ' . $rel . '>' . $category->name.'</a>';
+ $thelist .= '<a href="' . get_category_link( $category->term_id ) . '" title="' . esc_attr( sprintf( __( "View all posts in %s" ), $category->name ) ) . '" ' . $rel . '>' . $category->name.'</a>';
}
++$i;
}
* @return string Category description, available.
*/
function category_description( $category = 0 ) {
- global $cat;
- if ( !$category )
- $category = $cat;
-
- return get_term_field( 'description', $category, 'category' );
+ return term_description( $category, 'category' );
}
/**
* '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.
+ * 'name' (string) - The name attribute value for select element.
+ * 'id' (string) - The ID attribute value for select element. Defaults to name if omitted.
+ * 'class' (string) - The class attribute value for select element.
* 'selected' (int) - Which category ID is selected.
+ * 'taxonomy' (string) - The name of the taxonomy to retrieve. Defaults to category.
*
* The 'hierarchical' argument, which is disabled by default, will override the
* depth argument, unless it is true. When the argument is false, it will
function wp_dropdown_categories( $args = '' ) {
$defaults = array(
'show_option_all' => '', 'show_option_none' => '',
- 'orderby' => 'ID', 'order' => 'ASC',
+ 'orderby' => 'id', 'order' => 'ASC',
'show_last_update' => 0, 'show_count' => 0,
'hide_empty' => 1, 'child_of' => 0,
'exclude' => '', 'echo' => 1,
'selected' => 0, 'hierarchical' => 0,
- 'name' => 'cat', 'class' => 'postform',
- 'depth' => 0, 'tab_index' => 0
+ 'name' => 'cat', 'id' => '',
+ 'class' => 'postform', 'depth' => 0,
+ 'tab_index' => 0, 'taxonomy' => 'category',
+ 'hide_if_empty' => false
);
$defaults['selected'] = ( is_category() ) ? get_query_var( 'cat' ) : 0;
+ // Back compat.
+ if ( isset( $args['type'] ) && 'link' == $args['type'] ) {
+ _deprecated_argument( __FUNCTION__, '3.0', '' );
+ $args['taxonomy'] = 'link_category';
+ }
+
$r = wp_parse_args( $args, $defaults );
+
+ if ( !isset( $r['pad_counts'] ) && $r['show_count'] && $r['hierarchical'] ) {
+ $r['pad_counts'] = true;
+ }
+
$r['include_last_update_time'] = $r['show_last_update'];
extract( $r );
if ( (int) $tab_index > 0 )
$tab_index_attribute = " tabindex=\"$tab_index\"";
- $categories = get_categories( $r );
+ $categories = get_terms( $taxonomy, $r );
+ $name = esc_attr( $name );
+ $class = esc_attr( $class );
+ $id = $id ? esc_attr( $id ) : $name;
+
+ if ( ! $r['hide_if_empty'] || ! empty($categories) )
+ $output = "<select name='$name' id='$id' class='$class' $tab_index_attribute>\n";
+ else
+ $output = '';
+
+ if ( empty($categories) && ! $r['hide_if_empty'] && !empty($show_option_none) ) {
+ $show_option_none = apply_filters( 'list_cats', $show_option_none );
+ $output .= "\t<option value='-1' selected='selected'>$show_option_none</option>\n";
+ }
- $output = '';
if ( ! empty( $categories ) ) {
- $output = "<select name='$name' id='$name' class='$class' $tab_index_attribute>\n";
if ( $show_option_all ) {
$show_option_all = apply_filters( 'list_cats', $show_option_all );
$depth = -1; // Flat.
$output .= walk_category_dropdown_tree( $categories, $depth, $r );
- $output .= "</select>\n";
}
+ if ( ! $r['hide_if_empty'] || ! empty($categories) )
+ $output .= "</select>\n";
+
$output = apply_filters( 'wp_dropdown_cats', $output );
*/
function wp_list_categories( $args = '' ) {
$defaults = array(
- 'show_option_all' => '', 'orderby' => 'name',
- 'order' => 'ASC', 'show_last_update' => 0,
- 'style' => 'list', 'show_count' => 0,
- 'hide_empty' => 1, 'use_desc_for_title' => 1,
- 'child_of' => 0, 'feed' => '', 'feed_type' => '',
- 'feed_image' => '', 'exclude' => '', 'exclude_tree' => '', 'current_category' => 0,
+ 'show_option_all' => '', 'show_option_none' => __('No categories'),
+ 'orderby' => 'name', 'order' => 'ASC',
+ 'show_last_update' => 0, 'style' => 'list',
+ 'show_count' => 0, 'hide_empty' => 1,
+ 'use_desc_for_title' => 1, 'child_of' => 0,
+ 'feed' => '', 'feed_type' => '',
+ 'feed_image' => '', 'exclude' => '',
+ 'exclude_tree' => '', 'current_category' => 0,
'hierarchical' => true, 'title_li' => __( 'Categories' ),
- 'echo' => 1, 'depth' => 0
+ 'echo' => 1, 'depth' => 0,
+ 'taxonomy' => 'category'
);
$r = wp_parse_args( $args, $defaults );
- if ( !isset( $r['pad_counts'] ) && $r['show_count'] && $r['hierarchical'] ) {
+ if ( !isset( $r['pad_counts'] ) && $r['show_count'] && $r['hierarchical'] )
$r['pad_counts'] = true;
- }
- if ( isset( $r['show_date'] ) ) {
+ if ( isset( $r['show_date'] ) )
$r['include_last_update_time'] = $r['show_date'];
- }
if ( true == $r['hierarchical'] ) {
$r['exclude_tree'] = $r['exclude'];
$r['exclude'] = '';
}
+ if ( !isset( $r['class'] ) )
+ $r['class'] = ( 'category' == $r['taxonomy'] ) ? 'categories' : $r['taxonomy'];
+
extract( $r );
+ if ( !taxonomy_exists($taxonomy) )
+ return false;
+
$categories = get_categories( $r );
$output = '';
if ( $title_li && 'list' == $style )
- $output = '<li class="categories">' . $r['title_li'] . '<ul>';
+ $output = '<li class="' . $class . '">' . $title_li . '<ul>';
if ( empty( $categories ) ) {
- if ( 'list' == $style )
- $output .= '<li>' . __( "No categories" ) . '</li>';
- else
- $output .= __( "No categories" );
+ if ( ! empty( $show_option_none ) ) {
+ if ( 'list' == $style )
+ $output .= '<li>' . $show_option_none . '</li>';
+ else
+ $output .= $show_option_none;
+ }
} else {
global $wp_query;
else
$output .= '<a href="' . get_bloginfo( 'url' ) . '">' . $show_option_all . '</a>';
- if ( empty( $r['current_category'] ) && is_category() )
+ if ( empty( $r['current_category'] ) && ( is_category() || is_tax() ) )
$r['current_category'] = $wp_query->get_queried_object_id();
if ( $hierarchical )
if ( $title_li && 'list' == $style )
$output .= '</ul></li>';
- $output = apply_filters( 'wp_list_categories', $output );
+ $output = apply_filters( 'wp_list_categories', $output, $args );
if ( $echo )
echo $output;
function wp_tag_cloud( $args = '' ) {
$defaults = array(
'smallest' => 8, 'largest' => 22, 'unit' => 'pt', 'number' => 45,
- 'format' => 'flat', 'orderby' => 'name', 'order' => 'ASC',
- 'exclude' => '', 'include' => '', 'link' => 'view'
+ 'format' => 'flat', 'separator' => "\n", 'orderby' => 'name', 'order' => 'ASC',
+ 'exclude' => '', 'include' => '', 'link' => 'view', 'taxonomy' => 'post_tag', 'echo' => true
);
$args = wp_parse_args( $args, $defaults );
- $tags = get_tags( array_merge( $args, array( 'orderby' => 'count', 'order' => 'DESC' ) ) ); // Always query top tags
+ $tags = get_terms( $args['taxonomy'], array_merge( $args, array( 'orderby' => 'count', 'order' => 'DESC' ) ) ); // Always query top tags
if ( empty( $tags ) )
return;
foreach ( $tags as $key => $tag ) {
if ( 'edit' == $args['link'] )
- $link = get_edit_tag_link( $tag->term_id );
+ $link = get_edit_tag_link( $tag->term_id, $args['taxonomy'] );
else
- $link = get_tag_link( $tag->term_id );
+ $link = get_term_link( intval($tag->term_id), $args['taxonomy'] );
if ( is_wp_error( $link ) )
return false;
$return = apply_filters( 'wp_tag_cloud', $return, $args );
- if ( 'array' == $args['format'] )
+ if ( 'array' == $args['format'] || empty($args['echo']) )
return $return;
echo $return;
* @return string text for the tooltip of a tag link.
*/
function default_topic_count_text( $count ) {
- return sprintf( __ngettext('%s topic', '%s topics', $count), number_format_i18n( $count ) );
+ return sprintf( _n('%s topic', '%s topics', $count), number_format_i18n( $count ) );
}
+/**
+ * Default topic count scaling for tag links
+ *
+ * @param integer $count number of posts with that tag
+ * @return integer scaled count
+ */
+function default_topic_count_scale( $count ) {
+ return round(log10($count + 1) * 100);
+}
+
+
/**
* Generates a tag cloud (heatmap) from provided data.
*
* '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 'tag_cloud_sort' filter allows you to override the sorting.
+ * Passed to the filter: $tags array and $args array, has to return the $tags array
+ * after sorting it.
+ *
* 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'.
global $wp_rewrite;
$defaults = array(
'smallest' => 8, 'largest' => 22, 'unit' => 'pt', 'number' => 0,
- 'format' => 'flat', 'orderby' => 'name', 'order' => 'ASC',
+ 'format' => 'flat', 'separator' => "\n", 'orderby' => 'name', 'order' => 'ASC',
'topic_count_text_callback' => 'default_topic_count_text',
+ 'topic_count_scale_callback' => 'default_topic_count_scale', 'filter' => 1,
);
if ( !isset( $args['topic_count_text_callback'] ) && isset( $args['single_text'] ) && isset( $args['multiple_text'] ) ) {
$body = 'return sprintf (
- __ngettext('.var_export($args['single_text'], true).', '.var_export($args['multiple_text'], true).', $count),
+ _n(' . var_export($args['single_text'], true) . ', ' . var_export($args['multiple_text'], true) . ', $count),
number_format_i18n( $count ));';
$args['topic_count_text_callback'] = create_function('$count', $body);
}
$args = wp_parse_args( $args, $defaults );
-
extract( $args );
if ( empty( $tags ) )
return;
- // SQL cannot save you; this is a second (potentially different) sort on a subset of data.
- if ( 'name' == $orderby )
- uasort( $tags, create_function('$a, $b', 'return strnatcasecmp($a->name, $b->name);') );
- else
- uasort( $tags, create_function('$a, $b', 'return ($a->count > $b->count);') );
-
- if ( 'DESC' == $order )
- $tags = array_reverse( $tags, true );
- elseif ( 'RAND' == $order ) {
- $keys = array_rand( $tags, count( $tags ) );
- foreach ( $keys as $key )
- $temp[$key] = $tags[$key];
- $tags = $temp;
- unset( $temp );
+ $tags_sorted = apply_filters( 'tag_cloud_sort', $tags, $args );
+ if ( $tags_sorted != $tags ) { // the tags have been sorted by a plugin
+ $tags = $tags_sorted;
+ unset($tags_sorted);
+ } else {
+ if ( 'RAND' == $order ) {
+ shuffle($tags);
+ } else {
+ // SQL cannot save you; this is a second (potentially different) sort on a subset of data.
+ if ( 'name' == $orderby )
+ uasort( $tags, create_function('$a, $b', 'return strnatcasecmp($a->name, $b->name);') );
+ else
+ uasort( $tags, create_function('$a, $b', 'return ($a->count > $b->count);') );
+
+ if ( 'DESC' == $order )
+ $tags = array_reverse( $tags, true );
+ }
}
if ( $number > 0 )
$tags = array_slice($tags, 0, $number);
$counts = array();
- foreach ( (array) $tags as $key => $tag )
- $counts[ $key ] = $tag->count;
+ $real_counts = array(); // For the alt tag
+ foreach ( (array) $tags as $key => $tag ) {
+ $real_counts[ $key ] = $tag->count;
+ $counts[ $key ] = $topic_count_scale_callback($tag->count);
+ }
$min_count = min( $counts );
$spread = max( $counts ) - $min_count;
$a = array();
- $rel = ( is_object( $wp_rewrite ) && $wp_rewrite->using_permalinks() ) ? ' rel="tag"' : '';
-
foreach ( $tags as $key => $tag ) {
$count = $counts[ $key ];
- $tag_link = '#' != $tag->link ? clean_url( $tag->link ) : '#';
+ $real_count = $real_counts[ $key ];
+ $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='" . attribute_escape( $topic_count_text_callback( $count ) ) . "'$rel style='font-size: " .
+ $a[] = "<a href='$tag_link' class='tag-link-$tag_id' title='" . esc_attr( $topic_count_text_callback( $real_count ) ) . "' style='font-size: " .
( $smallest + ( ( $count - $min_count ) * $font_step ) )
. "$unit;'>$tag_name</a>";
}
$return .= "</li>\n</ul>\n";
break;
default :
- $return = join( "\n", $a );
+ $return = join( $separator, $a );
break;
endswitch;
- return apply_filters( 'wp_generate_tag_cloud', $return, $tags, $args );
+ if ( $filter )
+ return apply_filters( 'wp_generate_tag_cloud', $return, $tags, $args );
+ else
+ return $return;
}
//
* @return string
*/
function get_the_tag_list( $before = '', $sep = '', $after = '' ) {
- return apply_filters( 'the_tags', get_the_term_list( 0, 'post_tag', $before, $sep, $after ) );
+ return apply_filters( 'the_tags', get_the_term_list( 0, 'post_tag', $before, $sep, $after ), $before, $sep, $after);
}
/**
* @param string $after Optional. After list.
* @return string
*/
-function the_tags( $before = 'Tags: ', $sep = ', ', $after = '' ) {
- return the_terms( 0, 'post_tag', $before, $sep, $after );
+function the_tags( $before = null, $sep = ', ', $after = '' ) {
+ if ( null === $before )
+ $before = __('Tags: ');
+ echo get_the_tag_list($before, $sep, $after);
+}
+
+/**
+ * Retrieve tag description.
+ *
+ * @since 2.8
+ *
+ * @param int $tag Optional. Tag ID. Will use global tag ID by default.
+ * @return string Tag description, available.
+ */
+function tag_description( $tag = 0 ) {
+ return term_description( $tag );
+}
+
+/**
+ * Retrieve term description.
+ *
+ * @since 2.8
+ *
+ * @param int $term Optional. Term ID. Will use global term ID by default.
+ * @return string Term description, available.
+ */
+function term_description( $term = 0, $taxonomy = 'post_tag' ) {
+ if ( !$term && ( is_tax() || is_tag() || is_category() ) ) {
+ global $wp_query;
+ $term = $wp_query->get_queried_object();
+ $taxonomy = $term->taxonomy;
+ $term = $term->term_id;
+ }
+ $description = get_term_field( 'description', $term, $taxonomy );
+ return is_wp_error( $description ) ? '' : $description;
}
/**
$id = (int) $id;
- if ( ! $id && ! in_the_loop() )
- return false; // in-the-loop function
-
- if ( !$id )
- $id = (int) $post->ID;
+ if ( !$id ) {
+ if ( !$post->ID )
+ return false;
+ else
+ $id = (int) $post->ID;
+ }
$terms = get_object_term_cache( $id, $taxonomy );
if ( false === $terms )
}
/**
- * Retrieve terms as a list with specified format.
+ * Retrieve a post's terms as a list with specified format.
*
* @since 2.5.0
*
- * @param int $id Term ID.
+ * @param int $id Post 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.
*/
-function the_terms( $id, $taxonomy, $before = '', $sep = '', $after = '' ) {
- $return = get_the_term_list( $id, $taxonomy, $before, $sep, $after );
- if ( is_wp_error( $return ) )
+function the_terms( $id, $taxonomy, $before = '', $sep = ', ', $after = '' ) {
+ $term_list = get_the_term_list( $id, $taxonomy, $before, $sep, $after );
+
+ if ( is_wp_error( $term_list ) )
return false;
- else
- echo $return;
+
+ echo apply_filters('the_terms', $term_list, $taxonomy, $before, $sep, $after);
}
/**
return $r;
}
-?>
+?>
\ No newline at end of file