[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

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

   1  <?php
   2  /**
   3   * Taxonomy API: Core category-specific template tags
   4   *
   5   * @package WordPress
   6   * @subpackage Template
   7   * @since 1.2.0
   8   */
   9  
  10  /**
  11   * Retrieves category link URL.
  12   *
  13   * @since 1.0.0
  14   * @see get_term_link()
  15   *
  16   * @param int|object $category Category ID or object.
  17   * @return string Link on success, empty string if category does not exist.
  18   */
  19  function get_category_link( $category ) {
  20      if ( ! is_object( $category ) ) {
  21          $category = (int) $category;
  22      }
  23  
  24      $category = get_term_link( $category );
  25  
  26      if ( is_wp_error( $category ) ) {
  27          return '';
  28      }
  29  
  30      return $category;
  31  }
  32  
  33  /**
  34   * Retrieves category parents with separator.
  35   *
  36   * @since 1.2.0
  37   * @since 4.8.0 The `$visited` parameter was deprecated and renamed to `$deprecated`.
  38   *
  39   * @param int $id Category ID.
  40   * @param bool $link Optional, default is false. Whether to format with link.
  41   * @param string $separator Optional, default is '/'. How to separate categories.
  42   * @param bool $nicename Optional, default is false. Whether to use nice name for display.
  43   * @param array $deprecated Not used.
  44   * @return string|WP_Error A list of category parents on success, WP_Error on failure.
  45   */
  46  function get_category_parents( $id, $link = false, $separator = '/', $nicename = false, $deprecated = array() ) {
  47  
  48      if ( ! empty( $deprecated ) ) {
  49          _deprecated_argument( __FUNCTION__, '4.8.0' );
  50      }
  51  
  52      $format = $nicename ? 'slug' : 'name';
  53  
  54      $args = array(
  55          'separator' => $separator,
  56          'link'      => $link,
  57          'format'    => $format,
  58      );
  59  
  60      return get_term_parents_list( $id, 'category', $args );
  61  }
  62  
  63  /**
  64   * Retrieves post categories.
  65   *
  66   * This tag may be used outside The Loop by passing a post id as the parameter.
  67   *
  68   * Note: This function only returns results from the default "category" taxonomy.
  69   * For custom taxonomies use get_the_terms().
  70   *
  71   * @since 0.71
  72   *
  73   * @param int $id Optional, default to current post ID. The post ID.
  74   * @return WP_Term[] Array of WP_Term objects, one for each category assigned to the post.
  75   */
  76  function get_the_category( $id = false ) {
  77      $categories = get_the_terms( $id, 'category' );
  78      if ( ! $categories || is_wp_error( $categories ) ) {
  79          $categories = array();
  80      }
  81  
  82      $categories = array_values( $categories );
  83  
  84      foreach ( array_keys( $categories ) as $key ) {
  85          _make_cat_compat( $categories[ $key ] );
  86      }
  87  
  88      /**
  89       * Filters the array of categories to return for a post.
  90       *
  91       * @since 3.1.0
  92       * @since 4.4.0 Added `$id` parameter.
  93       *
  94       * @param WP_Term[] $categories An array of categories to return for the post.
  95       * @param int|false $id         ID of the post.
  96       */
  97      return apply_filters( 'get_the_categories', $categories, $id );
  98  }
  99  
 100  /**
 101   * Retrieves category name based on category ID.
 102   *
 103   * @since 0.71
 104   *
 105   * @param int $cat_ID Category ID.
 106   * @return string|WP_Error Category name on success, WP_Error on failure.
 107   */
 108  function get_the_category_by_ID( $cat_ID ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 109      $cat_ID   = (int) $cat_ID;
 110      $category = get_term( $cat_ID );
 111  
 112      if ( is_wp_error( $category ) ) {
 113          return $category;
 114      }
 115  
 116      return ( $category ) ? $category->name : '';
 117  }
 118  
 119  /**
 120   * Retrieves category list for a post in either HTML list or custom format.
 121   *
 122   * @since 1.5.1
 123   *
 124   * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 125   *
 126   * @param string $separator Optional. Separator between the categories. By default, the links are placed
 127   *                          in an unordered list. An empty string will result in the default behavior.
 128   * @param string $parents Optional. How to display the parents.
 129   * @param int $post_id Optional. Post ID to retrieve categories.
 130   * @return string
 131   */
 132  function get_the_category_list( $separator = '', $parents = '', $post_id = false ) {
 133      global $wp_rewrite;
 134      if ( ! is_object_in_taxonomy( get_post_type( $post_id ), 'category' ) ) {
 135          /** This filter is documented in wp-includes/category-template.php */
 136          return apply_filters( 'the_category', '', $separator, $parents );
 137      }
 138  
 139      /**
 140       * Filters the categories before building the category list.
 141       *
 142       * @since 4.4.0
 143       *
 144       * @param WP_Term[] $categories An array of the post's categories.
 145       * @param int|bool  $post_id    ID of the post we're retrieving categories for. When `false`, we assume the
 146       *                              current post in the loop.
 147       */
 148      $categories = apply_filters( 'the_category_list', get_the_category( $post_id ), $post_id );
 149  
 150      if ( empty( $categories ) ) {
 151          /** This filter is documented in wp-includes/category-template.php */
 152          return apply_filters( 'the_category', __( 'Uncategorized' ), $separator, $parents );
 153      }
 154  
 155      $rel = ( is_object( $wp_rewrite ) && $wp_rewrite->using_permalinks() ) ? 'rel="category tag"' : 'rel="category"';
 156  
 157      $thelist = '';
 158      if ( '' == $separator ) {
 159          $thelist .= '<ul class="post-categories">';
 160          foreach ( $categories as $category ) {
 161              $thelist .= "\n\t<li>";
 162              switch ( strtolower( $parents ) ) {
 163                  case 'multiple':
 164                      if ( $category->parent ) {
 165                          $thelist .= get_category_parents( $category->parent, true, $separator );
 166                      }
 167                      $thelist .= '<a href="' . esc_url( get_category_link( $category->term_id ) ) . '" ' . $rel . '>' . $category->name . '</a></li>';
 168                      break;
 169                  case 'single':
 170                      $thelist .= '<a href="' . esc_url( get_category_link( $category->term_id ) ) . '"  ' . $rel . '>';
 171                      if ( $category->parent ) {
 172                          $thelist .= get_category_parents( $category->parent, false, $separator );
 173                      }
 174                      $thelist .= $category->name . '</a></li>';
 175                      break;
 176                  case '':
 177                  default:
 178                      $thelist .= '<a href="' . esc_url( get_category_link( $category->term_id ) ) . '" ' . $rel . '>' . $category->name . '</a></li>';
 179              }
 180          }
 181          $thelist .= '</ul>';
 182      } else {
 183          $i = 0;
 184          foreach ( $categories as $category ) {
 185              if ( 0 < $i ) {
 186                  $thelist .= $separator;
 187              }
 188              switch ( strtolower( $parents ) ) {
 189                  case 'multiple':
 190                      if ( $category->parent ) {
 191                          $thelist .= get_category_parents( $category->parent, true, $separator );
 192                      }
 193                      $thelist .= '<a href="' . esc_url( get_category_link( $category->term_id ) ) . '" ' . $rel . '>' . $category->name . '</a>';
 194                      break;
 195                  case 'single':
 196                      $thelist .= '<a href="' . esc_url( get_category_link( $category->term_id ) ) . '" ' . $rel . '>';
 197                      if ( $category->parent ) {
 198                          $thelist .= get_category_parents( $category->parent, false, $separator );
 199                      }
 200                      $thelist .= "$category->name</a>";
 201                      break;
 202                  case '':
 203                  default:
 204                      $thelist .= '<a href="' . esc_url( get_category_link( $category->term_id ) ) . '" ' . $rel . '>' . $category->name . '</a>';
 205              }
 206              ++$i;
 207          }
 208      }
 209  
 210      /**
 211       * Filters the category or list of categories.
 212       *
 213       * @since 1.2.0
 214       *
 215       * @param string $thelist   List of categories for the current post.
 216       * @param string $separator Separator used between the categories.
 217       * @param string $parents   How to display the category parents. Accepts 'multiple',
 218       *                          'single', or empty.
 219       */
 220      return apply_filters( 'the_category', $thelist, $separator, $parents );
 221  }
 222  
 223  /**
 224   * Checks if the current post is within any of the given categories.
 225   *
 226   * The given categories are checked against the post's categories' term_ids, names and slugs.
 227   * Categories given as integers will only be checked against the post's categories' term_ids.
 228   *
 229   * Prior to v2.5 of WordPress, category names were not supported.
 230   * Prior to v2.7, category slugs were not supported.
 231   * Prior to v2.7, only one category could be compared: in_category( $single_category ).
 232   * Prior to v2.7, this function could only be used in the WordPress Loop.
 233   * As of 2.7, the function can be used anywhere if it is provided a post ID or post object.
 234   *
 235   * For more information on this and similar theme functions, check out
 236   * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
 237   * Conditional Tags} article in the Theme Developer Handbook.
 238   *
 239   * @since 1.2.0
 240   *
 241   * @param int|string|array $category Category ID, name or slug, or array of said.
 242   * @param int|object $post Optional. Post to check instead of the current post. (since 2.7.0)
 243   * @return bool True if the current post is in any of the given categories.
 244   */
 245  function in_category( $category, $post = null ) {
 246      if ( empty( $category ) ) {
 247          return false;
 248      }
 249  
 250      return has_category( $category, $post );
 251  }
 252  
 253  /**
 254   * Displays category list for a post in either HTML list or custom format.
 255   *
 256   * @since 0.71
 257   *
 258   * @param string $separator Optional. Separator between the categories. By default, the links are placed
 259   *                          in an unordered list. An empty string will result in the default behavior.
 260   * @param string $parents Optional. How to display the parents.
 261   * @param int $post_id Optional. Post ID to retrieve categories.
 262   */
 263  function the_category( $separator = '', $parents = '', $post_id = false ) {
 264      echo get_the_category_list( $separator, $parents, $post_id );
 265  }
 266  
 267  /**
 268   * Retrieves category description.
 269   *
 270   * @since 1.0.0
 271   *
 272   * @param int $category Optional. Category ID. Will use global category ID by default.
 273   * @return string Category description, available.
 274   */
 275  function category_description( $category = 0 ) {
 276      return term_description( $category );
 277  }
 278  
 279  /**
 280   * Displays or retrieves the HTML dropdown list of categories.
 281   *
 282   * The 'hierarchical' argument, which is disabled by default, will override the
 283   * depth argument, unless it is true. When the argument is false, it will
 284   * display all of the categories. When it is enabled it will use the value in
 285   * the 'depth' argument.
 286   *
 287   * @since 2.1.0
 288   * @since 4.2.0 Introduced the `value_field` argument.
 289   * @since 4.6.0 Introduced the `required` argument.
 290   *
 291   * @param array|string $args {
 292   *     Optional. Array or string of arguments to generate a categories drop-down element. See WP_Term_Query::__construct()
 293   *     for information on additional accepted arguments.
 294   *
 295   *     @type string       $show_option_all   Text to display for showing all categories. Default empty.
 296   *     @type string       $show_option_none  Text to display for showing no categories. Default empty.
 297   *     @type string       $option_none_value Value to use when no category is selected. Default empty.
 298   *     @type string       $orderby           Which column to use for ordering categories. See get_terms() for a list
 299   *                                           of accepted values. Default 'id' (term_id).
 300   *     @type bool         $pad_counts        See get_terms() for an argument description. Default false.
 301   *     @type bool|int     $show_count        Whether to include post counts. Accepts 0, 1, or their bool equivalents.
 302   *                                           Default 0.
 303   *     @type bool|int     $echo              Whether to echo or return the generated markup. Accepts 0, 1, or their
 304   *                                           bool equivalents. Default 1.
 305   *     @type bool|int     $hierarchical      Whether to traverse the taxonomy hierarchy. Accepts 0, 1, or their bool
 306   *                                           equivalents. Default 0.
 307   *     @type int          $depth             Maximum depth. Default 0.
 308   *     @type int          $tab_index         Tab index for the select element. Default 0 (no tabindex).
 309   *     @type string       $name              Value for the 'name' attribute of the select element. Default 'cat'.
 310   *     @type string       $id                Value for the 'id' attribute of the select element. Defaults to the value
 311   *                                           of `$name`.
 312   *     @type string       $class             Value for the 'class' attribute of the select element. Default 'postform'.
 313   *     @type int|string   $selected          Value of the option that should be selected. Default 0.
 314   *     @type string       $value_field       Term field that should be used to populate the 'value' attribute
 315   *                                           of the option elements. Accepts any valid term field: 'term_id', 'name',
 316   *                                           'slug', 'term_group', 'term_taxonomy_id', 'taxonomy', 'description',
 317   *                                           'parent', 'count'. Default 'term_id'.
 318   *     @type string|array $taxonomy          Name of the category or categories to retrieve. Default 'category'.
 319   *     @type bool         $hide_if_empty     True to skip generating markup if no categories are found.
 320   *                                           Default false (create select element even if no categories are found).
 321   *     @type bool         $required          Whether the `<select>` element should have the HTML5 'required' attribute.
 322   *                                           Default false.
 323   * }
 324   * @return string HTML dropdown list of categories.
 325   */
 326  function wp_dropdown_categories( $args = '' ) {
 327      $defaults = array(
 328          'show_option_all'   => '',
 329          'show_option_none'  => '',
 330          'orderby'           => 'id',
 331          'order'             => 'ASC',
 332          'show_count'        => 0,
 333          'hide_empty'        => 1,
 334          'child_of'          => 0,
 335          'exclude'           => '',
 336          'echo'              => 1,
 337          'selected'          => 0,
 338          'hierarchical'      => 0,
 339          'name'              => 'cat',
 340          'id'                => '',
 341          'class'             => 'postform',
 342          'depth'             => 0,
 343          'tab_index'         => 0,
 344          'taxonomy'          => 'category',
 345          'hide_if_empty'     => false,
 346          'option_none_value' => -1,
 347          'value_field'       => 'term_id',
 348          'required'          => false,
 349      );
 350  
 351      $defaults['selected'] = ( is_category() ) ? get_query_var( 'cat' ) : 0;
 352  
 353      // Back compat.
 354      if ( isset( $args['type'] ) && 'link' == $args['type'] ) {
 355          _deprecated_argument(
 356              __FUNCTION__,
 357              '3.0.0',
 358              sprintf(
 359                  /* translators: 1: "type => link", 2: "taxonomy => link_category" */
 360                  __( '%1$s is deprecated. Use %2$s instead.' ),
 361                  '<code>type => link</code>',
 362                  '<code>taxonomy => link_category</code>'
 363              )
 364          );
 365          $args['taxonomy'] = 'link_category';
 366      }
 367  
 368      // Parse incoming $args into an array and merge it with $defaults.
 369      $parsed_args = wp_parse_args( $args, $defaults );
 370  
 371      $option_none_value = $parsed_args['option_none_value'];
 372  
 373      if ( ! isset( $parsed_args['pad_counts'] ) && $parsed_args['show_count'] && $parsed_args['hierarchical'] ) {
 374          $parsed_args['pad_counts'] = true;
 375      }
 376  
 377      $tab_index = $parsed_args['tab_index'];
 378  
 379      $tab_index_attribute = '';
 380      if ( (int) $tab_index > 0 ) {
 381          $tab_index_attribute = " tabindex=\"$tab_index\"";
 382      }
 383  
 384      // Avoid clashes with the 'name' param of get_terms().
 385      $get_terms_args = $parsed_args;
 386      unset( $get_terms_args['name'] );
 387      $categories = get_terms( $get_terms_args );
 388  
 389      $name     = esc_attr( $parsed_args['name'] );
 390      $class    = esc_attr( $parsed_args['class'] );
 391      $id       = $parsed_args['id'] ? esc_attr( $parsed_args['id'] ) : $name;
 392      $required = $parsed_args['required'] ? 'required' : '';
 393  
 394      if ( ! $parsed_args['hide_if_empty'] || ! empty( $categories ) ) {
 395          $output = "<select $required name='$name' id='$id' class='$class' $tab_index_attribute>\n";
 396      } else {
 397          $output = '';
 398      }
 399      if ( empty( $categories ) && ! $parsed_args['hide_if_empty'] && ! empty( $parsed_args['show_option_none'] ) ) {
 400  
 401          /**
 402           * Filters a taxonomy drop-down display element.
 403           *
 404           * A variety of taxonomy drop-down display elements can be modified
 405           * just prior to display via this filter. Filterable arguments include
 406           * 'show_option_none', 'show_option_all', and various forms of the
 407           * term name.
 408           *
 409           * @since 1.2.0
 410           *
 411           * @see wp_dropdown_categories()
 412           *
 413           * @param string       $element  Category name.
 414           * @param WP_Term|null $category The category object, or null if there's no corresponding category.
 415           */
 416          $show_option_none = apply_filters( 'list_cats', $parsed_args['show_option_none'], null );
 417          $output          .= "\t<option value='" . esc_attr( $option_none_value ) . "' selected='selected'>$show_option_none</option>\n";
 418      }
 419  
 420      if ( ! empty( $categories ) ) {
 421  
 422          if ( $parsed_args['show_option_all'] ) {
 423  
 424              /** This filter is documented in wp-includes/category-template.php */
 425              $show_option_all = apply_filters( 'list_cats', $parsed_args['show_option_all'], null );
 426              $selected        = ( '0' === strval( $parsed_args['selected'] ) ) ? " selected='selected'" : '';
 427              $output         .= "\t<option value='0'$selected>$show_option_all</option>\n";
 428          }
 429  
 430          if ( $parsed_args['show_option_none'] ) {
 431  
 432              /** This filter is documented in wp-includes/category-template.php */
 433              $show_option_none = apply_filters( 'list_cats', $parsed_args['show_option_none'], null );
 434              $selected         = selected( $option_none_value, $parsed_args['selected'], false );
 435              $output          .= "\t<option value='" . esc_attr( $option_none_value ) . "'$selected>$show_option_none</option>\n";
 436          }
 437  
 438          if ( $parsed_args['hierarchical'] ) {
 439              $depth = $parsed_args['depth'];  // Walk the full depth.
 440          } else {
 441              $depth = -1; // Flat.
 442          }
 443          $output .= walk_category_dropdown_tree( $categories, $depth, $parsed_args );
 444      }
 445  
 446      if ( ! $parsed_args['hide_if_empty'] || ! empty( $categories ) ) {
 447          $output .= "</select>\n";
 448      }
 449  
 450      /**
 451       * Filters the taxonomy drop-down output.
 452       *
 453       * @since 2.1.0
 454       *
 455       * @param string $output      HTML output.
 456       * @param array  $parsed_args Arguments used to build the drop-down.
 457       */
 458      $output = apply_filters( 'wp_dropdown_cats', $output, $parsed_args );
 459  
 460      if ( $parsed_args['echo'] ) {
 461          echo $output;
 462      }
 463  
 464      return $output;
 465  }
 466  
 467  /**
 468   * Displays or retrieves the HTML list of categories.
 469   *
 470   * @since 2.1.0
 471   * @since 4.4.0 Introduced the `hide_title_if_empty` and `separator` arguments.
 472   * @since 4.4.0 The `current_category` argument was modified to optionally accept an array of values.
 473   *
 474   * @param array|string $args {
 475   *     Array of optional arguments. See get_categories(), get_terms(), and WP_Term_Query::__construct()
 476   *     for information on additional accepted arguments.
 477   *
 478   *     @type int|array    $current_category      ID of category, or array of IDs of categories, that should get the
 479   *                                               'current-cat' class. Default 0.
 480   *     @type int          $depth                 Category depth. Used for tab indentation. Default 0.
 481   *     @type bool|int     $echo                  Whether to echo or return the generated markup. Accepts 0, 1, or their
 482   *                                               bool equivalents. Default 1.
 483   *     @type array|string $exclude               Array or comma/space-separated string of term IDs to exclude.
 484   *                                               If `$hierarchical` is true, descendants of `$exclude` terms will also
 485   *                                               be excluded; see `$exclude_tree`. See get_terms().
 486   *                                               Default empty string.
 487   *     @type array|string $exclude_tree          Array or comma/space-separated string of term IDs to exclude, along
 488   *                                               with their descendants. See get_terms(). Default empty string.
 489   *     @type string       $feed                  Text to use for the feed link. Default 'Feed for all posts filed
 490   *                                               under [cat name]'.
 491   *     @type string       $feed_image            URL of an image to use for the feed link. Default empty string.
 492   *     @type string       $feed_type             Feed type. Used to build feed link. See get_term_feed_link().
 493   *                                               Default empty string (default feed).
 494   *     @type bool         $hide_title_if_empty   Whether to hide the `$title_li` element if there are no terms in
 495   *                                               the list. Default false (title will always be shown).
 496   *     @type string       $separator             Separator between links. Default '<br />'.
 497   *     @type bool|int     $show_count            Whether to include post counts. Accepts 0, 1, or their bool equivalents.
 498   *                                               Default 0.
 499   *     @type string       $show_option_all       Text to display for showing all categories. Default empty string.
 500   *     @type string       $show_option_none      Text to display for the 'no categories' option.
 501   *                                               Default 'No categories'.
 502   *     @type string       $style                 The style used to display the categories list. If 'list', categories
 503   *                                               will be output as an unordered list. If left empty or another value,
 504   *                                               categories will be output separated by `<br>` tags. Default 'list'.
 505   *     @type string       $title_li              Text to use for the list title `<li>` element. Pass an empty string
 506   *                                               to disable. Default 'Categories'.
 507   *     @type bool|int     $use_desc_for_title    Whether to use the category description as the title attribute.
 508   *                                               Accepts 0, 1, or their bool equivalents. Default 1.
 509   * }
 510   * @return void|string|false Void if 'echo' argument is true, HTML list of categories if 'echo' is false.
 511   *                           False if the taxonomy does not exist.
 512   */
 513  function wp_list_categories( $args = '' ) {
 514      $defaults = array(
 515          'child_of'            => 0,
 516          'current_category'    => 0,
 517          'depth'               => 0,
 518          'echo'                => 1,
 519          'exclude'             => '',
 520          'exclude_tree'        => '',
 521          'feed'                => '',
 522          'feed_image'          => '',
 523          'feed_type'           => '',
 524          'hide_empty'          => 1,
 525          'hide_title_if_empty' => false,
 526          'hierarchical'        => true,
 527          'order'               => 'ASC',
 528          'orderby'             => 'name',
 529          'separator'           => '<br />',
 530          'show_count'          => 0,
 531          'show_option_all'     => '',
 532          'show_option_none'    => __( 'No categories' ),
 533          'style'               => 'list',
 534          'taxonomy'            => 'category',
 535          'title_li'            => __( 'Categories' ),
 536          'use_desc_for_title'  => 1,
 537      );
 538  
 539      $parsed_args = wp_parse_args( $args, $defaults );
 540  
 541      if ( ! isset( $parsed_args['pad_counts'] ) && $parsed_args['show_count'] && $parsed_args['hierarchical'] ) {
 542          $parsed_args['pad_counts'] = true;
 543      }
 544  
 545      // Descendants of exclusions should be excluded too.
 546      if ( true == $parsed_args['hierarchical'] ) {
 547          $exclude_tree = array();
 548  
 549          if ( $parsed_args['exclude_tree'] ) {
 550              $exclude_tree = array_merge( $exclude_tree, wp_parse_id_list( $parsed_args['exclude_tree'] ) );
 551          }
 552  
 553          if ( $parsed_args['exclude'] ) {
 554              $exclude_tree = array_merge( $exclude_tree, wp_parse_id_list( $parsed_args['exclude'] ) );
 555          }
 556  
 557          $parsed_args['exclude_tree'] = $exclude_tree;
 558          $parsed_args['exclude']      = '';
 559      }
 560  
 561      if ( ! isset( $parsed_args['class'] ) ) {
 562          $parsed_args['class'] = ( 'category' == $parsed_args['taxonomy'] ) ? 'categories' : $parsed_args['taxonomy'];
 563      }
 564  
 565      if ( ! taxonomy_exists( $parsed_args['taxonomy'] ) ) {
 566          return false;
 567      }
 568  
 569      $show_option_all  = $parsed_args['show_option_all'];
 570      $show_option_none = $parsed_args['show_option_none'];
 571  
 572      $categories = get_categories( $parsed_args );
 573  
 574      $output = '';
 575      if ( $parsed_args['title_li'] && 'list' == $parsed_args['style'] && ( ! empty( $categories ) || ! $parsed_args['hide_title_if_empty'] ) ) {
 576          $output = '<li class="' . esc_attr( $parsed_args['class'] ) . '">' . $parsed_args['title_li'] . '<ul>';
 577      }
 578      if ( empty( $categories ) ) {
 579          if ( ! empty( $show_option_none ) ) {
 580              if ( 'list' == $parsed_args['style'] ) {
 581                  $output .= '<li class="cat-item-none">' . $show_option_none . '</li>';
 582              } else {
 583                  $output .= $show_option_none;
 584              }
 585          }
 586      } else {
 587          if ( ! empty( $show_option_all ) ) {
 588  
 589              $posts_page = '';
 590  
 591              // For taxonomies that belong only to custom post types, point to a valid archive.
 592              $taxonomy_object = get_taxonomy( $parsed_args['taxonomy'] );
 593              if ( ! in_array( 'post', $taxonomy_object->object_type, true ) && ! in_array( 'page', $taxonomy_object->object_type, true ) ) {
 594                  foreach ( $taxonomy_object->object_type as $object_type ) {
 595                      $_object_type = get_post_type_object( $object_type );
 596  
 597                      // Grab the first one.
 598                      if ( ! empty( $_object_type->has_archive ) ) {
 599                          $posts_page = get_post_type_archive_link( $object_type );
 600                          break;
 601                      }
 602                  }
 603              }
 604  
 605              // Fallback for the 'All' link is the posts page.
 606              if ( ! $posts_page ) {
 607                  if ( 'page' == get_option( 'show_on_front' ) && get_option( 'page_for_posts' ) ) {
 608                      $posts_page = get_permalink( get_option( 'page_for_posts' ) );
 609                  } else {
 610                      $posts_page = home_url( '/' );
 611                  }
 612              }
 613  
 614              $posts_page = esc_url( $posts_page );
 615              if ( 'list' == $parsed_args['style'] ) {
 616                  $output .= "<li class='cat-item-all'><a href='$posts_page'>$show_option_all</a></li>";
 617              } else {
 618                  $output .= "<a href='$posts_page'>$show_option_all</a>";
 619              }
 620          }
 621  
 622          if ( empty( $parsed_args['current_category'] ) && ( is_category() || is_tax() || is_tag() ) ) {
 623              $current_term_object = get_queried_object();
 624              if ( $current_term_object && $parsed_args['taxonomy'] === $current_term_object->taxonomy ) {
 625                  $parsed_args['current_category'] = get_queried_object_id();
 626              }
 627          }
 628  
 629          if ( $parsed_args['hierarchical'] ) {
 630              $depth = $parsed_args['depth'];
 631          } else {
 632              $depth = -1; // Flat.
 633          }
 634          $output .= walk_category_tree( $categories, $depth, $parsed_args );
 635      }
 636  
 637      if ( $parsed_args['title_li'] && 'list' == $parsed_args['style'] && ( ! empty( $categories ) || ! $parsed_args['hide_title_if_empty'] ) ) {
 638          $output .= '</ul></li>';
 639      }
 640  
 641      /**
 642       * Filters the HTML output of a taxonomy list.
 643       *
 644       * @since 2.1.0
 645       *
 646       * @param string $output HTML output.
 647       * @param array  $args   An array of taxonomy-listing arguments.
 648       */
 649      $html = apply_filters( 'wp_list_categories', $output, $args );
 650  
 651      if ( $parsed_args['echo'] ) {
 652          echo $html;
 653      } else {
 654          return $html;
 655      }
 656  }
 657  
 658  /**
 659   * Displays a tag cloud.
 660   *
 661   * @since 2.3.0
 662   * @since 4.8.0 Added the `show_count` argument.
 663   *
 664   * @param array|string $args {
 665   *     Optional. Array or string of arguments for displaying a tag cloud. See wp_generate_tag_cloud()
 666   *     and get_terms() for the full lists of arguments that can be passed in `$args`.
 667   *
 668   *     @type int    $number    The number of tags to display. Accepts any positive integer
 669   *                             or zero to return all. Default 0 (all tags).
 670   *     @type string $link      Whether to display term editing links or term permalinks.
 671   *                             Accepts 'edit' and 'view'. Default 'view'.
 672   *     @type string $post_type The post type. Used to highlight the proper post type menu
 673   *                             on the linked edit page. Defaults to the first post type
 674   *                             associated with the taxonomy.
 675   *     @type bool   $echo      Whether or not to echo the return value. Default true.
 676   * }
 677   * @return void|string|array Void if 'echo' argument is true, or on failure. Otherwise, tag cloud
 678   *                           as a string or an array, depending on 'format' argument.
 679   */
 680  function wp_tag_cloud( $args = '' ) {
 681      $defaults = array(
 682          'smallest'   => 8,
 683          'largest'    => 22,
 684          'unit'       => 'pt',
 685          'number'     => 45,
 686          'format'     => 'flat',
 687          'separator'  => "\n",
 688          'orderby'    => 'name',
 689          'order'      => 'ASC',
 690          'exclude'    => '',
 691          'include'    => '',
 692          'link'       => 'view',
 693          'taxonomy'   => 'post_tag',
 694          'post_type'  => '',
 695          'echo'       => true,
 696          'show_count' => 0,
 697      );
 698  
 699      $args = wp_parse_args( $args, $defaults );
 700  
 701      $tags = get_terms(
 702          array_merge(
 703              $args,
 704              array(
 705                  'orderby' => 'count',
 706                  'order'   => 'DESC',
 707              )
 708          )
 709      ); // Always query top tags.
 710  
 711      if ( empty( $tags ) || is_wp_error( $tags ) ) {
 712          return;
 713      }
 714  
 715      foreach ( $tags as $key => $tag ) {
 716          if ( 'edit' == $args['link'] ) {
 717              $link = get_edit_term_link( $tag->term_id, $tag->taxonomy, $args['post_type'] );
 718          } else {
 719              $link = get_term_link( intval( $tag->term_id ), $tag->taxonomy );
 720          }
 721  
 722          if ( is_wp_error( $link ) ) {
 723              return;
 724          }
 725  
 726          $tags[ $key ]->link = $link;
 727          $tags[ $key ]->id   = $tag->term_id;
 728      }
 729  
 730      // Here's where those top tags get sorted according to $args.
 731      $return = wp_generate_tag_cloud( $tags, $args );
 732  
 733      /**
 734       * Filters the tag cloud output.
 735       *
 736       * @since 2.3.0
 737       *
 738       * @param string|array $return Tag cloud as a string or an array, depending on 'format' argument.
 739       * @param array        $args   An array of tag cloud arguments.
 740       */
 741      $return = apply_filters( 'wp_tag_cloud', $return, $args );
 742  
 743      if ( 'array' == $args['format'] || empty( $args['echo'] ) ) {
 744          return $return;
 745      }
 746  
 747      echo $return;
 748  }
 749  
 750  /**
 751   * Default topic count scaling for tag links.
 752   *
 753   * @since 2.9.0
 754   *
 755   * @param int $count Number of posts with that tag.
 756   * @return int Scaled count.
 757   */
 758  function default_topic_count_scale( $count ) {
 759      return round( log10( $count + 1 ) * 100 );
 760  }
 761  
 762  /**
 763   * Generates a tag cloud (heatmap) from provided data.
 764   *
 765   * @todo Complete functionality.
 766   * @since 2.3.0
 767   * @since 4.8.0 Added the `show_count` argument.
 768   *
 769   * @param WP_Term[]    $tags Array of WP_Term objects to generate the tag cloud for.
 770   * @param string|array $args {
 771   *     Optional. Array or string of arguments for generating a tag cloud.
 772   *
 773   *     @type int      $smallest                   Smallest font size used to display tags. Paired
 774   *                                                with the value of `$unit`, to determine CSS text
 775   *                                                size unit. Default 8 (pt).
 776   *     @type int      $largest                    Largest font size used to display tags. Paired
 777   *                                                with the value of `$unit`, to determine CSS text
 778   *                                                size unit. Default 22 (pt).
 779   *     @type string   $unit                       CSS text size unit to use with the `$smallest`
 780   *                                                and `$largest` values. Accepts any valid CSS text
 781   *                                                size unit. Default 'pt'.
 782   *     @type int      $number                     The number of tags to return. Accepts any
 783   *                                                positive integer or zero to return all.
 784   *                                                Default 0.
 785   *     @type string   $format                     Format to display the tag cloud in. Accepts 'flat'
 786   *                                                (tags separated with spaces), 'list' (tags displayed
 787   *                                                in an unordered list), or 'array' (returns an array).
 788   *                                                Default 'flat'.
 789   *     @type string   $separator                  HTML or text to separate the tags. Default "\n" (newline).
 790   *     @type string   $orderby                    Value to order tags by. Accepts 'name' or 'count'.
 791   *                                                Default 'name'. The {@see 'tag_cloud_sort'} filter
 792   *                                                can also affect how tags are sorted.
 793   *     @type string   $order                      How to order the tags. Accepts 'ASC' (ascending),
 794   *                                                'DESC' (descending), or 'RAND' (random). Default 'ASC'.
 795   *     @type int|bool $filter                     Whether to enable filtering of the final output
 796   *                                                via {@see 'wp_generate_tag_cloud'}. Default 1|true.
 797   *     @type string   $topic_count_text           Nooped plural text from _n_noop() to supply to
 798   *                                                tag counts. Default null.
 799   *     @type callable $topic_count_text_callback  Callback used to generate nooped plural text for
 800   *                                                tag counts based on the count. Default null.
 801   *     @type callable $topic_count_scale_callback Callback used to determine the tag count scaling
 802   *                                                value. Default default_topic_count_scale().
 803   *     @type bool|int $show_count                 Whether to display the tag counts. Default 0. Accepts
 804   *                                                0, 1, or their bool equivalents.
 805   * }
 806   * @return string|array Tag cloud as a string or an array, depending on 'format' argument.
 807   */
 808  function wp_generate_tag_cloud( $tags, $args = '' ) {
 809      $defaults = array(
 810          'smallest'                   => 8,
 811          'largest'                    => 22,
 812          'unit'                       => 'pt',
 813          'number'                     => 0,
 814          'format'                     => 'flat',
 815          'separator'                  => "\n",
 816          'orderby'                    => 'name',
 817          'order'                      => 'ASC',
 818          'topic_count_text'           => null,
 819          'topic_count_text_callback'  => null,
 820          'topic_count_scale_callback' => 'default_topic_count_scale',
 821          'filter'                     => 1,
 822          'show_count'                 => 0,
 823      );
 824  
 825      $args = wp_parse_args( $args, $defaults );
 826  
 827      $return = ( 'array' === $args['format'] ) ? array() : '';
 828  
 829      if ( empty( $tags ) ) {
 830          return $return;
 831      }
 832  
 833      // Juggle topic counts.
 834      if ( isset( $args['topic_count_text'] ) ) {
 835          // First look for nooped plural support via topic_count_text.
 836          $translate_nooped_plural = $args['topic_count_text'];
 837      } elseif ( ! empty( $args['topic_count_text_callback'] ) ) {
 838          // Look for the alternative callback style. Ignore the previous default.
 839          if ( 'default_topic_count_text' === $args['topic_count_text_callback'] ) {
 840              /* translators: %s: Number of items (tags). */
 841              $translate_nooped_plural = _n_noop( '%s item', '%s items' );
 842          } else {
 843              $translate_nooped_plural = false;
 844          }
 845      } elseif ( isset( $args['single_text'] ) && isset( $args['multiple_text'] ) ) {
 846          // If no callback exists, look for the old-style single_text and multiple_text arguments.
 847          // phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralSingle,WordPress.WP.I18n.NonSingularStringLiteralPlural
 848          $translate_nooped_plural = _n_noop( $args['single_text'], $args['multiple_text'] );
 849      } else {
 850          // This is the default for when no callback, plural, or argument is passed in.
 851          /* translators: %s: Number of items (tags). */
 852          $translate_nooped_plural = _n_noop( '%s item', '%s items' );
 853      }
 854  
 855      /**
 856       * Filters how the items in a tag cloud are sorted.
 857       *
 858       * @since 2.8.0
 859       *
 860       * @param WP_Term[] $tags Ordered array of terms.
 861       * @param array     $args An array of tag cloud arguments.
 862       */
 863      $tags_sorted = apply_filters( 'tag_cloud_sort', $tags, $args );
 864      if ( empty( $tags_sorted ) ) {
 865          return $return;
 866      }
 867  
 868      if ( $tags_sorted !== $tags ) {
 869          $tags = $tags_sorted;
 870          unset( $tags_sorted );
 871      } else {
 872          if ( 'RAND' === $args['order'] ) {
 873              shuffle( $tags );
 874          } else {
 875              // SQL cannot save you; this is a second (potentially different) sort on a subset of data.
 876              if ( 'name' === $args['orderby'] ) {
 877                  uasort( $tags, '_wp_object_name_sort_cb' );
 878              } else {
 879                  uasort( $tags, '_wp_object_count_sort_cb' );
 880              }
 881  
 882              if ( 'DESC' === $args['order'] ) {
 883                  $tags = array_reverse( $tags, true );
 884              }
 885          }
 886      }
 887  
 888      if ( $args['number'] > 0 ) {
 889          $tags = array_slice( $tags, 0, $args['number'] );
 890      }
 891  
 892      $counts      = array();
 893      $real_counts = array(); // For the alt tag.
 894      foreach ( (array) $tags as $key => $tag ) {
 895          $real_counts[ $key ] = $tag->count;
 896          $counts[ $key ]      = call_user_func( $args['topic_count_scale_callback'], $tag->count );
 897      }
 898  
 899      $min_count = min( $counts );
 900      $spread    = max( $counts ) - $min_count;
 901      if ( $spread <= 0 ) {
 902          $spread = 1;
 903      }
 904      $font_spread = $args['largest'] - $args['smallest'];
 905      if ( $font_spread < 0 ) {
 906          $font_spread = 1;
 907      }
 908      $font_step = $font_spread / $spread;
 909  
 910      $aria_label = false;
 911      /*
 912       * Determine whether to output an 'aria-label' attribute with the tag name and count.
 913       * When tags have a different font size, they visually convey an important information
 914       * that should be available to assistive technologies too. On the other hand, sometimes
 915       * themes set up the Tag Cloud to display all tags with the same font size (setting
 916       * the 'smallest' and 'largest' arguments to the same value).
 917       * In order to always serve the same content to all users, the 'aria-label' gets printed out:
 918       * - when tags have a different size
 919       * - when the tag count is displayed (for example when users check the checkbox in the
 920       *   Tag Cloud widget), regardless of the tags font size
 921       */
 922      if ( $args['show_count'] || 0 !== $font_spread ) {
 923          $aria_label = true;
 924      }
 925  
 926      // Assemble the data that will be used to generate the tag cloud markup.
 927      $tags_data = array();
 928      foreach ( $tags as $key => $tag ) {
 929          $tag_id = isset( $tag->id ) ? $tag->id : $key;
 930  
 931          $count      = $counts[ $key ];
 932          $real_count = $real_counts[ $key ];
 933  
 934          if ( $translate_nooped_plural ) {
 935              $formatted_count = sprintf( translate_nooped_plural( $translate_nooped_plural, $real_count ), number_format_i18n( $real_count ) );
 936          } else {
 937              $formatted_count = call_user_func( $args['topic_count_text_callback'], $real_count, $tag, $args );
 938          }
 939  
 940          $tags_data[] = array(
 941              'id'              => $tag_id,
 942              'url'             => '#' != $tag->link ? $tag->link : '#',
 943              'role'            => '#' != $tag->link ? '' : ' role="button"',
 944              'name'            => $tag->name,
 945              'formatted_count' => $formatted_count,
 946              'slug'            => $tag->slug,
 947              'real_count'      => $real_count,
 948              'class'           => 'tag-cloud-link tag-link-' . $tag_id,
 949              'font_size'       => $args['smallest'] + ( $count - $min_count ) * $font_step,
 950              'aria_label'      => $aria_label ? sprintf( ' aria-label="%1$s (%2$s)"', esc_attr( $tag->name ), esc_attr( $formatted_count ) ) : '',
 951              'show_count'      => $args['show_count'] ? '<span class="tag-link-count"> (' . $real_count . ')</span>' : '',
 952          );
 953      }
 954  
 955      /**
 956       * Filters the data used to generate the tag cloud.
 957       *
 958       * @since 4.3.0
 959       *
 960       * @param array $tags_data An array of term data for term used to generate the tag cloud.
 961       */
 962      $tags_data = apply_filters( 'wp_generate_tag_cloud_data', $tags_data );
 963  
 964      $a = array();
 965  
 966      // Generate the output links array.
 967      foreach ( $tags_data as $key => $tag_data ) {
 968          $class = $tag_data['class'] . ' tag-link-position-' . ( $key + 1 );
 969          $a[]   = sprintf(
 970              '<a href="%1$s"%2$s class="%3$s" style="font-size: %4$s;"%5$s>%6$s%7$s</a>',
 971              esc_url( $tag_data['url'] ),
 972              $tag_data['role'],
 973              esc_attr( $class ),
 974              esc_attr( str_replace( ',', '.', $tag_data['font_size'] ) . $args['unit'] ),
 975              $tag_data['aria_label'],
 976              esc_html( $tag_data['name'] ),
 977              $tag_data['show_count']
 978          );
 979      }
 980  
 981      switch ( $args['format'] ) {
 982          case 'array':
 983              $return =& $a;
 984              break;
 985          case 'list':
 986              /*
 987               * Force role="list", as some browsers (sic: Safari 10) don't expose to assistive
 988               * technologies the default role when the list is styled with `list-style: none`.
 989               * Note: this is redundant but doesn't harm.
 990               */
 991              $return  = "<ul class='wp-tag-cloud' role='list'>\n\t<li>";
 992              $return .= join( "</li>\n\t<li>", $a );
 993              $return .= "</li>\n</ul>\n";
 994              break;
 995          default:
 996              $return = join( $args['separator'], $a );
 997              break;
 998      }
 999  
1000      if ( $args['filter'] ) {
1001          /**
1002           * Filters the generated output of a tag cloud.
1003           *
1004           * The filter is only evaluated if a true value is passed
1005           * to the $filter argument in wp_generate_tag_cloud().
1006           *
1007           * @since 2.3.0
1008           *
1009           * @see wp_generate_tag_cloud()
1010           *
1011           * @param array|string $return String containing the generated HTML tag cloud output
1012           *                             or an array of tag links if the 'format' argument
1013           *                             equals 'array'.
1014           * @param WP_Term[]    $tags   An array of terms used in the tag cloud.
1015           * @param array        $args   An array of wp_generate_tag_cloud() arguments.
1016           */
1017          return apply_filters( 'wp_generate_tag_cloud', $return, $tags, $args );
1018      } else {
1019          return $return;
1020      }
1021  }
1022  
1023  /**
1024   * Serves as a callback for comparing objects based on name.
1025   *
1026   * Used with `uasort()`.
1027   *
1028   * @since 3.1.0
1029   * @access private
1030   *
1031   * @param object $a The first object to compare.
1032   * @param object $b The second object to compare.
1033   * @return int Negative number if `$a->name` is less than `$b->name`, zero if they are equal,
1034   *             or greater than zero if `$a->name` is greater than `$b->name`.
1035   */
1036  function _wp_object_name_sort_cb( $a, $b ) {
1037      return strnatcasecmp( $a->name, $b->name );
1038  }
1039  
1040  /**
1041   * Serves as a callback for comparing objects based on count.
1042   *
1043   * Used with `uasort()`.
1044   *
1045   * @since 3.1.0
1046   * @access private
1047   *
1048   * @param object $a The first object to compare.
1049   * @param object $b The second object to compare.
1050   * @return bool Whether the count value for `$a` is greater than the count value for `$b`.
1051   */
1052  function _wp_object_count_sort_cb( $a, $b ) {
1053      return ( $a->count > $b->count );
1054  }
1055  
1056  //
1057  // Helper functions.
1058  //
1059  
1060  /**
1061   * Retrieves HTML list content for category list.
1062   *
1063   * @since 2.1.0
1064   * @since 5.3.0 Formalized the existing `...$args` parameter by adding it
1065   *              to the function signature.
1066   *
1067   * @uses Walker_Category to create HTML list content.
1068   * @see Walker::walk() for parameters and return description.
1069   *
1070   * @param mixed ...$args Elements array, maximum hierarchical depth and optional additional arguments.
1071   * @return string
1072   */
1073  function walk_category_tree( ...$args ) {
1074      // The user's options are the third parameter.
1075      if ( empty( $args[2]['walker'] ) || ! ( $args[2]['walker'] instanceof Walker ) ) {
1076          $walker = new Walker_Category;
1077      } else {
1078          $walker = $args[2]['walker'];
1079      }
1080      return $walker->walk( ...$args );
1081  }
1082  
1083  /**
1084   * Retrieves HTML dropdown (select) content for category list.
1085   *
1086   * @since 2.1.0
1087   * @since 5.3.0 Formalized the existing `...$args` parameter by adding it
1088   *              to the function signature.
1089   *
1090   * @uses Walker_CategoryDropdown to create HTML dropdown content.
1091   * @see Walker::walk() for parameters and return description.
1092   *
1093   * @param mixed ...$args Elements array, maximum hierarchical depth and optional additional arguments.
1094   * @return string
1095   */
1096  function walk_category_dropdown_tree( ...$args ) {
1097      // The user's options are the third parameter.
1098      if ( empty( $args[2]['walker'] ) || ! ( $args[2]['walker'] instanceof Walker ) ) {
1099          $walker = new Walker_CategoryDropdown;
1100      } else {
1101          $walker = $args[2]['walker'];
1102      }
1103      return $walker->walk( ...$args );
1104  }
1105  
1106  //
1107  // Tags.
1108  //
1109  
1110  /**
1111   * Retrieves the link to the tag.
1112   *
1113   * @since 2.3.0
1114   * @see get_term_link()
1115   *
1116   * @param int|object $tag Tag ID or object.
1117   * @return string Link on success, empty string if tag does not exist.
1118   */
1119  function get_tag_link( $tag ) {
1120      return get_category_link( $tag );
1121  }
1122  
1123  /**
1124   * Retrieves the tags for a post.
1125   *
1126   * @since 2.3.0
1127   *
1128   * @param int $id Post ID.
1129   * @return array|false|WP_Error Array of tag objects on success, false on failure.
1130   */
1131  function get_the_tags( $id = 0 ) {
1132  
1133      /**
1134       * Filters the array of tags for the given post.
1135       *
1136       * @since 2.3.0
1137       *
1138       * @see get_the_terms()
1139       *
1140       * @param WP_Term[] $terms An array of tags for the given post.
1141       */
1142      return apply_filters( 'get_the_tags', get_the_terms( $id, 'post_tag' ) );
1143  }
1144  
1145  /**
1146   * Retrieves the tags for a post formatted as a string.
1147   *
1148   * @since 2.3.0
1149   *
1150   * @param string $before Optional. Before tags.
1151   * @param string $sep Optional. Between tags.
1152   * @param string $after Optional. After tags.
1153   * @param int $id Optional. Post ID. Defaults to the current post.
1154   * @return string|false|WP_Error A list of tags on success, false if there are no terms, WP_Error on failure.
1155   */
1156  function get_the_tag_list( $before = '', $sep = '', $after = '', $id = 0 ) {
1157  
1158      /**
1159       * Filters the tags list for a given post.
1160       *
1161       * @since 2.3.0
1162       *
1163       * @param string $tag_list List of tags.
1164       * @param string $before   String to use before tags.
1165       * @param string $sep      String to use between the tags.
1166       * @param string $after    String to use after tags.
1167       * @param int    $id       Post ID.
1168       */
1169      return apply_filters( 'the_tags', get_the_term_list( $id, 'post_tag', $before, $sep, $after ), $before, $sep, $after, $id );
1170  }
1171  
1172  /**
1173   * Retrieves the tags for a post.
1174   *
1175   * @since 2.3.0
1176   *
1177   * @param string $before Optional. Before list.
1178   * @param string $sep Optional. Separate items using this.
1179   * @param string $after Optional. After list.
1180   */
1181  function the_tags( $before = null, $sep = ', ', $after = '' ) {
1182      if ( null === $before ) {
1183          $before = __( 'Tags: ' );
1184      }
1185  
1186      $the_tags = get_the_tag_list( $before, $sep, $after );
1187  
1188      if ( ! is_wp_error( $the_tags ) ) {
1189          echo $the_tags;
1190      }
1191  }
1192  
1193  /**
1194   * Retrieves tag description.
1195   *
1196   * @since 2.8.0
1197   *
1198   * @param int $tag Optional. Tag ID. Will use global tag ID by default.
1199   * @return string Tag description, available.
1200   */
1201  function tag_description( $tag = 0 ) {
1202      return term_description( $tag );
1203  }
1204  
1205  /**
1206   * Retrieves term description.
1207   *
1208   * @since 2.8.0
1209   * @since 4.9.2 The `$taxonomy` parameter was deprecated.
1210   *
1211   * @param int  $term       Optional. Term ID. Will use global term ID by default.
1212   * @param null $deprecated Deprecated argument.
1213   * @return string Term description, available.
1214   */
1215  function term_description( $term = 0, $deprecated = null ) {
1216      if ( ! $term && ( is_tax() || is_tag() || is_category() ) ) {
1217          $term = get_queried_object();
1218          if ( $term ) {
1219              $term = $term->term_id;
1220          }
1221      }
1222      $description = get_term_field( 'description', $term );
1223      return is_wp_error( $description ) ? '' : $description;
1224  }
1225  
1226  /**
1227   * Retrieves the terms of the taxonomy that are attached to the post.
1228   *
1229   * @since 2.5.0
1230   *
1231   * @param int|WP_Post $post     Post ID or object.
1232   * @param string      $taxonomy Taxonomy name.
1233   * @return WP_Term[]|false|WP_Error Array of WP_Term objects on success, false if there are no terms
1234   *                                  or the post does not exist, WP_Error on failure.
1235   */
1236  function get_the_terms( $post, $taxonomy ) {
1237      $post = get_post( $post );
1238      if ( ! $post ) {
1239          return false;
1240      }
1241  
1242      $terms = get_object_term_cache( $post->ID, $taxonomy );
1243      if ( false === $terms ) {
1244          $terms = wp_get_object_terms( $post->ID, $taxonomy );
1245          if ( ! is_wp_error( $terms ) ) {
1246              $term_ids = wp_list_pluck( $terms, 'term_id' );
1247              wp_cache_add( $post->ID, $term_ids, $taxonomy . '_relationships' );
1248          }
1249      }
1250  
1251      /**
1252       * Filters the list of terms attached to the given post.
1253       *
1254       * @since 3.1.0
1255       *
1256       * @param WP_Term[]|WP_Error $terms    Array of attached terms, or WP_Error on failure.
1257       * @param int                $post_id  Post ID.
1258       * @param string             $taxonomy Name of the taxonomy.
1259       */
1260      $terms = apply_filters( 'get_the_terms', $terms, $post->ID, $taxonomy );
1261  
1262      if ( empty( $terms ) ) {
1263          return false;
1264      }
1265  
1266      return $terms;
1267  }
1268  
1269  /**
1270   * Retrieves a post's terms as a list with specified format.
1271   *
1272   * @since 2.5.0
1273   *
1274   * @param int    $id       Post ID.
1275   * @param string $taxonomy Taxonomy name.
1276   * @param string $before   Optional. Before list.
1277   * @param string $sep      Optional. Separate items using this.
1278   * @param string $after    Optional. After list.
1279   * @return string|false|WP_Error A list of terms on success, false if there are no terms, WP_Error on failure.
1280   */
1281  function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' ) {
1282      $terms = get_the_terms( $id, $taxonomy );
1283  
1284      if ( is_wp_error( $terms ) ) {
1285          return $terms;
1286      }
1287  
1288      if ( empty( $terms ) ) {
1289          return false;
1290      }
1291  
1292      $links = array();
1293  
1294      foreach ( $terms as $term ) {
1295          $link = get_term_link( $term, $taxonomy );
1296          if ( is_wp_error( $link ) ) {
1297              return $link;
1298          }
1299          $links[] = '<a href="' . esc_url( $link ) . '" rel="tag">' . $term->name . '</a>';
1300      }
1301  
1302      /**
1303       * Filters the term links for a given taxonomy.
1304       *
1305       * The dynamic portion of the filter name, `$taxonomy`, refers
1306       * to the taxonomy slug.
1307       *
1308       * @since 2.5.0
1309       *
1310       * @param string[] $links An array of term links.
1311       */
1312      $term_links = apply_filters( "term_links-{$taxonomy}", $links );  // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
1313  
1314      return $before . join( $sep, $term_links ) . $after;
1315  }
1316  
1317  /**
1318   * Retrieves term parents with separator.
1319   *
1320   * @since 4.8.0
1321   *
1322   * @param int     $term_id  Term ID.
1323   * @param string  $taxonomy Taxonomy name.
1324   * @param string|array $args {
1325   *     Array of optional arguments.
1326   *
1327   *     @type string $format    Use term names or slugs for display. Accepts 'name' or 'slug'.
1328   *                             Default 'name'.
1329   *     @type string $separator Separator for between the terms. Default '/'.
1330   *     @type bool   $link      Whether to format as a link. Default true.
1331   *     @type bool   $inclusive Include the term to get the parents for. Default true.
1332   * }
1333   * @return string|WP_Error A list of term parents on success, WP_Error or empty string on failure.
1334   */
1335  function get_term_parents_list( $term_id, $taxonomy, $args = array() ) {
1336      $list = '';
1337      $term = get_term( $term_id, $taxonomy );
1338  
1339      if ( is_wp_error( $term ) ) {
1340          return $term;
1341      }
1342  
1343      if ( ! $term ) {
1344          return $list;
1345      }
1346  
1347      $term_id = $term->term_id;
1348  
1349      $defaults = array(
1350          'format'    => 'name',
1351          'separator' => '/',
1352          'link'      => true,
1353          'inclusive' => true,
1354      );
1355  
1356      $args = wp_parse_args( $args, $defaults );
1357  
1358      foreach ( array( 'link', 'inclusive' ) as $bool ) {
1359          $args[ $bool ] = wp_validate_boolean( $args[ $bool ] );
1360      }
1361  
1362      $parents = get_ancestors( $term_id, $taxonomy, 'taxonomy' );
1363  
1364      if ( $args['inclusive'] ) {
1365          array_unshift( $parents, $term_id );
1366      }
1367  
1368      foreach ( array_reverse( $parents ) as $term_id ) {
1369          $parent = get_term( $term_id, $taxonomy );
1370          $name   = ( 'slug' === $args['format'] ) ? $parent->slug : $parent->name;
1371  
1372          if ( $args['link'] ) {
1373              $list .= '<a href="' . esc_url( get_term_link( $parent->term_id, $taxonomy ) ) . '">' . $name . '</a>' . $args['separator'];
1374          } else {
1375              $list .= $name . $args['separator'];
1376          }
1377      }
1378  
1379      return $list;
1380  }
1381  
1382  /**
1383   * Displays the terms in a list.
1384   *
1385   * @since 2.5.0
1386   *
1387   * @param int    $id       Post ID.
1388   * @param string $taxonomy Taxonomy name.
1389   * @param string $before   Optional. Before list.
1390   * @param string $sep      Optional. Separate items using this.
1391   * @param string $after    Optional. After list.
1392   * @return void|false Void on success, false on failure.
1393   */
1394  function the_terms( $id, $taxonomy, $before = '', $sep = ', ', $after = '' ) {
1395      $term_list = get_the_term_list( $id, $taxonomy, $before, $sep, $after );
1396  
1397      if ( is_wp_error( $term_list ) ) {
1398          return false;
1399      }
1400  
1401      /**
1402       * Filters the list of terms to display.
1403       *
1404       * @since 2.9.0
1405       *
1406       * @param string $term_list List of terms to display.
1407       * @param string $taxonomy  The taxonomy name.
1408       * @param string $before    String to use before the terms.
1409       * @param string $sep       String to use between the terms.
1410       * @param string $after     String to use after the terms.
1411       */
1412      echo apply_filters( 'the_terms', $term_list, $taxonomy, $before, $sep, $after );
1413  }
1414  
1415  /**
1416   * Checks if the current post has any of given category.
1417   *
1418   * @since 3.1.0
1419   *
1420   * @param string|int|array $category Optional. The category name/term_id/slug or array of them to check for.
1421   * @param int|object       $post     Optional. Post to check instead of the current post.
1422   * @return bool True if the current post has any of the given categories (or any category, if no category specified).
1423   */
1424  function has_category( $category = '', $post = null ) {
1425      return has_term( $category, 'category', $post );
1426  }
1427  
1428  /**
1429   * Checks if the current post has any of given tags.
1430   *
1431   * The given tags are checked against the post's tags' term_ids, names and slugs.
1432   * Tags given as integers will only be checked against the post's tags' term_ids.
1433   * If no tags are given, determines if post has any tags.
1434   *
1435   * Prior to v2.7 of WordPress, tags given as integers would also be checked against the post's tags' names and slugs (in addition to term_ids)
1436   * Prior to v2.7, this function could only be used in the WordPress Loop.
1437   * As of 2.7, the function can be used anywhere if it is provided a post ID or post object.
1438   *
1439   * For more information on this and similar theme functions, check out
1440   * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
1441   * Conditional Tags} article in the Theme Developer Handbook.
1442   *
1443   * @since 2.6.0
1444   *
1445   * @param string|int|array $tag  Optional. The tag name/term_id/slug or array of them to check for.
1446   * @param int|object       $post Optional. Post to check instead of the current post. (since 2.7.0)
1447   * @return bool True if the current post has any of the given tags (or any tag, if no tag specified).
1448   */
1449  function has_tag( $tag = '', $post = null ) {
1450      return has_term( $tag, 'post_tag', $post );
1451  }
1452  
1453  /**
1454   * Checks if the current post has any of given terms.
1455   *
1456   * The given terms are checked against the post's terms' term_ids, names and slugs.
1457   * Terms given as integers will only be checked against the post's terms' term_ids.
1458   * If no terms are given, determines if post has any terms.
1459   *
1460   * @since 3.1.0
1461   *
1462   * @param string|int|array $term     Optional. The term name/term_id/slug or array of them to check for.
1463   * @param string           $taxonomy Taxonomy name.
1464   * @param int|WP_Post      $post     Optional. Post to check instead of the current post.
1465   * @return bool True if the current post has any of the given tags (or any tag, if no tag specified).
1466   */
1467  function has_term( $term = '', $taxonomy = '', $post = null ) {
1468      $post = get_post( $post );
1469  
1470      if ( ! $post ) {
1471          return false;
1472      }
1473  
1474      $r = is_object_in_term( $post->ID, $taxonomy, $term );
1475      if ( is_wp_error( $r ) ) {
1476          return false;
1477      }
1478  
1479      return $r;
1480  }


Generated : Wed Apr 8 08:20:02 2020 Cross-referenced by PHPXref