X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/11be8dc178e77d0b46189bbd8e33a216a9b90942..8a4706fdeb1ae30268e510df6ccf3c39b3028059:/wp-includes/category.php diff --git a/wp-includes/category.php b/wp-includes/category.php index fb81dfb2..adac2475 100644 --- a/wp-includes/category.php +++ b/wp-includes/category.php @@ -15,7 +15,7 @@ */ function get_all_category_ids() { if ( ! $cat_ids = wp_cache_get( 'all_category_ids', 'category' ) ) { - $cat_ids = get_terms( 'category', 'fields=ids&get=all' ); + $cat_ids = get_terms( 'category', array('fields' => 'ids', 'get' => 'all') ); wp_cache_add( 'all_category_ids', $cat_ids, 'category' ); } @@ -36,13 +36,18 @@ function get_all_category_ids() { * @param string|array $args Optional. Change the defaults retrieving categories. * @return array List of categories. */ -function &get_categories( $args = '' ) { - $defaults = array( 'type' => 'category' ); +function get_categories( $args = '' ) { + $defaults = array( 'taxonomy' => 'category' ); $args = wp_parse_args( $args, $defaults ); - $taxonomy = apply_filters( 'get_categories_taxonomy', 'category', $args ); - if ( 'link' == $args['type'] ) - $taxonomy = 'link_category'; + $taxonomy = apply_filters( 'get_categories_taxonomy', $args['taxonomy'], $args ); + + // Back compat + if ( isset($args['type']) && 'link' == $args['type'] ) { + _deprecated_argument( __FUNCTION__, '3.0', '' ); + $taxonomy = $args['taxonomy'] = 'link_category'; + } + $categories = (array) get_terms( $taxonomy, $args ); foreach ( array_keys( $categories ) as $k ) @@ -73,7 +78,7 @@ function &get_categories( $args = '' ) { * @param string $filter Optional. Default is raw or no WordPress defined filter will applied. * @return mixed Category data in type defined by $output parameter. */ -function &get_category( $category, $output = OBJECT, $filter = 'raw' ) { +function get_category( $category, $output = OBJECT, $filter = 'raw' ) { $category = get_term( $category, 'category', $output, $filter ); if ( is_wp_error( $category ) ) return $category; @@ -98,7 +103,7 @@ function &get_category( $category, $output = OBJECT, $filter = 'raw' ) { * @since 2.1.0 * * @param string $category_path URL containing category slugs. - * @param bool $full_match Optional. Whether should match full path or not. + * @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. */ @@ -113,7 +118,7 @@ function get_category_by_path( $category_path, $full_match = true, $output = OBJ foreach ( (array) $category_paths as $pathdir ) $full_path .= ( $pathdir != '' ? '/' : '' ) . sanitize_title( $pathdir ); - $categories = get_terms( 'category', "get=all&slug=$leaf_path" ); + $categories = get_terms( 'category', array('get' => 'all', 'slug' => $leaf_path) ); if ( empty( $categories ) ) return null; @@ -155,53 +160,37 @@ function get_category_by_slug( $slug ) { return $category; } - /** * Retrieve the ID of a category from its name. * * @since 1.0.0 * - * @param string $cat_name Optional. Default is 'General' and can be any category name. + * @param string $cat_name Category name. * @return int 0, if failure and ID of category on success. */ -function get_cat_ID( $cat_name='General' ) { +function get_cat_ID( $cat_name ) { $cat = get_term_by( 'name', $cat_name, 'category' ); if ( $cat ) return $cat->term_id; return 0; } - -/** - * Retrieve the category name by the category ID. - * - * @since 0.71 - * @deprecated Use get_cat_name() - * @see get_cat_name() get_catname() is deprecated in favor of get_cat_name(). - * - * @param int $cat_ID Category ID - * @return string category name - */ -function get_catname( $cat_ID ) { - return get_cat_name( $cat_ID ); -} - - /** * Retrieve the name of a category from its ID. * * @since 1.0.0 * * @param int $cat_id Category ID - * @return string Category name + * @return string Category name, or an empty string if category doesn't exist. */ function get_cat_name( $cat_id ) { $cat_id = (int) $cat_id; - $category = &get_category( $cat_id ); + $category = get_category( $cat_id ); + if ( ! $category || is_wp_error( $category ) ) + return ''; return $category->name; } - /** * Check if a category is an ancestor of another category. * @@ -215,21 +204,9 @@ function get_cat_name( $cat_id ) { * @return bool Whether $cat2 is child of $cat1 */ function cat_is_ancestor_of( $cat1, $cat2 ) { - if ( is_int( $cat1 ) ) - $cat1 = &get_category( $cat1 ); - if ( is_int( $cat2 ) ) - $cat2 = &get_category( $cat2 ); - - if ( !$cat1->term_id || !$cat2->parent ) - return false; - - if ( $cat2->parent == $cat1->term_id ) - return true; - - return cat_is_ancestor_of( $cat1, get_category( $cat2->parent ) ); + return term_is_ancestor_of( $cat1, $cat2, 'category' ); } - /** * Sanitizes category data based on context. * @@ -244,7 +221,6 @@ function sanitize_category( $category, $context = 'display' ) { return sanitize_term( $category, 'category', $context ); } - /** * Sanitizes data in single category key field. * @@ -263,7 +239,6 @@ function sanitize_category_field( $field, $value, $cat_id, $context ) { /* Tags */ - /** * Retrieves all post tags. * @@ -274,7 +249,7 @@ function sanitize_category_field( $field, $value, $cat_id, $context ) { * @param string|array $args Tag arguments to use when retrieving tags. * @return array List of tags. */ -function &get_tags( $args = '' ) { +function get_tags( $args = '' ) { $tags = get_terms( 'post_tag', $args ); if ( empty( $tags ) ) { @@ -286,7 +261,6 @@ function &get_tags( $args = '' ) { return $tags; } - /** * Retrieve post tag by tag ID or tag object. * @@ -306,30 +280,12 @@ function &get_tags( $args = '' ) { * @param string $filter Optional. Default is raw or no WordPress defined filter will applied. * @return object|array Return type based on $output value. */ -function &get_tag( $tag, $output = OBJECT, $filter = 'raw' ) { +function get_tag( $tag, $output = OBJECT, $filter = 'raw' ) { return get_term( $tag, 'post_tag', $output, $filter ); } - /* Cache */ - -/** - * Update the categories cache. - * - * This function does not appear to be used anymore or does not appear to be - * needed. It might be a legacy function left over from when there was a need - * for updating the category cache. - * - * @since 1.5.0 - * - * @return bool Always return True - */ -function update_category_cache() { - return true; -} - - /** * Remove the category cache data based on ID. * @@ -342,7 +298,6 @@ function clean_category_cache( $id ) { clean_term_cache( $id, 'category' ); } - /** * Update category structure to old pre 2.3 from new taxonomy structure. * @@ -379,6 +334,3 @@ function _make_cat_compat( &$category ) { $category['category_parent'] = &$category['parent']; } } - - -?>