';
-
- return $output;
-}
-
-/**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $checked
- * @param unknown_type $current
- */
-function checked( $checked, $current) {
- if ( $checked == $current)
- echo ' checked="checked"';
-}
-
-/**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $selected
- * @param unknown_type $current
- */
-function selected( $selected, $current) {
- if ( $selected == $current)
- echo ' selected="selected"';
-}
-
//
// Category Checklists
//
/**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- * @deprecated Use {@link wp_link_category_checklist()}
- * @see wp_link_category_checklist()
- *
- * @param unknown_type $default
- * @param unknown_type $parent
- * @param unknown_type $popular_ids
- */
-function dropdown_categories( $default = 0, $parent = 0, $popular_ids = array() ) {
- global $post_ID;
- wp_category_checklist($post_ID);
-}
-
-/**
- * {@internal Missing Short Description}}
+ * Walker to output an unordered list of category checkbox elements.
*
- * @since unknown
+ * @see Walker
+ * @see wp_category_checklist()
+ * @see wp_terms_checklist()
+ * @since 2.5.1
*/
class Walker_Category_Checklist extends Walker {
var $tree_type = 'category';
var $db_fields = array ('parent' => 'parent', 'id' => 'term_id'); //TODO: decouple this
- function start_lvl(&$output, $depth, $args) {
+ /**
+ * Starts the list before the elements are added.
+ *
+ * @see Walker:start_lvl()
+ *
+ * @since 2.5.1
+ *
+ * @param string $output Passed by reference. Used to append additional content.
+ * @param int $depth Depth of category. Used for tab indentation.
+ * @param array $args An array of arguments. @see wp_terms_checklist()
+ */
+ function start_lvl( &$output, $depth = 0, $args = array() ) {
$indent = str_repeat("\t", $depth);
$output .= "$indent
\n";
}
- function end_lvl(&$output, $depth, $args) {
+ /**
+ * Ends the list of after the elements are added.
+ *
+ * @see Walker::end_lvl()
+ *
+ * @since 2.5.1
+ *
+ * @param string $output Passed by reference. Used to append additional content.
+ * @param int $depth Depth of category. Used for tab indentation.
+ * @param array $args An array of arguments. @see wp_terms_checklist()
+ */
+ function end_lvl( &$output, $depth = 0, $args = array() ) {
$indent = str_repeat("\t", $depth);
$output .= "$indent
\n";
}
- function start_el(&$output, $category, $depth, $args) {
+ /**
+ * Start the element output.
+ *
+ * @see Walker::start_el()
+ *
+ * @since 2.5.1
+ *
+ * @param string $output Passed by reference. Used to append additional content.
+ * @param object $category The current term object.
+ * @param int $depth Depth of the term in reference to parents. Default 0.
+ * @param array $args An array of arguments. @see wp_terms_checklist()
+ * @param int $id ID of the current term.
+ */
+ function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
extract($args);
+ if ( empty($taxonomy) )
+ $taxonomy = 'category';
+
+ if ( $taxonomy == 'category' )
+ $name = 'post_category';
+ else
+ $name = 'tax_input['.$taxonomy.']';
$class = in_array( $category->term_id, $popular_cats ) ? ' class="popular-category"' : '';
- $output .= "\n
" . '';
+ $output .= "\n
" . '';
}
- function end_el(&$output, $category, $depth, $args) {
+ /**
+ * Ends the element output, if needed.
+ *
+ * @see Walker::end_el()
+ *
+ * @since 2.5.1
+ *
+ * @param string $output Passed by reference. Used to append additional content.
+ * @param object $category The current term object.
+ * @param int $depth Depth of the term in reference to parents. Default 0.
+ * @param array $args An array of arguments. @see wp_terms_checklist()
+ */
+ function end_el( &$output, $category, $depth = 0, $args = array() ) {
$output .= "
\n";
}
}
/**
- * {@internal Missing Short Description}}
+ * Output an unordered list of checkbox elements labelled
+ * with category names.
+ *
+ * @see wp_terms_checklist()
+ * @since 2.5.1
+ *
+ * @param int $post_id Mark categories associated with this post as checked. $selected_cats must not be an array.
+ * @param int $descendants_and_self ID of the category to output along with its descendents.
+ * @param bool|array $selected_cats List of categories to mark as checked.
+ * @param bool|array $popular_cats Override the list of categories that receive the "popular-category" class.
+ * @param object $walker Walker object to use to build the output.
+ * @param bool $checked_ontop Move checked items out of the hierarchy and to the top of the list.
+ */
+function wp_category_checklist( $post_id = 0, $descendants_and_self = 0, $selected_cats = false, $popular_cats = false, $walker = null, $checked_ontop = true ) {
+ wp_terms_checklist( $post_id, array(
+ 'taxonomy' => 'category',
+ 'descendants_and_self' => $descendants_and_self,
+ 'selected_cats' => $selected_cats,
+ 'popular_cats' => $popular_cats,
+ 'walker' => $walker,
+ 'checked_ontop' => $checked_ontop
+ ) );
+}
+
+/**
+ * Output an unordered list of checkbox elements labelled
+ * with term names. Taxonomy independent version of wp_category_checklist().
*
- * @since unknown
+ * @since 3.0.0
*
- * @param unknown_type $post_id
- * @param unknown_type $descendants_and_self
- * @param unknown_type $selected_cats
- * @param unknown_type $popular_cats
+ * @param int $post_id
+ * @param array $args
*/
-function wp_category_checklist( $post_id = 0, $descendants_and_self = 0, $selected_cats = false, $popular_cats = false, $walker = null ) {
+function wp_terms_checklist($post_id = 0, $args = array()) {
+ $defaults = array(
+ 'descendants_and_self' => 0,
+ 'selected_cats' => false,
+ 'popular_cats' => false,
+ 'walker' => null,
+ 'taxonomy' => 'category',
+ 'checked_ontop' => true
+ );
+ $args = apply_filters( 'wp_terms_checklist_args', $args, $post_id );
+
+ extract( wp_parse_args($args, $defaults), EXTR_SKIP );
+
if ( empty($walker) || !is_a($walker, 'Walker') )
$walker = new Walker_Category_Checklist;
$descendants_and_self = (int) $descendants_and_self;
- $args = array();
+ $args = array('taxonomy' => $taxonomy);
+
+ $tax = get_taxonomy($taxonomy);
+ $args['disabled'] = !current_user_can($tax->cap->assign_terms);
if ( is_array( $selected_cats ) )
$args['selected_cats'] = $selected_cats;
elseif ( $post_id )
- $args['selected_cats'] = wp_get_post_categories($post_id);
+ $args['selected_cats'] = wp_get_object_terms($post_id, $taxonomy, array_merge($args, array('fields' => 'ids')));
else
$args['selected_cats'] = array();
if ( is_array( $popular_cats ) )
$args['popular_cats'] = $popular_cats;
else
- $args['popular_cats'] = get_terms( 'category', array( 'fields' => 'ids', 'orderby' => 'count', 'order' => 'DESC', 'number' => 10, 'hierarchical' => false ) );
-
- if ( $descendants_and_self ) {
- $categories = get_categories( "child_of=$descendants_and_self&hierarchical=0&hide_empty=0" );
- $self = get_category( $descendants_and_self );
- array_unshift( $categories, $self );
- } else {
- $categories = get_categories('get=all');
- }
-
- // Post process $categories rather than adding an exclude to the get_terms() query to keep the query the same across all posts (for any query cache)
- $checked_categories = array();
- for ( $i = 0; isset($categories[$i]); $i++ ) {
- if ( in_array($categories[$i]->term_id, $args['selected_cats']) ) {
- $checked_categories[] = $categories[$i];
- unset($categories[$i]);
- }
- }
-
- // Put checked cats on top
- echo call_user_func_array(array(&$walker, 'walk'), array($checked_categories, 0, $args));
- // Then the rest of them
- echo call_user_func_array(array(&$walker, 'walk'), array($categories, 0, $args));
-}
-
-/**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $taxonomy
- * @param unknown_type $default
- * @param unknown_type $number
- * @param unknown_type $echo
- * @return unknown
- */
-function wp_popular_terms_checklist( $taxonomy, $default = 0, $number = 10, $echo = true ) {
- global $post_ID;
- if ( $post_ID )
- $checked_categories = wp_get_post_categories($post_ID);
- else
- $checked_categories = array();
- $categories = get_terms( $taxonomy, array( 'orderby' => 'count', 'order' => 'DESC', 'number' => $number, 'hierarchical' => false ) );
-
- $popular_ids = array();
- foreach ( (array) $categories as $category ) {
- $popular_ids[] = $category->term_id;
- if ( !$echo ) // hack for AJAX use
- continue;
- $id = "popular-category-$category->term_id";
- ?>
-
-
";
+ if ( $checked_ontop ) {
+ // Post process $categories rather than adding an exclude to the get_terms() query to keep the query the same across all posts (for any query cache)
+ $checked_categories = array();
+ $keys = array_keys( $categories );
+
+ foreach( $keys as $k ) {
+ if ( in_array( $categories[$k]->term_id, $args['selected_cats'] ) ) {
+ $checked_categories[] = $categories[$k];
+ unset( $categories[$k] );
+ }
}
- }
- $r .= '
';
- return $r;
+ // Put checked cats on top
+ echo call_user_func_array(array(&$walker, 'walk'), array($checked_categories, 0, $args));
+ }
+ // Then the rest of them
+ echo call_user_func_array(array(&$walker, 'walk'), array($categories, 0, $args));
}
/**
- * {@internal Missing Short Description}}
+ * Retrieve a list of the most popular terms from the specified taxonomy.
*
- * @since unknown
+ * If the $echo argument is true then the elements for a list of checkbox
+ * elements labelled with the names of the selected terms is output.
+ * If the $post_ID global isn't empty then the terms associated with that
+ * post will be marked as checked.
*
- * @param unknown_type $status
- * @param unknown_type $s
- * @param unknown_type $start
- * @param unknown_type $num
- * @param unknown_type $post
- * @param unknown_type $type
- * @return unknown
+ * @since 2.5.0
+ *
+ * @param string $taxonomy Taxonomy to retrieve terms from.
+ * @param int $default Unused.
+ * @param int $number Number of terms to retrieve. Defaults to 10.
+ * @param bool $echo Optionally output the list as well. Defaults to true.
+ * @return array List of popular term IDs.
*/
-function _wp_get_comment_list( $status = '', $s = false, $start, $num, $post = 0, $type = '' ) {
- global $wpdb;
-
- $start = abs( (int) $start );
- $num = (int) $num;
- $post = (int) $post;
+function wp_popular_terms_checklist( $taxonomy, $default = 0, $number = 10, $echo = true ) {
+ $post = get_post();
- if ( 'moderated' == $status )
- $approved = "comment_approved = '0'";
- elseif ( 'approved' == $status )
- $approved = "comment_approved = '1'";
- elseif ( 'spam' == $status )
- $approved = "comment_approved = 'spam'";
+ if ( $post && $post->ID )
+ $checked_terms = wp_get_object_terms($post->ID, $taxonomy, array('fields'=>'ids'));
else
- $approved = "( comment_approved = '0' OR comment_approved = '1' )";
+ $checked_terms = array();
- if ( $post ) {
- $post = " AND comment_post_ID = '$post'";
- $orderby = "ORDER BY comment_date_gmt ASC LIMIT $start, $num";
- } else {
- $post = '';
- $orderby = "ORDER BY comment_date_gmt DESC LIMIT $start, $num";
+ $terms = get_terms( $taxonomy, array( 'orderby' => 'count', 'order' => 'DESC', 'number' => $number, 'hierarchical' => false ) );
+
+ $tax = get_taxonomy($taxonomy);
+
+ $popular_ids = array();
+ foreach ( (array) $terms as $term ) {
+ $popular_ids[] = $term->term_id;
+ if ( !$echo ) // hack for AJAX use
+ continue;
+ $id = "popular-$taxonomy-$term->term_id";
+ $checked = in_array( $term->term_id, $checked_terms ) ? 'checked="checked"' : '';
+ ?>
+
+
