wp-includes/category.php

   1 <?php
   2 /**
   3  * Taxonomy API: Core category-specific functionality
   4  *
   5  * @package WordPress
   6  * @subpackage Taxonomy
   7  */
   8
   9 /**
  10  * Retrieve list of category objects.
  11  *
  12  * If you change the type to 'link' in the arguments, then the link categories
  13  * will be returned instead. Also all categories will be updated to be backward
  14  * compatible with pre-2.3 plugins and themes.
  15  *
  16  * @since 2.1.0
  17  * @see get_terms() Type of arguments that can be changed.
  18  *
  19  * @param string|array $args {
  20  *     Optional. Arguments to retrieve categories. See get_terms() for additional options.
  21  *
  22  *     @type string $taxonomy Taxonomy to retrieve terms for. In this case, default 'category'.
  23  * }
  24  * @return array List of categories.
  25  */
  26 function get_categories( $args = '' ) {
  27         $defaults = array( 'taxonomy' => 'category' );
  28         $args = wp_parse_args( $args, $defaults );
  29
  30         $taxonomy = $args['taxonomy'];
  31
  32         /**
  33          * Filters the taxonomy used to retrieve terms when calling get_categories().
  34          *
  35          * @since 2.7.0
  36          *
  37          * @param string $taxonomy Taxonomy to retrieve terms from.
  38          * @param array  $args     An array of arguments. See get_terms().
  39          */
  40         $taxonomy = apply_filters( 'get_categories_taxonomy', $taxonomy, $args );
  41
  42         // Back compat
  43         if ( isset($args['type']) && 'link' == $args['type'] ) {
  44                 /* translators: 1: "type => link", 2: "taxonomy => link_category" alternative */
  45                 _deprecated_argument( __FUNCTION__, '3.0.0',
  46                         sprintf( __( '%1$s is deprecated. Use %2$s instead.' ),
  47                                 '<code>type => link</code>',
  48                                 '<code>taxonomy => link_category</code>'
  49                         )
  50                 );
  51                 $taxonomy = $args['taxonomy'] = 'link_category';
  52         }
  53
  54         $categories = get_terms( $taxonomy, $args );
  55
  56         if ( is_wp_error( $categories ) ) {
  57                 $categories = array();
  58         } else {
  59                 $categories = (array) $categories;
  60                 foreach ( array_keys( $categories ) as $k ) {
  61                         _make_cat_compat( $categories[ $k ] );
  62                 }
  63         }
  64
  65         return $categories;
  66 }
  67
  68 /**
  69  * Retrieves category data given a category ID or category object.
  70  *
  71  * If you pass the $category parameter an object, which is assumed to be the
  72  * category row object retrieved the database. It will cache the category data.
  73  *
  74  * If you pass $category an integer of the category ID, then that category will
  75  * be retrieved from the database, if it isn't already cached, and pass it back.
  76  *
  77  * If you look at get_term(), then both types will be passed through several
  78  * filters and finally sanitized based on the $filter parameter value.
  79  *
  80  * The category will converted to maintain backward compatibility.
  81  *
  82  * @since 1.5.1
  83  *
  84  * @param int|object $category Category ID or Category row object
  85  * @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a
  86  *                       WP_Term object, an associative array, or a numeric array, respectively. Default OBJECT.
  87  * @param string $filter Optional. Default is raw or no WordPress defined filter will applied.
  88  * @return object|array|WP_Error|null Category data in type defined by $output parameter.
  89  *                                    WP_Error if $category is empty, null if it does not exist.
  90  */
  91 function get_category( $category, $output = OBJECT, $filter = 'raw' ) {
  92         $category = get_term( $category, 'category', $output, $filter );
  93
  94         if ( is_wp_error( $category ) )
  95                 return $category;
  96
  97         _make_cat_compat( $category );
  98
  99         return $category;
 100 }
 101
 102 /**
 103  * Retrieve category based on URL containing the category slug.
 104  *
 105  * Breaks the $category_path parameter up to get the category slug.
 106  *
 107  * Tries to find the child path and will return it. If it doesn't find a
 108  * match, then it will return the first category matching slug, if $full_match,
 109  * is set to false. If it does not, then it will return null.
 110  *
 111  * It is also possible that it will return a WP_Error object on failure. Check
 112  * for it when using this function.
 113  *
 114  * @since 2.1.0
 115  *
 116  * @param string $category_path URL containing category slugs.
 117  * @param bool   $full_match    Optional. Whether full path should be matched.
 118  * @param string $output        Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
 119  *                              a WP_Term object, an associative array, or a numeric array, respectively. Default OBJECT.
 120  * @return WP_Term|array|WP_Error|null Type is based on $output value.
 121  */
 122 function get_category_by_path( $category_path, $full_match = true, $output = OBJECT ) {
 123         $category_path = rawurlencode( urldecode( $category_path ) );
 124         $category_path = str_replace( '%2F', '/', $category_path );
 125         $category_path = str_replace( '%20', ' ', $category_path );
 126         $category_paths = '/' . trim( $category_path, '/' );
 127         $leaf_path  = sanitize_title( basename( $category_paths ) );
 128         $category_paths = explode( '/', $category_paths );
 129         $full_path = '';
 130         foreach ( (array) $category_paths as $pathdir ) {
 131                 $full_path .= ( $pathdir != '' ? '/' : '' ) . sanitize_title( $pathdir );
 132         }
 133         $categories = get_terms( 'category', array('get' => 'all', 'slug' => $leaf_path) );
 134
 135         if ( empty( $categories ) ) {
 136                 return;
 137         }
 138
 139         foreach ( $categories as $category ) {
 140                 $path = '/' . $leaf_path;
 141                 $curcategory = $category;
 142                 while ( ( $curcategory->parent != 0 ) && ( $curcategory->parent != $curcategory->term_id ) ) {
 143                         $curcategory = get_term( $curcategory->parent, 'category' );
 144                         if ( is_wp_error( $curcategory ) ) {
 145                                 return $curcategory;
 146                         }
 147                         $path = '/' . $curcategory->slug . $path;
 148                 }
 149
 150                 if ( $path == $full_path ) {
 151                         $category = get_term( $category->term_id, 'category', $output );
 152                         _make_cat_compat( $category );
 153                         return $category;
 154                 }
 155         }
 156
 157         // If full matching is not required, return the first cat that matches the leaf.
 158         if ( ! $full_match ) {
 159                 $category = get_term( reset( $categories )->term_id, 'category', $output );
 160                 _make_cat_compat( $category );
 161                 return $category;
 162         }
 163 }
 164
 165 /**
 166  * Retrieve category object by category slug.
 167  *
 168  * @since 2.3.0
 169  *
 170  * @param string $slug The category slug.
 171  * @return object Category data object
 172  */
 173 function get_category_by_slug( $slug  ) {
 174         $category = get_term_by( 'slug', $slug, 'category' );
 175         if ( $category )
 176                 _make_cat_compat( $category );
 177
 178         return $category;
 179 }
 180
 181 /**
 182  * Retrieve the ID of a category from its name.
 183  *
 184  * @since 1.0.0
 185  *
 186  * @param string $cat_name Category name.
 187  * @return int 0, if failure and ID of category on success.
 188  */
 189 function get_cat_ID( $cat_name ) {
 190         $cat = get_term_by( 'name', $cat_name, 'category' );
 191         if ( $cat )
 192                 return $cat->term_id;
 193         return 0;
 194 }
 195
 196 /**
 197  * Retrieve the name of a category from its ID.
 198  *
 199  * @since 1.0.0
 200  *
 201  * @param int $cat_id Category ID
 202  * @return string Category name, or an empty string if category doesn't exist.
 203  */
 204 function get_cat_name( $cat_id ) {
 205         $cat_id = (int) $cat_id;
 206         $category = get_term( $cat_id, 'category' );
 207         if ( ! $category || is_wp_error( $category ) )
 208                 return '';
 209         return $category->name;
 210 }
 211
 212 /**
 213  * Check if a category is an ancestor of another category.
 214  *
 215  * You can use either an id or the category object for both parameters. If you
 216  * use an integer the category will be retrieved.
 217  *
 218  * @since 2.1.0
 219  *
 220  * @param int|object $cat1 ID or object to check if this is the parent category.
 221  * @param int|object $cat2 The child category.
 222  * @return bool Whether $cat2 is child of $cat1
 223  */
 224 function cat_is_ancestor_of( $cat1, $cat2 ) {
 225         return term_is_ancestor_of( $cat1, $cat2, 'category' );
 226 }
 227
 228 /**
 229  * Sanitizes category data based on context.
 230  *
 231  * @since 2.3.0
 232  *
 233  * @param object|array $category Category data
 234  * @param string $context Optional. Default is 'display'.
 235  * @return object|array Same type as $category with sanitized data for safe use.
 236  */
 237 function sanitize_category( $category, $context = 'display' ) {
 238         return sanitize_term( $category, 'category', $context );
 239 }
 240
 241 /**
 242  * Sanitizes data in single category key field.
 243  *
 244  * @since 2.3.0
 245  *
 246  * @param string $field Category key to sanitize
 247  * @param mixed $value Category value to sanitize
 248  * @param int $cat_id Category ID
 249  * @param string $context What filter to use, 'raw', 'display', etc.
 250  * @return mixed Same type as $value after $value has been sanitized.
 251  */
 252 function sanitize_category_field( $field, $value, $cat_id, $context ) {
 253         return sanitize_term_field( $field, $value, $cat_id, 'category', $context );
 254 }
 255
 256 /* Tags */
 257
 258 /**
 259  * Retrieves all post tags.
 260  *
 261  * @since 2.3.0
 262  * @see get_terms() For list of arguments to pass.
 263  *
 264  * @param string|array $args Tag arguments to use when retrieving tags.
 265  * @return array List of tags.
 266  */
 267 function get_tags( $args = '' ) {
 268         $tags = get_terms( 'post_tag', $args );
 269
 270         if ( empty( $tags ) ) {
 271                 $return = array();
 272                 return $return;
 273         }
 274
 275         /**
 276          * Filters the array of term objects returned for the 'post_tag' taxonomy.
 277          *
 278          * @since 2.3.0
 279          *
 280          * @param array $tags Array of 'post_tag' term objects.
 281          * @param array $args An array of arguments. @see get_terms()
 282          */
 283         $tags = apply_filters( 'get_tags', $tags, $args );
 284         return $tags;
 285 }
 286
 287 /**
 288  * Retrieve post tag by tag ID or tag object.
 289  *
 290  * If you pass the $tag parameter an object, which is assumed to be the tag row
 291  * object retrieved the database. It will cache the tag data.
 292  *
 293  * If you pass $tag an integer of the tag ID, then that tag will
 294  * be retrieved from the database, if it isn't already cached, and pass it back.
 295  *
 296  * If you look at get_term(), then both types will be passed through several
 297  * filters and finally sanitized based on the $filter parameter value.
 298  *
 299  * @since 2.3.0
 300  *
 301  * @param int|WP_Term|object $tag    A tag ID or object.
 302  * @param string             $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
 303  *                                   a WP_Term object, an associative array, or a numeric array, respectively. Default OBJECT.
 304  * @param string             $filter Optional. Default is raw or no WordPress defined filter will applied.
 305  * @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.
 306  */
 307 function get_tag( $tag, $output = OBJECT, $filter = 'raw' ) {
 308         return get_term( $tag, 'post_tag', $output, $filter );
 309 }
 310
 311 /* Cache */
 312
 313 /**
 314  * Remove the category cache data based on ID.
 315  *
 316  * @since 2.1.0
 317  *
 318  * @param int $id Category ID
 319  */
 320 function clean_category_cache( $id ) {
 321         clean_term_cache( $id, 'category' );
 322 }
 323
 324 /**
 325  * Update category structure to old pre 2.3 from new taxonomy structure.
 326  *
 327  * This function was added for the taxonomy support to update the new category
 328  * structure with the old category one. This will maintain compatibility with
 329  * plugins and themes which depend on the old key or property names.
 330  *
 331  * The parameter should only be passed a variable and not create the array or
 332  * object inline to the parameter. The reason for this is that parameter is
 333  * passed by reference and PHP will fail unless it has the variable.
 334  *
 335  * There is no return value, because everything is updated on the variable you
 336  * pass to it. This is one of the features with using pass by reference in PHP.
 337  *
 338  * @since 2.3.0
 339  * @since 4.4.0 The `$category` parameter now also accepts a WP_Term object.
 340  * @access private
 341  *
 342  * @param array|object|WP_Term $category Category Row object or array
 343  */
 344 function _make_cat_compat( &$category ) {
 345         if ( is_object( $category ) && ! is_wp_error( $category ) ) {
 346                 $category->cat_ID = $category->term_id;
 347                 $category->category_count = $category->count;
 348                 $category->category_description = $category->description;
 349                 $category->cat_name = $category->name;
 350                 $category->category_nicename = $category->slug;
 351                 $category->category_parent = $category->parent;
 352         } elseif ( is_array( $category ) && isset( $category['term_id'] ) ) {
 353                 $category['cat_ID'] = &$category['term_id'];
 354                 $category['category_count'] = &$category['count'];
 355                 $category['category_description'] = &$category['description'];
 356                 $category['cat_name'] = &$category['name'];
 357                 $category['category_nicename'] = &$category['slug'];
 358                 $category['category_parent'] = &$category['parent'];
 359         }
 360 }