diff -r 3d4e9c994f10 -r a86126ab1dd4 wp/wp-includes/category.php
--- a/wp/wp-includes/category.php Tue Oct 22 16:11:46 2019 +0200
+++ b/wp/wp-includes/category.php Tue Dec 15 13:49:49 2020 +0100
@@ -7,28 +7,26 @@
*/
/**
- * Retrieve list of category objects.
+ * Retrieves a 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 backward
- * compatible with pre-2.3 plugins and themes.
+ * If you set the 'taxonomy' argument to 'link_category', the link categories
+ * will be returned instead.
*
* @since 2.1.0
+ *
* @see get_terms() Type of arguments that can be changed.
*
* @param string|array $args {
* Optional. Arguments to retrieve categories. See get_terms() for additional options.
*
- * @type string $taxonomy Taxonomy to retrieve terms for. In this case, default 'category'.
+ * @type string $taxonomy Taxonomy to retrieve terms for. Default 'category'.
* }
- * @return array List of categories.
+ * @return array List of category objects.
*/
function get_categories( $args = '' ) {
$defaults = array( 'taxonomy' => 'category' );
$args = wp_parse_args( $args, $defaults );
- $taxonomy = $args['taxonomy'];
-
/**
* Filters the taxonomy used to retrieve terms when calling get_categories().
*
@@ -37,24 +35,24 @@
* @param string $taxonomy Taxonomy to retrieve terms from.
* @param array $args An array of arguments. See get_terms().
*/
- $taxonomy = apply_filters( 'get_categories_taxonomy', $taxonomy, $args );
+ $args['taxonomy'] = apply_filters( 'get_categories_taxonomy', $args['taxonomy'], $args );
- // Back compat
- if ( isset( $args['type'] ) && 'link' == $args['type'] ) {
+ // Back compat.
+ if ( isset( $args['type'] ) && 'link' === $args['type'] ) {
_deprecated_argument(
__FUNCTION__,
'3.0.0',
- /* translators: 1: "type => link", 2: "taxonomy => link_category" */
sprintf(
+ /* translators: 1: "type => link", 2: "taxonomy => link_category" */
__( '%1$s is deprecated. Use %2$s instead.' ),
'type => link',
'taxonomy => link_category'
)
);
- $taxonomy = $args['taxonomy'] = 'link_category';
+ $args['taxonomy'] = 'link_category';
}
- $categories = get_terms( $taxonomy, $args );
+ $categories = get_terms( $args );
if ( is_wp_error( $categories ) ) {
$categories = array();
@@ -80,14 +78,13 @@
* 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 backward compatibility.
- *
* @since 1.5.1
*
- * @param int|object $category Category ID or Category row object
- * @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.
+ * @param int|object $category Category ID or category row object.
+ * @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. How to sanitize category fields. Default 'raw'.
* @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.
*/
@@ -104,7 +101,7 @@
}
/**
- * Retrieve category based on URL containing the category slug.
+ * Retrieves a category based on URL containing the category slug.
*
* Breaks the $category_path parameter up to get the category slug.
*
@@ -119,8 +116,9 @@
*
* @param string $category_path URL containing category slugs.
* @param bool $full_match Optional. Whether full path should be matched.
- * @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 $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.
* @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 ) {
@@ -131,14 +129,16 @@
$leaf_path = sanitize_title( basename( $category_paths ) );
$category_paths = explode( '/', $category_paths );
$full_path = '';
+
foreach ( (array) $category_paths as $pathdir ) {
- $full_path .= ( $pathdir != '' ? '/' : '' ) . sanitize_title( $pathdir );
+ $full_path .= ( '' !== $pathdir ? '/' : '' ) . sanitize_title( $pathdir );
}
+
$categories = get_terms(
- 'category',
array(
- 'get' => 'all',
- 'slug' => $leaf_path,
+ 'taxonomy' => 'category',
+ 'get' => 'all',
+ 'slug' => $leaf_path,
)
);
@@ -149,17 +149,20 @@
foreach ( $categories as $category ) {
$path = '/' . $leaf_path;
$curcategory = $category;
- while ( ( $curcategory->parent != 0 ) && ( $curcategory->parent != $curcategory->term_id ) ) {
+ while ( ( 0 != $curcategory->parent ) && ( $curcategory->parent != $curcategory->term_id ) ) {
$curcategory = get_term( $curcategory->parent, 'category' );
+
if ( is_wp_error( $curcategory ) ) {
return $curcategory;
}
+
$path = '/' . $curcategory->slug . $path;
}
if ( $path == $full_path ) {
$category = get_term( $category->term_id, 'category', $output );
_make_cat_compat( $category );
+
return $category;
}
}
@@ -168,20 +171,22 @@
if ( ! $full_match ) {
$category = get_term( reset( $categories )->term_id, 'category', $output );
_make_cat_compat( $category );
+
return $category;
}
}
/**
- * Retrieve category object by category slug.
+ * Retrieves a category object by category slug.
*
* @since 2.3.0
*
* @param string $slug The category slug.
- * @return object Category data object
+ * @return object|false Category data object on success, false if not found.
*/
function get_category_by_slug( $slug ) {
$category = get_term_by( 'slug', $slug, 'category' );
+
if ( $category ) {
_make_cat_compat( $category );
}
@@ -190,49 +195,53 @@
}
/**
- * Retrieve the ID of a category from its name.
+ * Retrieves the ID of a category from its name.
*
* @since 1.0.0
*
* @param string $cat_name Category name.
- * @return int 0, if failure and ID of category on success.
+ * @return int Category ID on success, 0 if the category doesn't exist.
*/
-function get_cat_ID( $cat_name ) {
+function get_cat_ID( $cat_name ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
$cat = get_term_by( 'name', $cat_name, 'category' );
+
if ( $cat ) {
return $cat->term_id;
}
+
return 0;
}
/**
- * Retrieve the name of a category from its ID.
+ * Retrieves the name of a category from its ID.
*
* @since 1.0.0
*
- * @param int $cat_id Category ID
- * @return string Category name, or an empty string if category doesn't exist.
+ * @param int $cat_id Category ID.
+ * @return string Category name, or an empty string if the category doesn't exist.
*/
function get_cat_name( $cat_id ) {
$cat_id = (int) $cat_id;
$category = get_term( $cat_id, 'category' );
+
if ( ! $category || is_wp_error( $category ) ) {
return '';
}
+
return $category->name;
}
/**
- * Check if a category is an ancestor of another category.
+ * Checks if a category is an ancestor of another category.
*
- * You can use either an id or the category object for both parameters. If you
- * use an integer the category will be retrieved.
+ * You can use either an ID or the category object for both parameters.
+ * If you use an integer, the category will be retrieved.
*
* @since 2.1.0
*
* @param int|object $cat1 ID or object to check if this is the parent category.
* @param int|object $cat2 The child category.
- * @return bool Whether $cat2 is child of $cat1
+ * @return bool Whether $cat2 is child of $cat1.
*/
function cat_is_ancestor_of( $cat1, $cat2 ) {
return term_is_ancestor_of( $cat1, $cat2, 'category' );
@@ -243,8 +252,8 @@
*
* @since 2.3.0
*
- * @param object|array $category Category data
- * @param string $context Optional. Default is 'display'.
+ * @param object|array $category Category data.
+ * @param string $context Optional. Default 'display'.
* @return object|array Same type as $category with sanitized data for safe use.
*/
function sanitize_category( $category, $context = 'display' ) {
@@ -256,9 +265,9 @@
*
* @since 2.3.0
*
- * @param string $field Category key to sanitize
- * @param mixed $value Category value to sanitize
- * @param int $cat_id Category ID
+ * @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.
* @return mixed Same type as $value after $value has been sanitized.
*/
@@ -272,50 +281,60 @@
* Retrieves all post tags.
*
* @since 2.3.0
- * @see get_terms() For list of arguments to pass.
+ *
+ * @param string|array $args {
+ * Optional. Arguments to retrieve tags. See get_terms() for additional options.
*
- * @param string|array $args Tag arguments to use when retrieving tags.
- * @return WP_Term[]|int $tags Array of 'post_tag' term objects, or a count thereof.
+ * @type string $taxonomy Taxonomy to retrieve terms for. Default 'post_tag'.
+ * }
+ * @return WP_Term[]|int|WP_Error Array of 'post_tag' term objects, a count thereof,
+ * or WP_Error if any of the taxonomies do not exist.
*/
function get_tags( $args = '' ) {
- $tags = get_terms( 'post_tag', $args );
+ $defaults = array( 'taxonomy' => 'post_tag' );
+ $args = wp_parse_args( $args, $defaults );
+
+ $tags = get_terms( $args );
if ( empty( $tags ) ) {
- $return = array();
- return $return;
+ $tags = array();
+ } else {
+ /**
+ * Filters the array of term objects returned for the 'post_tag' taxonomy.
+ *
+ * @since 2.3.0
+ *
+ * @param WP_Term[]|int|WP_Error $tags Array of 'post_tag' term objects, a count thereof,
+ * or WP_Error if any of the taxonomies do not exist.
+ * @param array $args An array of arguments. @see get_terms()
+ */
+ $tags = apply_filters( 'get_tags', $tags, $args );
}
- /**
- * Filters the array of term objects returned for the 'post_tag' taxonomy.
- *
- * @since 2.3.0
- *
- * @param WP_Term[]|int $tags Array of 'post_tag' term objects, or a count thereof.
- * @param array $args An array of arguments. @see get_terms()
- */
- $tags = apply_filters( 'get_tags', $tags, $args );
return $tags;
}
/**
- * Retrieve post tag by tag ID or tag object.
+ * Retrieves a post tag by tag ID or tag object.
*
* If you pass the $tag parameter an object, which is assumed to be the tag row
- * object retrieved the database. It will cache the tag data.
+ * object retrieved from the database, it will cache the tag data.
*
- * If you pass $tag an integer of the tag ID, then that tag will
- * be retrieved from the database, if it isn't already cached, and pass it back.
+ * If you pass $tag an integer of the tag ID, then that tag will be retrieved
+ * from the database, if it isn't already cached, and passed 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.
+ * If you look at get_term(), both types will be passed through several filters
+ * and finally sanitized based on the $filter parameter value.
*
* @since 2.3.0
*
* @param int|WP_Term|object $tag A tag ID or object.
- * @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 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.
+ * @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. How to sanitize tag fields. Default 'raw'.
+ * @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 );
@@ -324,7 +343,7 @@
/* Cache */
/**
- * Remove the category cache data based on ID.
+ * Removes the category cache data based on ID.
*
* @since 2.1.0
*
@@ -335,7 +354,7 @@
}
/**
- * Update category structure to old pre 2.3 from new taxonomy structure.
+ * Updates category structure to old pre-2.3 from new taxonomy structure.
*
* This function was added for the taxonomy support to update the new category
* structure with the old category one. This will maintain compatibility with
@@ -352,7 +371,7 @@
* @since 4.4.0 The `$category` parameter now also accepts a WP_Term object.
* @access private
*
- * @param array|object|WP_Term $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 ) && ! is_wp_error( $category ) ) {