[ Index ]

PHP Cross Reference of WordPress

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


Generated: Tue Aug 11 01:00:04 2020 Cross-referenced by PHPXref 0.7.1