enmi-conf.org: comparison wp/wp-includes/category.php

equal deleted inserted replaced

-:346c88efed21
+:5e2f62d02dcd
 /**
 * WordPress Category API
 *
 * @package WordPress
 */
-/**
-* Retrieves all category IDs.
-*
-* @since 2.0.0
-* @link http://codex.wordpress.org/Function_Reference/get_all_category_ids
-*
-* @return object List of all of the category IDs.
-*/
-function get_all_category_ids() {
-	if ( ! $cat_ids = wp_cache_get( 'all_category_ids', 'category' ) ) {
-		$cat_ids = get_terms( 'category', array('fields' => 'ids', 'get' => 'all') );
-		wp_cache_add( 'all_category_ids', $cat_ids, 'category' );
-	}
-	return $cat_ids;
-}
 /**
 * Retrieve list of category objects.
 *
 * If you change the type to 'link' in the arguments, then the link categories
 * will be returned instead. Also all categories will be updated to be backwards
 * compatible with pre-2.3 plugins and themes.
 *
 * @since 2.1.0
 * @see get_terms() Type of arguments that can be changed.
-* @link http://codex.wordpress.org/Function_Reference/get_categories
+* @link https://codex.wordpress.org/Function_Reference/get_categories
 *
 * @param string|array $args Optional. Change the defaults retrieving categories.
 * @return array List of categories.
 */
 function get_categories( $args = '' ) {
 	$defaults = array( 'taxonomy' => 'category' );
 	$args = wp_parse_args( $args, $defaults );
 	$taxonomy = $args['taxonomy'];
 	/**
-	 * Filter the taxonomy used to retrieve terms when calling get_categories().
+	 * Filter the taxonomy used to retrieve terms when calling {@see get_categories()}.
 	 *
 	 * @since 2.7.0
 	 *
 	 * @param string $taxonomy Taxonomy to retrieve terms from.
-	 * @param array  $args     An array of arguments. @see get_terms()
+	 * @param array  $args     An array of arguments. See {@see get_terms()}.
 	 */
 	$taxonomy = apply_filters( 'get_categories_taxonomy', $taxonomy, $args );
 	// Back compat
 	if ( isset($args['type']) && 'link' == $args['type'] ) {
 * filters and finally sanitized based on the $filter parameter value.
 *
 * The category will converted to maintain backwards compatibility.
 *
 * @since 1.5.1
-* @uses get_term() Used to get the category data from the taxonomy.
 *
 * @param int|object $category Category ID or Category row object
 * @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
 * @param string $filter Optional. Default is raw or no WordPress defined filter will applied.
-* @return mixed Category data in type defined by $output parameter.
+* @return object|array|WP_Error|null Category data in type defined by $output parameter. WP_Error if $category is empty, null if it does not exist.
 */
 function get_category( $category, $output = OBJECT, $filter = 'raw' ) {
 	$category = get_term( $category, 'category', $output, $filter );
 	if ( is_wp_error( $category ) )
 		return $category;
 	_make_cat_compat( $category );
 /**
 * Sanitizes category data based on context.
 *
 * @since 2.3.0
-* @uses sanitize_term() See this function for what context are supported.
 *
 * @param object|array $category Category data
 * @param string $context Optional. Default is 'display'.
 * @return object|array Same type as $category with sanitized data for safe use.
 */
 /**
 * Sanitizes data in single category key field.
 *
 * @since 2.3.0
-* @uses sanitize_term_field() See function for more details.
 *
 * @param string $field Category key to sanitize
 * @param mixed $value Category value to sanitize
 * @param int $cat_id Category ID
 * @param string $context What filter to use, 'raw', 'display', etc.
 /**
 * Retrieves all post tags.
 *
 * @since 2.3.0
 * @see get_terms() For list of arguments to pass.
-* @uses apply_filters() Calls 'get_tags' hook on array of tags and with $args.
 *
 * @param string|array $args Tag arguments to use when retrieving tags.
 * @return array List of tags.
 */
 function get_tags( $args = '' ) {
 * @since 2.3.0
 *
 * @param int|object $tag
 * @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
 * @param string $filter Optional. Default is raw or no WordPress defined filter will applied.
-* @return object|array Return type based on $output value.
+* @return object|array|WP_Error|null Tag data in type defined by $output parameter. WP_Error if $tag is empty, null if it does not exist.
 */
 function get_tag( $tag, $output = OBJECT, $filter = 'raw' ) {
 	return get_term( $tag, 'post_tag', $output, $filter );
 }
 /**
 * Remove the category cache data based on ID.
 *
 * @since 2.1.0
-* @uses clean_term_cache() Clears the cache for the category based on ID
 *
 * @param int $id Category ID
 */
 function clean_category_cache( $id ) {
 	clean_term_cache( $id, 'category' );

changeset 5	5e2f62d02dcd
parent 0	d970ebf37754
child 7	cf61fcea0001