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

equal deleted inserted replaced

-:490d5cc509ed
+:cf61fcea0001
 <?php
 /**
-* WordPress Category API
+* Taxonomy API: Core category-specific functionality
 *
 * @package WordPress
+* @subpackage Taxonomy
 */
 /**
 * 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
+* will be returned instead. Also all categories will be updated to be backward
 * compatible with pre-2.3 plugins and themes.
 *
 * @since 2.1.0
 * @see get_terms() Type of arguments that can be changed.
-* @link https://codex.wordpress.org/Function_Reference/get_categories
+*
-*
+* @param string|array $args {
-* @param string|array $args Optional. Change the defaults retrieving categories.
+*     Optional. Arguments to retrieve categories. See get_terms() for additional options.
+*
+*     @type string $taxonomy Taxonomy to retrieve terms for. In this case, default 'category'.
+* }
 * @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 {@see get_categories()}.
+	 * Filters the taxonomy used to retrieve terms when calling get_categories().
 	 *
 	 * @since 2.7.0
 	 *
 	 * @param string $taxonomy Taxonomy to retrieve terms from.
-	 * @param array  $args     An array of arguments. See {@see get_terms()}.
+	 * @param array  $args     An array of arguments. See get_terms().
 	 */
 	$taxonomy = apply_filters( 'get_categories_taxonomy', $taxonomy, $args );
 	// Back compat
 	if ( isset($args['type']) && 'link' == $args['type'] ) {
-		_deprecated_argument( __FUNCTION__, '3.0', '' );
+		_deprecated_argument( __FUNCTION__, '3.0.0',
+			/* translators: 1: "type => link", 2: "taxonomy => link_category" */
+			sprintf( __( '%1$s is deprecated. Use %2$s instead.' ),
+				'<code>type => link</code>',
+				'<code>taxonomy => link_category</code>'
+			)
+		);
 		$taxonomy = $args['taxonomy'] = 'link_category';
 	}
-	$categories = (array) get_terms( $taxonomy, $args );
+	$categories = get_terms( $taxonomy, $args );
-	foreach ( array_keys( $categories ) as $k )
+	if ( is_wp_error( $categories ) ) {
-		_make_cat_compat( $categories[$k] );
+		$categories = array();
+	} else {
+		$categories = (array) $categories;
+		foreach ( array_keys( $categories ) as $k ) {
+			_make_cat_compat( $categories[ $k ] );
+		}
+	}
 	return $categories;
 }
 /**
 * be retrieved from the database, if it isn't already cached, and pass it back.
 *
 * If you look at get_term(), then both types will be passed through several
 * filters and finally sanitized based on the $filter parameter value.
 *
-* The category will converted to maintain backwards compatibility.
+* The category will converted to maintain backward compatibility.
 *
 * @since 1.5.1
 *
 * @param int|object $category Category ID or Category row object
-* @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
+* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a
+*                       WP_Term object, an associative array, or a numeric array, respectively. Default OBJECT.
 * @param string $filter Optional. Default is raw or no WordPress defined filter will applied.
-* @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.
+* @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 ) )
 * for it when using this function.
 *
 * @since 2.1.0
 *
 * @param string $category_path URL containing category slugs.
-* @param bool $full_match Optional. Whether full path should be matched.
+* @param bool   $full_match    Optional. Whether full path should be matched.
-* @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
+* @param string $output        Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
-* @return null|object|array Null on failure. Type is based on $output value.
+*                              a WP_Term object, an associative array, or a numeric array, respectively. Default OBJECT.
+* @return WP_Term|array|WP_Error|null Type is based on $output value.
 */
 function get_category_by_path( $category_path, $full_match = true, $output = OBJECT ) {
 	$category_path = rawurlencode( urldecode( $category_path ) );
 	$category_path = str_replace( '%2F', '/', $category_path );
 	$category_path = str_replace( '%20', ' ', $category_path );
 	$category_paths = '/' . trim( $category_path, '/' );
 	$leaf_path  = sanitize_title( basename( $category_paths ) );
 	$category_paths = explode( '/', $category_paths );
 	$full_path = '';
-	foreach ( (array) $category_paths as $pathdir )
+	foreach ( (array) $category_paths as $pathdir ) {
 		$full_path .= ( $pathdir != '' ? '/' : '' ) . sanitize_title( $pathdir );
+	}
 	$categories = get_terms( 'category', array('get' => 'all', 'slug' => $leaf_path) );
-	if ( empty( $categories ) )
+	if ( empty( $categories ) ) {
-		return null;
+		return;
+	}
 	foreach ( $categories as $category ) {
 		$path = '/' . $leaf_path;
 		$curcategory = $category;
 		while ( ( $curcategory->parent != 0 ) && ( $curcategory->parent != $curcategory->term_id ) ) {
 			$curcategory = get_term( $curcategory->parent, 'category' );
-			if ( is_wp_error( $curcategory ) )
+			if ( is_wp_error( $curcategory ) ) {
 				return $curcategory;
+			}
 			$path = '/' . $curcategory->slug . $path;
 		}
 		if ( $path == $full_path ) {
 			$category = get_term( $category->term_id, 'category', $output );
 	if ( ! $full_match ) {
 		$category = get_term( reset( $categories )->term_id, 'category', $output );
 		_make_cat_compat( $category );
 		return $category;
 	}
-	return null;
 }
 /**
 * Retrieve category object by category slug.
 *
 		$return = array();
 		return $return;
 	}
 	/**
-	 * Filter the array of term objects returned for the 'post_tag' taxonomy.
+	 * Filters the array of term objects returned for the 'post_tag' taxonomy.
 	 *
 	 * @since 2.3.0
 	 *
 	 * @param array $tags Array of 'post_tag' term objects.
 	 * @param array $args An array of arguments. @see get_terms()
 * If you look at get_term(), then both types will be passed through several
 * filters and finally sanitized based on the $filter parameter value.
 *
 * @since 2.3.0
 *
-* @param int|object $tag
+* @param int|WP_Term|object $tag    A tag ID or object.
-* @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
+* @param string             $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
-* @param string $filter Optional. Default is raw or no WordPress defined filter will applied.
+*                                   a WP_Term object, an associative array, or a numeric array, respectively. Default OBJECT.
-* @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.
+* @param string             $filter Optional. Default is raw or no WordPress defined filter will applied.
+* @return WP_Term|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 );
 }
 *
 * There is no return value, because everything is updated on the variable you
 * pass to it. This is one of the features with using pass by reference in PHP.
 *
 * @since 2.3.0
+* @since 4.4.0 The `$category` parameter now also accepts a WP_Term object.
 * @access private
 *
-* @param array|object $category Category Row object or array
+* @param array|object|WP_Term $category Category Row object or array
 */
 function _make_cat_compat( &$category ) {
-	if ( is_object( $category ) ) {
+	if ( is_object( $category ) && ! is_wp_error( $category ) ) {
-		$category->cat_ID = &$category->term_id;
+		$category->cat_ID = $category->term_id;
-		$category->category_count = &$category->count;
+		$category->category_count = $category->count;
-		$category->category_description = &$category->description;
+		$category->category_description = $category->description;
-		$category->cat_name = &$category->name;
+		$category->cat_name = $category->name;
-		$category->category_nicename = &$category->slug;
+		$category->category_nicename = $category->slug;
-		$category->category_parent = &$category->parent;
+		$category->category_parent = $category->parent;
 	} elseif ( is_array( $category ) && isset( $category['term_id'] ) ) {
 		$category['cat_ID'] = &$category['term_id'];
 		$category['category_count'] = &$category['count'];
 		$category['category_description'] = &$category['description'];
 		$category['cat_name'] = &$category['name'];

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 9	177826044cd9