[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> category.php (source)

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


Generated: Tue Jul 23 01:00:03 2019 Cross-referenced by PHPXref 0.7.1