[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * General template tags that can go anywhere in a template.
   4   *
   5   * @package WordPress
   6   * @subpackage Template
   7   */
   8  
   9  /**
  10   * Load header template.
  11   *
  12   * Includes the header template for a theme or if a name is specified then a
  13   * specialised header will be included.
  14   *
  15   * For the parameter, if the file is called "header-special.php" then specify
  16   * "special".
  17   *
  18   * @since 1.5.0
  19   *
  20   * @param string $name The name of the specialised header.
  21   */
  22  function get_header( $name = null ) {
  23      /**
  24       * Fires before the header template file is loaded.
  25       *
  26       * @since 2.1.0
  27       * @since 2.8.0 $name parameter added.
  28       *
  29       * @param string|null $name Name of the specific header file to use. null for the default header.
  30       */
  31      do_action( 'get_header', $name );
  32  
  33      $templates = array();
  34      $name      = (string) $name;
  35      if ( '' !== $name ) {
  36          $templates[] = "header-{$name}.php";
  37      }
  38  
  39      $templates[] = 'header.php';
  40  
  41      locate_template( $templates, true );
  42  }
  43  
  44  /**
  45   * Load footer template.
  46   *
  47   * Includes the footer template for a theme or if a name is specified then a
  48   * specialised footer will be included.
  49   *
  50   * For the parameter, if the file is called "footer-special.php" then specify
  51   * "special".
  52   *
  53   * @since 1.5.0
  54   *
  55   * @param string $name The name of the specialised footer.
  56   */
  57  function get_footer( $name = null ) {
  58      /**
  59       * Fires before the footer template file is loaded.
  60       *
  61       * @since 2.1.0
  62       * @since 2.8.0 $name parameter added.
  63       *
  64       * @param string|null $name Name of the specific footer file to use. null for the default footer.
  65       */
  66      do_action( 'get_footer', $name );
  67  
  68      $templates = array();
  69      $name      = (string) $name;
  70      if ( '' !== $name ) {
  71          $templates[] = "footer-{$name}.php";
  72      }
  73  
  74      $templates[] = 'footer.php';
  75  
  76      locate_template( $templates, true );
  77  }
  78  
  79  /**
  80   * Load sidebar template.
  81   *
  82   * Includes the sidebar template for a theme or if a name is specified then a
  83   * specialised sidebar will be included.
  84   *
  85   * For the parameter, if the file is called "sidebar-special.php" then specify
  86   * "special".
  87   *
  88   * @since 1.5.0
  89   *
  90   * @param string $name The name of the specialised sidebar.
  91   */
  92  function get_sidebar( $name = null ) {
  93      /**
  94       * Fires before the sidebar template file is loaded.
  95       *
  96       * @since 2.2.0
  97       * @since 2.8.0 $name parameter added.
  98       *
  99       * @param string|null $name Name of the specific sidebar file to use. null for the default sidebar.
 100       */
 101      do_action( 'get_sidebar', $name );
 102  
 103      $templates = array();
 104      $name      = (string) $name;
 105      if ( '' !== $name ) {
 106          $templates[] = "sidebar-{$name}.php";
 107      }
 108  
 109      $templates[] = 'sidebar.php';
 110  
 111      locate_template( $templates, true );
 112  }
 113  
 114  /**
 115   * Loads a template part into a template.
 116   *
 117   * Provides a simple mechanism for child themes to overload reusable sections of code
 118   * in the theme.
 119   *
 120   * Includes the named template part for a theme or if a name is specified then a
 121   * specialised part will be included. If the theme contains no {slug}.php file
 122   * then no template will be included.
 123   *
 124   * The template is included using require, not require_once, so you may include the
 125   * same template part multiple times.
 126   *
 127   * For the $name parameter, if the file is called "{slug}-special.php" then specify
 128   * "special".
 129   *
 130   * @since 3.0.0
 131   *
 132   * @param string $slug The slug name for the generic template.
 133   * @param string $name The name of the specialised template.
 134   */
 135  function get_template_part( $slug, $name = null ) {
 136      /**
 137       * Fires before the specified template part file is loaded.
 138       *
 139       * The dynamic portion of the hook name, `$slug`, refers to the slug name
 140       * for the generic template part.
 141       *
 142       * @since 3.0.0
 143       *
 144       * @param string      $slug The slug name for the generic template.
 145       * @param string|null $name The name of the specialized template.
 146       */
 147      do_action( "get_template_part_{$slug}", $slug, $name );
 148  
 149      $templates = array();
 150      $name      = (string) $name;
 151      if ( '' !== $name ) {
 152          $templates[] = "{$slug}-{$name}.php";
 153      }
 154  
 155      $templates[] = "{$slug}.php";
 156  
 157      /**
 158       * Fires before a template part is loaded.
 159       *
 160       * @since 5.2.0
 161       *
 162       * @param string   $slug      The slug name for the generic template.
 163       * @param string   $name      The name of the specialized template.
 164       * @param string[] $templates Array of template files to search for, in order.
 165       */
 166      do_action( 'get_template_part', $slug, $name, $templates );
 167  
 168      locate_template( $templates, true, false );
 169  }
 170  
 171  /**
 172   * Display search form.
 173   *
 174   * Will first attempt to locate the searchform.php file in either the child or
 175   * the parent, then load it. If it doesn't exist, then the default search form
 176   * will be displayed. The default search form is HTML, which will be displayed.
 177   * There is a filter applied to the search form HTML in order to edit or replace
 178   * it. The filter is {@see 'get_search_form'}.
 179   *
 180   * This function is primarily used by themes which want to hardcode the search
 181   * form into the sidebar and also by the search widget in WordPress.
 182   *
 183   * There is also an action that is called whenever the function is run called,
 184   * {@see 'pre_get_search_form'}. This can be useful for outputting JavaScript that the
 185   * search relies on or various formatting that applies to the beginning of the
 186   * search. To give a few examples of what it can be used for.
 187   *
 188   * @since 2.7.0
 189   * @since 5.2.0 The $args array parameter was added in place of an $echo boolean flag.
 190   *
 191   * @param array $args {
 192   *     Optional. Array of display arguments.
 193   *
 194   *     @type bool   $echo       Whether to echo or return the form. Default true.
 195   *     @type string $aria_label ARIA label for the search form. Useful to distinguish
 196   *                              multiple search forms on the same page and improve
 197   *                              accessibility. Default empty.
 198   * }
 199   * @return void|string Void if 'echo' argument is true, search form HTML if 'echo' is false.
 200   */
 201  function get_search_form( $args = array() ) {
 202      /**
 203       * Fires before the search form is retrieved, at the start of get_search_form().
 204       *
 205       * @since 2.7.0 as 'get_search_form' action.
 206       * @since 3.6.0
 207       *
 208       * @link https://core.trac.wordpress.org/ticket/19321
 209       */
 210      do_action( 'pre_get_search_form' );
 211  
 212      $echo = true;
 213  
 214      if ( ! is_array( $args ) ) {
 215          /*
 216           * Back compat: to ensure previous uses of get_search_form() continue to
 217           * function as expected, we handle a value for the boolean $echo param removed
 218           * in 5.2.0. Then we deal with the $args array and cast its defaults.
 219           */
 220          $echo = (bool) $args;
 221  
 222          // Set an empty array and allow default arguments to take over.
 223          $args = array();
 224      }
 225  
 226      // Defaults are to echo and to output no custom label on the form.
 227      $defaults = array(
 228          'echo'       => $echo,
 229          'aria_label' => '',
 230      );
 231  
 232      $args = wp_parse_args( $args, $defaults );
 233  
 234      /**
 235       * Filters the array of arguments used when generating the search form.
 236       *
 237       * @since 5.2.0
 238       *
 239       * @param array $args The array of arguments for building the search form.
 240       */
 241      $args = apply_filters( 'search_form_args', $args );
 242  
 243      $format = current_theme_supports( 'html5', 'search-form' ) ? 'html5' : 'xhtml';
 244  
 245      /**
 246       * Filters the HTML format of the search form.
 247       *
 248       * @since 3.6.0
 249       *
 250       * @param string $format The type of markup to use in the search form.
 251       *                       Accepts 'html5', 'xhtml'.
 252       */
 253      $format = apply_filters( 'search_form_format', $format );
 254  
 255      $search_form_template = locate_template( 'searchform.php' );
 256      if ( '' != $search_form_template ) {
 257          ob_start();
 258          require( $search_form_template );
 259          $form = ob_get_clean();
 260      } else {
 261          // Build a string containing an aria-label to use for the search form.
 262          if ( isset( $args['aria_label'] ) && $args['aria_label'] ) {
 263              $aria_label = 'aria-label="' . esc_attr( $args['aria_label'] ) . '" ';
 264          } else {
 265              /*
 266               * If there's no custom aria-label, we can set a default here. At the
 267               * moment it's empty as there's uncertainty about what the default should be.
 268               */
 269              $aria_label = '';
 270          }
 271          if ( 'html5' == $format ) {
 272              $form = '<form role="search" ' . $aria_label . 'method="get" class="search-form" action="' . esc_url( home_url( '/' ) ) . '">
 273                  <label>
 274                      <span class="screen-reader-text">' . _x( 'Search for:', 'label' ) . '</span>
 275                      <input type="search" class="search-field" placeholder="' . esc_attr_x( 'Search &hellip;', 'placeholder' ) . '" value="' . get_search_query() . '" name="s" />
 276                  </label>
 277                  <input type="submit" class="search-submit" value="' . esc_attr_x( 'Search', 'submit button' ) . '" />
 278              </form>';
 279          } else {
 280              $form = '<form role="search" ' . $aria_label . 'method="get" id="searchform" class="searchform" action="' . esc_url( home_url( '/' ) ) . '">
 281                  <div>
 282                      <label class="screen-reader-text" for="s">' . _x( 'Search for:', 'label' ) . '</label>
 283                      <input type="text" value="' . get_search_query() . '" name="s" id="s" />
 284                      <input type="submit" id="searchsubmit" value="' . esc_attr_x( 'Search', 'submit button' ) . '" />
 285                  </div>
 286              </form>';
 287          }
 288      }
 289  
 290      /**
 291       * Filters the HTML output of the search form.
 292       *
 293       * @since 2.7.0
 294       *
 295       * @param string $form The search form HTML output.
 296       */
 297      $result = apply_filters( 'get_search_form', $form );
 298  
 299      if ( null === $result ) {
 300          $result = $form;
 301      }
 302  
 303      if ( $args['echo'] ) {
 304          echo $result;
 305      } else {
 306          return $result;
 307      }
 308  }
 309  
 310  /**
 311   * Display the Log In/Out link.
 312   *
 313   * Displays a link, which allows users to navigate to the Log In page to log in
 314   * or log out depending on whether they are currently logged in.
 315   *
 316   * @since 1.5.0
 317   *
 318   * @param string $redirect Optional path to redirect to on login/logout.
 319   * @param bool   $echo     Default to echo and not return the link.
 320   * @return void|string Void if `$echo` argument is true, log in/out link if `$echo` is false.
 321   */
 322  function wp_loginout( $redirect = '', $echo = true ) {
 323      if ( ! is_user_logged_in() ) {
 324          $link = '<a href="' . esc_url( wp_login_url( $redirect ) ) . '">' . __( 'Log in' ) . '</a>';
 325      } else {
 326          $link = '<a href="' . esc_url( wp_logout_url( $redirect ) ) . '">' . __( 'Log out' ) . '</a>';
 327      }
 328  
 329      if ( $echo ) {
 330          /**
 331           * Filters the HTML output for the Log In/Log Out link.
 332           *
 333           * @since 1.5.0
 334           *
 335           * @param string $link The HTML link content.
 336           */
 337          echo apply_filters( 'loginout', $link );
 338      } else {
 339          /** This filter is documented in wp-includes/general-template.php */
 340          return apply_filters( 'loginout', $link );
 341      }
 342  }
 343  
 344  /**
 345   * Retrieves the logout URL.
 346   *
 347   * Returns the URL that allows the user to log out of the site.
 348   *
 349   * @since 2.7.0
 350   *
 351   * @param string $redirect Path to redirect to on logout.
 352   * @return string The logout URL. Note: HTML-encoded via esc_html() in wp_nonce_url().
 353   */
 354  function wp_logout_url( $redirect = '' ) {
 355      $args = array();
 356      if ( ! empty( $redirect ) ) {
 357          $args['redirect_to'] = urlencode( $redirect );
 358      }
 359  
 360      $logout_url = add_query_arg( $args, site_url( 'wp-login.php?action=logout', 'login' ) );
 361      $logout_url = wp_nonce_url( $logout_url, 'log-out' );
 362  
 363      /**
 364       * Filters the logout URL.
 365       *
 366       * @since 2.8.0
 367       *
 368       * @param string $logout_url The HTML-encoded logout URL.
 369       * @param string $redirect   Path to redirect to on logout.
 370       */
 371      return apply_filters( 'logout_url', $logout_url, $redirect );
 372  }
 373  
 374  /**
 375   * Retrieves the login URL.
 376   *
 377   * @since 2.7.0
 378   *
 379   * @param string $redirect     Path to redirect to on log in.
 380   * @param bool   $force_reauth Whether to force reauthorization, even if a cookie is present.
 381   *                             Default false.
 382   * @return string The login URL. Not HTML-encoded.
 383   */
 384  function wp_login_url( $redirect = '', $force_reauth = false ) {
 385      $login_url = site_url( 'wp-login.php', 'login' );
 386  
 387      if ( ! empty( $redirect ) ) {
 388          $login_url = add_query_arg( 'redirect_to', urlencode( $redirect ), $login_url );
 389      }
 390  
 391      if ( $force_reauth ) {
 392          $login_url = add_query_arg( 'reauth', '1', $login_url );
 393      }
 394  
 395      /**
 396       * Filters the login URL.
 397       *
 398       * @since 2.8.0
 399       * @since 4.2.0 The `$force_reauth` parameter was added.
 400       *
 401       * @param string $login_url    The login URL. Not HTML-encoded.
 402       * @param string $redirect     The path to redirect to on login, if supplied.
 403       * @param bool   $force_reauth Whether to force reauthorization, even if a cookie is present.
 404       */
 405      return apply_filters( 'login_url', $login_url, $redirect, $force_reauth );
 406  }
 407  
 408  /**
 409   * Returns the URL that allows the user to register on the site.
 410   *
 411   * @since 3.6.0
 412   *
 413   * @return string User registration URL.
 414   */
 415  function wp_registration_url() {
 416      /**
 417       * Filters the user registration URL.
 418       *
 419       * @since 3.6.0
 420       *
 421       * @param string $register The user registration URL.
 422       */
 423      return apply_filters( 'register_url', site_url( 'wp-login.php?action=register', 'login' ) );
 424  }
 425  
 426  /**
 427   * Provides a simple login form for use anywhere within WordPress.
 428   *
 429   * The login form HTML is echoed by default. Pass a false value for `$echo` to return it instead.
 430   *
 431   * @since 3.0.0
 432   *
 433   * @param array $args {
 434   *     Optional. Array of options to control the form output. Default empty array.
 435   *
 436   *     @type bool   $echo           Whether to display the login form or return the form HTML code.
 437   *                                  Default true (echo).
 438   *     @type string $redirect       URL to redirect to. Must be absolute, as in "https://example.com/mypage/".
 439   *                                  Default is to redirect back to the request URI.
 440   *     @type string $form_id        ID attribute value for the form. Default 'loginform'.
 441   *     @type string $label_username Label for the username or email address field. Default 'Username or Email Address'.
 442   *     @type string $label_password Label for the password field. Default 'Password'.
 443   *     @type string $label_remember Label for the remember field. Default 'Remember Me'.
 444   *     @type string $label_log_in   Label for the submit button. Default 'Log In'.
 445   *     @type string $id_username    ID attribute value for the username field. Default 'user_login'.
 446   *     @type string $id_password    ID attribute value for the password field. Default 'user_pass'.
 447   *     @type string $id_remember    ID attribute value for the remember field. Default 'rememberme'.
 448   *     @type string $id_submit      ID attribute value for the submit button. Default 'wp-submit'.
 449   *     @type bool   $remember       Whether to display the "rememberme" checkbox in the form.
 450   *     @type string $value_username Default value for the username field. Default empty.
 451   *     @type bool   $value_remember Whether the "Remember Me" checkbox should be checked by default.
 452   *                                  Default false (unchecked).
 453   *
 454   * }
 455   * @return void|string Void if 'echo' argument is true, login form HTML if 'echo' is false.
 456   */
 457  function wp_login_form( $args = array() ) {
 458      $defaults = array(
 459          'echo'           => true,
 460          // Default 'redirect' value takes the user back to the request URI.
 461          'redirect'       => ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'],
 462          'form_id'        => 'loginform',
 463          'label_username' => __( 'Username or Email Address' ),
 464          'label_password' => __( 'Password' ),
 465          'label_remember' => __( 'Remember Me' ),
 466          'label_log_in'   => __( 'Log In' ),
 467          'id_username'    => 'user_login',
 468          'id_password'    => 'user_pass',
 469          'id_remember'    => 'rememberme',
 470          'id_submit'      => 'wp-submit',
 471          'remember'       => true,
 472          'value_username' => '',
 473          // Set 'value_remember' to true to default the "Remember me" checkbox to checked.
 474          'value_remember' => false,
 475      );
 476  
 477      /**
 478       * Filters the default login form output arguments.
 479       *
 480       * @since 3.0.0
 481       *
 482       * @see wp_login_form()
 483       *
 484       * @param array $defaults An array of default login form arguments.
 485       */
 486      $args = wp_parse_args( $args, apply_filters( 'login_form_defaults', $defaults ) );
 487  
 488      /**
 489       * Filters content to display at the top of the login form.
 490       *
 491       * The filter evaluates just following the opening form tag element.
 492       *
 493       * @since 3.0.0
 494       *
 495       * @param string $content Content to display. Default empty.
 496       * @param array  $args    Array of login form arguments.
 497       */
 498      $login_form_top = apply_filters( 'login_form_top', '', $args );
 499  
 500      /**
 501       * Filters content to display in the middle of the login form.
 502       *
 503       * The filter evaluates just following the location where the 'login-password'
 504       * field is displayed.
 505       *
 506       * @since 3.0.0
 507       *
 508       * @param string $content Content to display. Default empty.
 509       * @param array  $args    Array of login form arguments.
 510       */
 511      $login_form_middle = apply_filters( 'login_form_middle', '', $args );
 512  
 513      /**
 514       * Filters content to display at the bottom of the login form.
 515       *
 516       * The filter evaluates just preceding the closing form tag element.
 517       *
 518       * @since 3.0.0
 519       *
 520       * @param string $content Content to display. Default empty.
 521       * @param array  $args    Array of login form arguments.
 522       */
 523      $login_form_bottom = apply_filters( 'login_form_bottom', '', $args );
 524  
 525      $form = '
 526          <form name="' . $args['form_id'] . '" id="' . $args['form_id'] . '" action="' . esc_url( site_url( 'wp-login.php', 'login_post' ) ) . '" method="post">
 527              ' . $login_form_top . '
 528              <p class="login-username">
 529                  <label for="' . esc_attr( $args['id_username'] ) . '">' . esc_html( $args['label_username'] ) . '</label>
 530                  <input type="text" name="log" id="' . esc_attr( $args['id_username'] ) . '" class="input" value="' . esc_attr( $args['value_username'] ) . '" size="20" />
 531              </p>
 532              <p class="login-password">
 533                  <label for="' . esc_attr( $args['id_password'] ) . '">' . esc_html( $args['label_password'] ) . '</label>
 534                  <input type="password" name="pwd" id="' . esc_attr( $args['id_password'] ) . '" class="input" value="" size="20" />
 535              </p>
 536              ' . $login_form_middle . '
 537              ' . ( $args['remember'] ? '<p class="login-remember"><label><input name="rememberme" type="checkbox" id="' . esc_attr( $args['id_remember'] ) . '" value="forever"' . ( $args['value_remember'] ? ' checked="checked"' : '' ) . ' /> ' . esc_html( $args['label_remember'] ) . '</label></p>' : '' ) . '
 538              <p class="login-submit">
 539                  <input type="submit" name="wp-submit" id="' . esc_attr( $args['id_submit'] ) . '" class="button button-primary" value="' . esc_attr( $args['label_log_in'] ) . '" />
 540                  <input type="hidden" name="redirect_to" value="' . esc_url( $args['redirect'] ) . '" />
 541              </p>
 542              ' . $login_form_bottom . '
 543          </form>';
 544  
 545      if ( $args['echo'] ) {
 546          echo $form;
 547      } else {
 548          return $form;
 549      }
 550  }
 551  
 552  /**
 553   * Returns the URL that allows the user to retrieve the lost password
 554   *
 555   * @since 2.8.0
 556   *
 557   * @param string $redirect Path to redirect to on login.
 558   * @return string Lost password URL.
 559   */
 560  function wp_lostpassword_url( $redirect = '' ) {
 561      $args = array();
 562      if ( ! empty( $redirect ) ) {
 563          $args['redirect_to'] = urlencode( $redirect );
 564      }
 565  
 566      $lostpassword_url = add_query_arg( $args, network_site_url( 'wp-login.php?action=lostpassword', 'login' ) );
 567  
 568      /**
 569       * Filters the Lost Password URL.
 570       *
 571       * @since 2.8.0
 572       *
 573       * @param string $lostpassword_url The lost password page URL.
 574       * @param string $redirect         The path to redirect to on login.
 575       */
 576      return apply_filters( 'lostpassword_url', $lostpassword_url, $redirect );
 577  }
 578  
 579  /**
 580   * Display the Registration or Admin link.
 581   *
 582   * Display a link which allows the user to navigate to the registration page if
 583   * not logged in and registration is enabled or to the dashboard if logged in.
 584   *
 585   * @since 1.5.0
 586   *
 587   * @param string $before Text to output before the link. Default `<li>`.
 588   * @param string $after  Text to output after the link. Default `</li>`.
 589   * @param bool   $echo   Default to echo and not return the link.
 590   * @return void|string Void if `$echo` argument is true, registration or admin link
 591   *                     if `$echo` is false.
 592   */
 593  function wp_register( $before = '<li>', $after = '</li>', $echo = true ) {
 594      if ( ! is_user_logged_in() ) {
 595          if ( get_option( 'users_can_register' ) ) {
 596              $link = $before . '<a href="' . esc_url( wp_registration_url() ) . '">' . __( 'Register' ) . '</a>' . $after;
 597          } else {
 598              $link = '';
 599          }
 600      } elseif ( current_user_can( 'read' ) ) {
 601          $link = $before . '<a href="' . admin_url() . '">' . __( 'Site Admin' ) . '</a>' . $after;
 602      } else {
 603          $link = '';
 604      }
 605  
 606      /**
 607       * Filters the HTML link to the Registration or Admin page.
 608       *
 609       * Users are sent to the admin page if logged-in, or the registration page
 610       * if enabled and logged-out.
 611       *
 612       * @since 1.5.0
 613       *
 614       * @param string $link The HTML code for the link to the Registration or Admin page.
 615       */
 616      $link = apply_filters( 'register', $link );
 617  
 618      if ( $echo ) {
 619          echo $link;
 620      } else {
 621          return $link;
 622      }
 623  }
 624  
 625  /**
 626   * Theme container function for the 'wp_meta' action.
 627   *
 628   * The {@see 'wp_meta'} action can have several purposes, depending on how you use it,
 629   * but one purpose might have been to allow for theme switching.
 630   *
 631   * @since 1.5.0
 632   *
 633   * @link https://core.trac.wordpress.org/ticket/1458 Explanation of 'wp_meta' action.
 634   */
 635  function wp_meta() {
 636      /**
 637       * Fires before displaying echoed content in the sidebar.
 638       *
 639       * @since 1.5.0
 640       */
 641      do_action( 'wp_meta' );
 642  }
 643  
 644  /**
 645   * Displays information about the current site.
 646   *
 647   * @since 0.71
 648   *
 649   * @see get_bloginfo() For possible `$show` values
 650   *
 651   * @param string $show Optional. Site information to display. Default empty.
 652   */
 653  function bloginfo( $show = '' ) {
 654      echo get_bloginfo( $show, 'display' );
 655  }
 656  
 657  /**
 658   * Retrieves information about the current site.
 659   *
 660   * Possible values for `$show` include:
 661   *
 662   * - 'name' - Site title (set in Settings > General)
 663   * - 'description' - Site tagline (set in Settings > General)
 664   * - 'wpurl' - The WordPress address (URL) (set in Settings > General)
 665   * - 'url' - The Site address (URL) (set in Settings > General)
 666   * - 'admin_email' - Admin email (set in Settings > General)
 667   * - 'charset' - The "Encoding for pages and feeds"  (set in Settings > Reading)
 668   * - 'version' - The current WordPress version
 669   * - 'html_type' - The content-type (default: "text/html"). Themes and plugins
 670   *   can override the default value using the {@see 'pre_option_html_type'} filter
 671   * - 'text_direction' - The text direction determined by the site's language. is_rtl()
 672   *   should be used instead
 673   * - 'language' - Language code for the current site
 674   * - 'stylesheet_url' - URL to the stylesheet for the active theme. An active child theme
 675   *   will take precedence over this value
 676   * - 'stylesheet_directory' - Directory path for the active theme.  An active child theme
 677   *   will take precedence over this value
 678   * - 'template_url' / 'template_directory' - URL of the active theme's directory. An active
 679   *   child theme will NOT take precedence over this value
 680   * - 'pingback_url' - The pingback XML-RPC file URL (xmlrpc.php)
 681   * - 'atom_url' - The Atom feed URL (/feed/atom)
 682   * - 'rdf_url' - The RDF/RSS 1.0 feed URL (/feed/rdf)
 683   * - 'rss_url' - The RSS 0.92 feed URL (/feed/rss)
 684   * - 'rss2_url' - The RSS 2.0 feed URL (/feed)
 685   * - 'comments_atom_url' - The comments Atom feed URL (/comments/feed)
 686   * - 'comments_rss2_url' - The comments RSS 2.0 feed URL (/comments/feed)
 687   *
 688   * Some `$show` values are deprecated and will be removed in future versions.
 689   * These options will trigger the _deprecated_argument() function.
 690   *
 691   * Deprecated arguments include:
 692   *
 693   * - 'siteurl' - Use 'url' instead
 694   * - 'home' - Use 'url' instead
 695   *
 696   * @since 0.71
 697   *
 698   * @global string $wp_version
 699   *
 700   * @param string $show   Optional. Site info to retrieve. Default empty (site name).
 701   * @param string $filter Optional. How to filter what is retrieved. Default 'raw'.
 702   * @return string Mostly string values, might be empty.
 703   */
 704  function get_bloginfo( $show = '', $filter = 'raw' ) {
 705      switch ( $show ) {
 706          case 'home': // DEPRECATED
 707          case 'siteurl': // DEPRECATED
 708              _deprecated_argument(
 709                  __FUNCTION__,
 710                  '2.2.0',
 711                  sprintf(
 712                      /* translators: 1: 'siteurl'/'home' argument, 2: bloginfo() function name, 3: 'url' argument. */
 713                      __( 'The %1$s option is deprecated for the family of %2$s functions. Use the %3$s option instead.' ),
 714                      '<code>' . $show . '</code>',
 715                      '<code>bloginfo()</code>',
 716                      '<code>url</code>'
 717                  )
 718              );
 719              // Intentional fall-through to be handled by the 'url' case.
 720          case 'url':
 721              $output = home_url();
 722              break;
 723          case 'wpurl':
 724              $output = site_url();
 725              break;
 726          case 'description':
 727              $output = get_option( 'blogdescription' );
 728              break;
 729          case 'rdf_url':
 730              $output = get_feed_link( 'rdf' );
 731              break;
 732          case 'rss_url':
 733              $output = get_feed_link( 'rss' );
 734              break;
 735          case 'rss2_url':
 736              $output = get_feed_link( 'rss2' );
 737              break;
 738          case 'atom_url':
 739              $output = get_feed_link( 'atom' );
 740              break;
 741          case 'comments_atom_url':
 742              $output = get_feed_link( 'comments_atom' );
 743              break;
 744          case 'comments_rss2_url':
 745              $output = get_feed_link( 'comments_rss2' );
 746              break;
 747          case 'pingback_url':
 748              $output = site_url( 'xmlrpc.php' );
 749              break;
 750          case 'stylesheet_url':
 751              $output = get_stylesheet_uri();
 752              break;
 753          case 'stylesheet_directory':
 754              $output = get_stylesheet_directory_uri();
 755              break;
 756          case 'template_directory':
 757          case 'template_url':
 758              $output = get_template_directory_uri();
 759              break;
 760          case 'admin_email':
 761              $output = get_option( 'admin_email' );
 762              break;
 763          case 'charset':
 764              $output = get_option( 'blog_charset' );
 765              if ( '' == $output ) {
 766                  $output = 'UTF-8';
 767              }
 768              break;
 769          case 'html_type':
 770              $output = get_option( 'html_type' );
 771              break;
 772          case 'version':
 773              global $wp_version;
 774              $output = $wp_version;
 775              break;
 776          case 'language':
 777              /*
 778               * translators: Translate this to the correct language tag for your locale,
 779               * see https://www.w3.org/International/articles/language-tags/ for reference.
 780               * Do not translate into your own language.
 781               */
 782              $output = __( 'html_lang_attribute' );
 783              if ( 'html_lang_attribute' === $output || preg_match( '/[^a-zA-Z0-9-]/', $output ) ) {
 784                  $output = determine_locale();
 785                  $output = str_replace( '_', '-', $output );
 786              }
 787              break;
 788          case 'text_direction':
 789              _deprecated_argument(
 790                  __FUNCTION__,
 791                  '2.2.0',
 792                  sprintf(
 793                      /* translators: 1: 'text_direction' argument, 2: bloginfo() function name, 3: is_rtl() function name. */
 794                      __( 'The %1$s option is deprecated for the family of %2$s functions. Use the %3$s function instead.' ),
 795                      '<code>' . $show . '</code>',
 796                      '<code>bloginfo()</code>',
 797                      '<code>is_rtl()</code>'
 798                  )
 799              );
 800              if ( function_exists( 'is_rtl' ) ) {
 801                  $output = is_rtl() ? 'rtl' : 'ltr';
 802              } else {
 803                  $output = 'ltr';
 804              }
 805              break;
 806          case 'name':
 807          default:
 808              $output = get_option( 'blogname' );
 809              break;
 810      }
 811  
 812      $url = true;
 813      if ( strpos( $show, 'url' ) === false &&
 814          strpos( $show, 'directory' ) === false &&
 815          strpos( $show, 'home' ) === false ) {
 816          $url = false;
 817      }
 818  
 819      if ( 'display' == $filter ) {
 820          if ( $url ) {
 821              /**
 822               * Filters the URL returned by get_bloginfo().
 823               *
 824               * @since 2.0.5
 825               *
 826               * @param mixed $output The URL returned by bloginfo().
 827               * @param mixed $show   Type of information requested.
 828               */
 829              $output = apply_filters( 'bloginfo_url', $output, $show );
 830          } else {
 831              /**
 832               * Filters the site information returned by get_bloginfo().
 833               *
 834               * @since 0.71
 835               *
 836               * @param mixed $output The requested non-URL site information.
 837               * @param mixed $show   Type of information requested.
 838               */
 839              $output = apply_filters( 'bloginfo', $output, $show );
 840          }
 841      }
 842  
 843      return $output;
 844  }
 845  
 846  /**
 847   * Returns the Site Icon URL.
 848   *
 849   * @since 4.3.0
 850   *
 851   * @param int    $size    Optional. Size of the site icon. Default 512 (pixels).
 852   * @param string $url     Optional. Fallback url if no site icon is found. Default empty.
 853   * @param int    $blog_id Optional. ID of the blog to get the site icon for. Default current blog.
 854   * @return string Site Icon URL.
 855   */
 856  function get_site_icon_url( $size = 512, $url = '', $blog_id = 0 ) {
 857      $switched_blog = false;
 858  
 859      if ( is_multisite() && ! empty( $blog_id ) && (int) $blog_id !== get_current_blog_id() ) {
 860          switch_to_blog( $blog_id );
 861          $switched_blog = true;
 862      }
 863  
 864      $site_icon_id = get_option( 'site_icon' );
 865  
 866      if ( $site_icon_id ) {
 867          if ( $size >= 512 ) {
 868              $size_data = 'full';
 869          } else {
 870              $size_data = array( $size, $size );
 871          }
 872          $url = wp_get_attachment_image_url( $site_icon_id, $size_data );
 873      }
 874  
 875      if ( $switched_blog ) {
 876          restore_current_blog();
 877      }
 878  
 879      /**
 880       * Filters the site icon URL.
 881       *
 882       * @since 4.4.0
 883       *
 884       * @param string $url     Site icon URL.
 885       * @param int    $size    Size of the site icon.
 886       * @param int    $blog_id ID of the blog to get the site icon for.
 887       */
 888      return apply_filters( 'get_site_icon_url', $url, $size, $blog_id );
 889  }
 890  
 891  /**
 892   * Displays the Site Icon URL.
 893   *
 894   * @since 4.3.0
 895   *
 896   * @param int    $size    Optional. Size of the site icon. Default 512 (pixels).
 897   * @param string $url     Optional. Fallback url if no site icon is found. Default empty.
 898   * @param int    $blog_id Optional. ID of the blog to get the site icon for. Default current blog.
 899   */
 900  function site_icon_url( $size = 512, $url = '', $blog_id = 0 ) {
 901      echo esc_url( get_site_icon_url( $size, $url, $blog_id ) );
 902  }
 903  
 904  /**
 905   * Whether the site has a Site Icon.
 906   *
 907   * @since 4.3.0
 908   *
 909   * @param int $blog_id Optional. ID of the blog in question. Default current blog.
 910   * @return bool Whether the site has a site icon or not.
 911   */
 912  function has_site_icon( $blog_id = 0 ) {
 913      return (bool) get_site_icon_url( 512, '', $blog_id );
 914  }
 915  
 916  /**
 917   * Determines whether the site has a custom logo.
 918   *
 919   * @since 4.5.0
 920   *
 921   * @param int $blog_id Optional. ID of the blog in question. Default is the ID of the current blog.
 922   * @return bool Whether the site has a custom logo or not.
 923   */
 924  function has_custom_logo( $blog_id = 0 ) {
 925      $switched_blog = false;
 926  
 927      if ( is_multisite() && ! empty( $blog_id ) && (int) $blog_id !== get_current_blog_id() ) {
 928          switch_to_blog( $blog_id );
 929          $switched_blog = true;
 930      }
 931  
 932      $custom_logo_id = get_theme_mod( 'custom_logo' );
 933  
 934      if ( $switched_blog ) {
 935          restore_current_blog();
 936      }
 937  
 938      return (bool) $custom_logo_id;
 939  }
 940  
 941  /**
 942   * Returns a custom logo, linked to home.
 943   *
 944   * @since 4.5.0
 945   *
 946   * @param int $blog_id Optional. ID of the blog in question. Default is the ID of the current blog.
 947   * @return string Custom logo markup.
 948   */
 949  function get_custom_logo( $blog_id = 0 ) {
 950      $html          = '';
 951      $switched_blog = false;
 952  
 953      if ( is_multisite() && ! empty( $blog_id ) && (int) $blog_id !== get_current_blog_id() ) {
 954          switch_to_blog( $blog_id );
 955          $switched_blog = true;
 956      }
 957  
 958      $custom_logo_id = get_theme_mod( 'custom_logo' );
 959  
 960      // We have a logo. Logo is go.
 961      if ( $custom_logo_id ) {
 962          $custom_logo_attr = array(
 963              'class' => 'custom-logo',
 964          );
 965  
 966          /*
 967           * If the logo alt attribute is empty, get the site title and explicitly
 968           * pass it to the attributes used by wp_get_attachment_image().
 969           */
 970          $image_alt = get_post_meta( $custom_logo_id, '_wp_attachment_image_alt', true );
 971          if ( empty( $image_alt ) ) {
 972              $custom_logo_attr['alt'] = get_bloginfo( 'name', 'display' );
 973          }
 974  
 975          /*
 976           * If the alt attribute is not empty, there's no need to explicitly pass
 977           * it because wp_get_attachment_image() already adds the alt attribute.
 978           */
 979          $html = sprintf(
 980              '<a href="%1$s" class="custom-logo-link" rel="home">%2$s</a>',
 981              esc_url( home_url( '/' ) ),
 982              wp_get_attachment_image( $custom_logo_id, 'full', false, $custom_logo_attr )
 983          );
 984      } elseif ( is_customize_preview() ) {
 985          // If no logo is set but we're in the Customizer, leave a placeholder (needed for the live preview).
 986          $html = sprintf(
 987              '<a href="%1$s" class="custom-logo-link" style="display:none;"><img class="custom-logo"/></a>',
 988              esc_url( home_url( '/' ) )
 989          );
 990      }
 991  
 992      if ( $switched_blog ) {
 993          restore_current_blog();
 994      }
 995  
 996      /**
 997       * Filters the custom logo output.
 998       *
 999       * @since 4.5.0
1000       * @since 4.6.0 Added the `$blog_id` parameter.
1001       *
1002       * @param string $html    Custom logo HTML output.
1003       * @param int    $blog_id ID of the blog to get the custom logo for.
1004       */
1005      return apply_filters( 'get_custom_logo', $html, $blog_id );
1006  }
1007  
1008  /**
1009   * Displays a custom logo, linked to home.
1010   *
1011   * @since 4.5.0
1012   *
1013   * @param int $blog_id Optional. ID of the blog in question. Default is the ID of the current blog.
1014   */
1015  function the_custom_logo( $blog_id = 0 ) {
1016      echo get_custom_logo( $blog_id );
1017  }
1018  
1019  /**
1020   * Returns document title for the current page.
1021   *
1022   * @since 4.4.0
1023   *
1024   * @global int $page  Page number of a single post.
1025   * @global int $paged Page number of a list of posts.
1026   *
1027   * @return string Tag with the document title.
1028   */
1029  function wp_get_document_title() {
1030  
1031      /**
1032       * Filters the document title before it is generated.
1033       *
1034       * Passing a non-empty value will short-circuit wp_get_document_title(),
1035       * returning that value instead.
1036       *
1037       * @since 4.4.0
1038       *
1039       * @param string $title The document title. Default empty string.
1040       */
1041      $title = apply_filters( 'pre_get_document_title', '' );
1042      if ( ! empty( $title ) ) {
1043          return $title;
1044      }
1045  
1046      global $page, $paged;
1047  
1048      $title = array(
1049          'title' => '',
1050      );
1051  
1052      // If it's a 404 page, use a "Page not found" title.
1053      if ( is_404() ) {
1054          $title['title'] = __( 'Page not found' );
1055  
1056          // If it's a search, use a dynamic search results title.
1057      } elseif ( is_search() ) {
1058          /* translators: %s: Search query. */
1059          $title['title'] = sprintf( __( 'Search Results for &#8220;%s&#8221;' ), get_search_query() );
1060  
1061          // If on the front page, use the site title.
1062      } elseif ( is_front_page() ) {
1063          $title['title'] = get_bloginfo( 'name', 'display' );
1064  
1065          // If on a post type archive, use the post type archive title.
1066      } elseif ( is_post_type_archive() ) {
1067          $title['title'] = post_type_archive_title( '', false );
1068  
1069          // If on a taxonomy archive, use the term title.
1070      } elseif ( is_tax() ) {
1071          $title['title'] = single_term_title( '', false );
1072  
1073          /*
1074          * If we're on the blog page that is not the homepage or
1075          * a single post of any post type, use the post title.
1076          */
1077      } elseif ( is_home() || is_singular() ) {
1078          $title['title'] = single_post_title( '', false );
1079  
1080          // If on a category or tag archive, use the term title.
1081      } elseif ( is_category() || is_tag() ) {
1082          $title['title'] = single_term_title( '', false );
1083  
1084          // If on an author archive, use the author's display name.
1085      } elseif ( is_author() && get_queried_object() ) {
1086          $author         = get_queried_object();
1087          $title['title'] = $author->display_name;
1088  
1089          // If it's a date archive, use the date as the title.
1090      } elseif ( is_year() ) {
1091          $title['title'] = get_the_date( _x( 'Y', 'yearly archives date format' ) );
1092  
1093      } elseif ( is_month() ) {
1094          $title['title'] = get_the_date( _x( 'F Y', 'monthly archives date format' ) );
1095  
1096      } elseif ( is_day() ) {
1097          $title['title'] = get_the_date();
1098      }
1099  
1100      // Add a page number if necessary.
1101      if ( ( $paged >= 2 || $page >= 2 ) && ! is_404() ) {
1102          /* translators: %s: Page number. */
1103          $title['page'] = sprintf( __( 'Page %s' ), max( $paged, $page ) );
1104      }
1105  
1106      // Append the description or site title to give context.
1107      if ( is_front_page() ) {
1108          $title['tagline'] = get_bloginfo( 'description', 'display' );
1109      } else {
1110          $title['site'] = get_bloginfo( 'name', 'display' );
1111      }
1112  
1113      /**
1114       * Filters the separator for the document title.
1115       *
1116       * @since 4.4.0
1117       *
1118       * @param string $sep Document title separator. Default '-'.
1119       */
1120      $sep = apply_filters( 'document_title_separator', '-' );
1121  
1122      /**
1123       * Filters the parts of the document title.
1124       *
1125       * @since 4.4.0
1126       *
1127       * @param array $title {
1128       *     The document title parts.
1129       *
1130       *     @type string $title   Title of the viewed page.
1131       *     @type string $page    Optional. Page number if paginated.
1132       *     @type string $tagline Optional. Site description when on home page.
1133       *     @type string $site    Optional. Site title when not on home page.
1134       * }
1135       */
1136      $title = apply_filters( 'document_title_parts', $title );
1137  
1138      $title = implode( " $sep ", array_filter( $title ) );
1139      $title = wptexturize( $title );
1140      $title = convert_chars( $title );
1141      $title = esc_html( $title );
1142      $title = capital_P_dangit( $title );
1143  
1144      return $title;
1145  }
1146  
1147  /**
1148   * Displays title tag with content.
1149   *
1150   * @ignore
1151   * @since 4.1.0
1152   * @since 4.4.0 Improved title output replaced `wp_title()`.
1153   * @access private
1154   */
1155  function _wp_render_title_tag() {
1156      if ( ! current_theme_supports( 'title-tag' ) ) {
1157          return;
1158      }
1159  
1160      echo '<title>' . wp_get_document_title() . '</title>' . "\n";
1161  }
1162  
1163  /**
1164   * Display or retrieve page title for all areas of blog.
1165   *
1166   * By default, the page title will display the separator before the page title,
1167   * so that the blog title will be before the page title. This is not good for
1168   * title display, since the blog title shows up on most tabs and not what is
1169   * important, which is the page that the user is looking at.
1170   *
1171   * There are also SEO benefits to having the blog title after or to the 'right'
1172   * of the page title. However, it is mostly common sense to have the blog title
1173   * to the right with most browsers supporting tabs. You can achieve this by
1174   * using the seplocation parameter and setting the value to 'right'. This change
1175   * was introduced around 2.5.0, in case backward compatibility of themes is
1176   * important.
1177   *
1178   * @since 1.0.0
1179   *
1180   * @global WP_Locale $wp_locale WordPress date and time locale object.
1181   *
1182   * @param string $sep         Optional, default is '&raquo;'. How to separate the various items
1183   *                            within the page title.
1184   * @param bool   $display     Optional, default is true. Whether to display or retrieve title.
1185   * @param string $seplocation Optional. Location of the separator ('left' or 'right').
1186   * @return string|null String on retrieve, null when displaying.
1187   */
1188  function wp_title( $sep = '&raquo;', $display = true, $seplocation = '' ) {
1189      global $wp_locale;
1190  
1191      $m        = get_query_var( 'm' );
1192      $year     = get_query_var( 'year' );
1193      $monthnum = get_query_var( 'monthnum' );
1194      $day      = get_query_var( 'day' );
1195      $search   = get_query_var( 's' );
1196      $title    = '';
1197  
1198      $t_sep = '%WP_TITLE_SEP%'; // Temporary separator, for accurate flipping, if necessary
1199  
1200      // If there is a post
1201      if ( is_single() || ( is_home() && ! is_front_page() ) || ( is_page() && ! is_front_page() ) ) {
1202          $title = single_post_title( '', false );
1203      }
1204  
1205      // If there's a post type archive
1206      if ( is_post_type_archive() ) {
1207          $post_type = get_query_var( 'post_type' );
1208          if ( is_array( $post_type ) ) {
1209              $post_type = reset( $post_type );
1210          }
1211          $post_type_object = get_post_type_object( $post_type );
1212          if ( ! $post_type_object->has_archive ) {
1213              $title = post_type_archive_title( '', false );
1214          }
1215      }
1216  
1217      // If there's a category or tag
1218      if ( is_category() || is_tag() ) {
1219          $title = single_term_title( '', false );
1220      }
1221  
1222      // If there's a taxonomy
1223      if ( is_tax() ) {
1224          $term = get_queried_object();
1225          if ( $term ) {
1226              $tax   = get_taxonomy( $term->taxonomy );
1227              $title = single_term_title( $tax->labels->name . $t_sep, false );
1228          }
1229      }
1230  
1231      // If there's an author
1232      if ( is_author() && ! is_post_type_archive() ) {
1233          $author = get_queried_object();
1234          if ( $author ) {
1235              $title = $author->display_name;
1236          }
1237      }
1238  
1239      // Post type archives with has_archive should override terms.
1240      if ( is_post_type_archive() && $post_type_object->has_archive ) {
1241          $title = post_type_archive_title( '', false );
1242      }
1243  
1244      // If there's a month
1245      if ( is_archive() && ! empty( $m ) ) {
1246          $my_year  = substr( $m, 0, 4 );
1247          $my_month = $wp_locale->get_month( substr( $m, 4, 2 ) );
1248          $my_day   = intval( substr( $m, 6, 2 ) );
1249          $title    = $my_year . ( $my_month ? $t_sep . $my_month : '' ) . ( $my_day ? $t_sep . $my_day : '' );
1250      }
1251  
1252      // If there's a year
1253      if ( is_archive() && ! empty( $year ) ) {
1254          $title = $year;
1255          if ( ! empty( $monthnum ) ) {
1256              $title .= $t_sep . $wp_locale->get_month( $monthnum );
1257          }
1258          if ( ! empty( $day ) ) {
1259              $title .= $t_sep . zeroise( $day, 2 );
1260          }
1261      }
1262  
1263      // If it's a search
1264      if ( is_search() ) {
1265          /* translators: 1: Separator, 2: Search query. */
1266          $title = sprintf( __( 'Search Results %1$s %2$s' ), $t_sep, strip_tags( $search ) );
1267      }
1268  
1269      // If it's a 404 page
1270      if ( is_404() ) {
1271          $title = __( 'Page not found' );
1272      }
1273  
1274      $prefix = '';
1275      if ( ! empty( $title ) ) {
1276          $prefix = " $sep ";
1277      }
1278  
1279      /**
1280       * Filters the parts of the page title.
1281       *
1282       * @since 4.0.0
1283       *
1284       * @param string[] $title_array Array of parts of the page title.
1285       */
1286      $title_array = apply_filters( 'wp_title_parts', explode( $t_sep, $title ) );
1287  
1288      // Determines position of the separator and direction of the breadcrumb
1289      if ( 'right' == $seplocation ) { // sep on right, so reverse the order
1290          $title_array = array_reverse( $title_array );
1291          $title       = implode( " $sep ", $title_array ) . $prefix;
1292      } else {
1293          $title = $prefix . implode( " $sep ", $title_array );
1294      }
1295  
1296      /**
1297       * Filters the text of the page title.
1298       *
1299       * @since 2.0.0
1300       *
1301       * @param string $title       Page title.
1302       * @param string $sep         Title separator.
1303       * @param string $seplocation Location of the separator ('left' or 'right').
1304       */
1305      $title = apply_filters( 'wp_title', $title, $sep, $seplocation );
1306  
1307      // Send it out
1308      if ( $display ) {
1309          echo $title;
1310      } else {
1311          return $title;
1312      }
1313  }
1314  
1315  /**
1316   * Display or retrieve page title for post.
1317   *
1318   * This is optimized for single.php template file for displaying the post title.
1319   *
1320   * It does not support placing the separator after the title, but by leaving the
1321   * prefix parameter empty, you can set the title separator manually. The prefix
1322   * does not automatically place a space between the prefix, so if there should
1323   * be a space, the parameter value will need to have it at the end.
1324   *
1325   * @since 0.71
1326   *
1327   * @param string $prefix  Optional. What to display before the title.
1328   * @param bool   $display Optional, default is true. Whether to display or retrieve title.
1329   * @return string|void Title when retrieving.
1330   */
1331  function single_post_title( $prefix = '', $display = true ) {
1332      $_post = get_queried_object();
1333  
1334      if ( ! isset( $_post->post_title ) ) {
1335          return;
1336      }
1337  
1338      /**
1339       * Filters the page title for a single post.
1340       *
1341       * @since 0.71
1342       *
1343       * @param string  $_post_title The single post page title.
1344       * @param WP_Post $_post       The current post.
1345       */
1346      $title = apply_filters( 'single_post_title', $_post->post_title, $_post );
1347      if ( $display ) {
1348          echo $prefix . $title;
1349      } else {
1350          return $prefix . $title;
1351      }
1352  }
1353  
1354  /**
1355   * Display or retrieve title for a post type archive.
1356   *
1357   * This is optimized for archive.php and archive-{$post_type}.php template files
1358   * for displaying the title of the post type.
1359   *
1360   * @since 3.1.0
1361   *
1362   * @param string $prefix  Optional. What to display before the title.
1363   * @param bool   $display Optional, default is true. Whether to display or retrieve title.
1364   * @return string|void Title when retrieving, null when displaying or failure.
1365   */
1366  function post_type_archive_title( $prefix = '', $display = true ) {
1367      if ( ! is_post_type_archive() ) {
1368          return;
1369      }
1370  
1371      $post_type = get_query_var( 'post_type' );
1372      if ( is_array( $post_type ) ) {
1373          $post_type = reset( $post_type );
1374      }
1375  
1376      $post_type_obj = get_post_type_object( $post_type );
1377  
1378      /**
1379       * Filters the post type archive title.
1380       *
1381       * @since 3.1.0
1382       *
1383       * @param string $post_type_name Post type 'name' label.
1384       * @param string $post_type      Post type.
1385       */
1386      $title = apply_filters( 'post_type_archive_title', $post_type_obj->labels->name, $post_type );
1387  
1388      if ( $display ) {
1389          echo $prefix . $title;
1390      } else {
1391          return $prefix . $title;
1392      }
1393  }
1394  
1395  /**
1396   * Display or retrieve page title for category archive.
1397   *
1398   * Useful for category template files for displaying the category page title.
1399   * The prefix does not automatically place a space between the prefix, so if
1400   * there should be a space, the parameter value will need to have it at the end.
1401   *
1402   * @since 0.71
1403   *
1404   * @param string $prefix  Optional. What to display before the title.
1405   * @param bool   $display Optional, default is true. Whether to display or retrieve title.
1406   * @return string|void Title when retrieving.
1407   */
1408  function single_cat_title( $prefix = '', $display = true ) {
1409      return single_term_title( $prefix, $display );
1410  }
1411  
1412  /**
1413   * Display or retrieve page title for tag post archive.
1414   *
1415   * Useful for tag template files for displaying the tag page title. The prefix
1416   * does not automatically place a space between the prefix, so if there should
1417   * be a space, the parameter value will need to have it at the end.
1418   *
1419   * @since 2.3.0
1420   *
1421   * @param string $prefix  Optional. What to display before the title.
1422   * @param bool   $display Optional, default is true. Whether to display or retrieve title.
1423   * @return string|void Title when retrieving.
1424   */
1425  function single_tag_title( $prefix = '', $display = true ) {
1426      return single_term_title( $prefix, $display );
1427  }
1428  
1429  /**
1430   * Display or retrieve page title for taxonomy term archive.
1431   *
1432   * Useful for taxonomy term template files for displaying the taxonomy term page title.
1433   * The prefix does not automatically place a space between the prefix, so if there should
1434   * be a space, the parameter value will need to have it at the end.
1435   *
1436   * @since 3.1.0
1437   *
1438   * @param string $prefix  Optional. What to display before the title.
1439   * @param bool   $display Optional, default is true. Whether to display or retrieve title.
1440   * @return string|void Title when retrieving.
1441   */
1442  function single_term_title( $prefix = '', $display = true ) {
1443      $term = get_queried_object();
1444  
1445      if ( ! $term ) {
1446          return;
1447      }
1448  
1449      if ( is_category() ) {
1450          /**
1451           * Filters the category archive page title.
1452           *
1453           * @since 2.0.10
1454           *
1455           * @param string $term_name Category name for archive being displayed.
1456           */
1457          $term_name = apply_filters( 'single_cat_title', $term->name );
1458      } elseif ( is_tag() ) {
1459          /**
1460           * Filters the tag archive page title.
1461           *
1462           * @since 2.3.0
1463           *
1464           * @param string $term_name Tag name for archive being displayed.
1465           */
1466          $term_name = apply_filters( 'single_tag_title', $term->name );
1467      } elseif ( is_tax() ) {
1468          /**
1469           * Filters the custom taxonomy archive page title.
1470           *
1471           * @since 3.1.0
1472           *
1473           * @param string $term_name Term name for archive being displayed.
1474           */
1475          $term_name = apply_filters( 'single_term_title', $term->name );
1476      } else {
1477          return;
1478      }
1479  
1480      if ( empty( $term_name ) ) {
1481          return;
1482      }
1483  
1484      if ( $display ) {
1485          echo $prefix . $term_name;
1486      } else {
1487          return $prefix . $term_name;
1488      }
1489  }
1490  
1491  /**
1492   * Display or retrieve page title for post archive based on date.
1493   *
1494   * Useful for when the template only needs to display the month and year,
1495   * if either are available. The prefix does not automatically place a space
1496   * between the prefix, so if there should be a space, the parameter value
1497   * will need to have it at the end.
1498   *
1499   * @since 0.71
1500   *
1501   * @global WP_Locale $wp_locale WordPress date and time locale object.
1502   *
1503   * @param string $prefix  Optional. What to display before the title.
1504   * @param bool   $display Optional, default is true. Whether to display or retrieve title.
1505   * @return string|void Title when retrieving.
1506   */
1507  function single_month_title( $prefix = '', $display = true ) {
1508      global $wp_locale;
1509  
1510      $m        = get_query_var( 'm' );
1511      $year     = get_query_var( 'year' );
1512      $monthnum = get_query_var( 'monthnum' );
1513  
1514      if ( ! empty( $monthnum ) && ! empty( $year ) ) {
1515          $my_year  = $year;
1516          $my_month = $wp_locale->get_month( $monthnum );
1517      } elseif ( ! empty( $m ) ) {
1518          $my_year  = substr( $m, 0, 4 );
1519          $my_month = $wp_locale->get_month( substr( $m, 4, 2 ) );
1520      }
1521  
1522      if ( empty( $my_month ) ) {
1523          return false;
1524      }
1525  
1526      $result = $prefix . $my_month . $prefix . $my_year;
1527  
1528      if ( ! $display ) {
1529          return $result;
1530      }
1531      echo $result;
1532  }
1533  
1534  /**
1535   * Display the archive title based on the queried object.
1536   *
1537   * @since 4.1.0
1538   *
1539   * @see get_the_archive_title()
1540   *
1541   * @param string $before Optional. Content to prepend to the title. Default empty.
1542   * @param string $after  Optional. Content to append to the title. Default empty.
1543   */
1544  function the_archive_title( $before = '', $after = '' ) {
1545      $title = get_the_archive_title();
1546  
1547      if ( ! empty( $title ) ) {
1548          echo $before . $title . $after;
1549      }
1550  }
1551  
1552  /**
1553   * Retrieve the archive title based on the queried object.
1554   *
1555   * @since 4.1.0
1556   *
1557   * @return string Archive title.
1558   */
1559  function get_the_archive_title() {
1560      $title = __( 'Archives' );
1561  
1562      if ( is_category() ) {
1563          /* translators: Category archive title. %s: Category name. */
1564          $title = sprintf( __( 'Category: %s' ), single_cat_title( '', false ) );
1565      } elseif ( is_tag() ) {
1566          /* translators: Tag archive title. %s: Tag name. */
1567          $title = sprintf( __( 'Tag: %s' ), single_tag_title( '', false ) );
1568      } elseif ( is_author() ) {
1569          /* translators: Author archive title. %s: Author name. */
1570          $title = sprintf( __( 'Author: %s' ), '<span class="vcard">' . get_the_author() . '</span>' );
1571      } elseif ( is_year() ) {
1572          /* translators: Yearly archive title. %s: Year. */
1573          $title = sprintf( __( 'Year: %s' ), get_the_date( _x( 'Y', 'yearly archives date format' ) ) );
1574      } elseif ( is_month() ) {
1575          /* translators: Monthly archive title. %s: Month name and year. */
1576          $title = sprintf( __( 'Month: %s' ), get_the_date( _x( 'F Y', 'monthly archives date format' ) ) );
1577      } elseif ( is_day() ) {
1578          /* translators: Daily archive title. %s: Date. */
1579          $title = sprintf( __( 'Day: %s' ), get_the_date( _x( 'F j, Y', 'daily archives date format' ) ) );
1580      } elseif ( is_tax( 'post_format' ) ) {
1581          if ( is_tax( 'post_format', 'post-format-aside' ) ) {
1582              $title = _x( 'Asides', 'post format archive title' );
1583          } elseif ( is_tax( 'post_format', 'post-format-gallery' ) ) {
1584              $title = _x( 'Galleries', 'post format archive title' );
1585          } elseif ( is_tax( 'post_format', 'post-format-image' ) ) {
1586              $title = _x( 'Images', 'post format archive title' );
1587          } elseif ( is_tax( 'post_format', 'post-format-video' ) ) {
1588              $title = _x( 'Videos', 'post format archive title' );
1589          } elseif ( is_tax( 'post_format', 'post-format-quote' ) ) {
1590              $title = _x( 'Quotes', 'post format archive title' );
1591          } elseif ( is_tax( 'post_format', 'post-format-link' ) ) {
1592              $title = _x( 'Links', 'post format archive title' );
1593          } elseif ( is_tax( 'post_format', 'post-format-status' ) ) {
1594              $title = _x( 'Statuses', 'post format archive title' );
1595          } elseif ( is_tax( 'post_format', 'post-format-audio' ) ) {
1596              $title = _x( 'Audio', 'post format archive title' );
1597          } elseif ( is_tax( 'post_format', 'post-format-chat' ) ) {
1598              $title = _x( 'Chats', 'post format archive title' );
1599          }
1600      } elseif ( is_post_type_archive() ) {
1601          /* translators: Post type archive title. %s: Post type name. */
1602          $title = sprintf( __( 'Archives: %s' ), post_type_archive_title( '', false ) );
1603      } elseif ( is_tax() ) {
1604          $queried_object = get_queried_object();
1605          if ( $queried_object ) {
1606              $tax = get_taxonomy( $queried_object->taxonomy );
1607              /* translators: Taxonomy term archive title. 1: Taxonomy singular name, 2: Current taxonomy term. */
1608              $title = sprintf( __( '%1$s: %2$s' ), $tax->labels->singular_name, single_term_title( '', false ) );
1609          }
1610      }
1611  
1612      /**
1613       * Filters the archive title.
1614       *
1615       * @since 4.1.0
1616       *
1617       * @param string $title Archive title to be displayed.
1618       */
1619      return apply_filters( 'get_the_archive_title', $title );
1620  }
1621  
1622  /**
1623   * Display category, tag, term, or author description.
1624   *
1625   * @since 4.1.0
1626   *
1627   * @see get_the_archive_description()
1628   *
1629   * @param string $before Optional. Content to prepend to the description. Default empty.
1630   * @param string $after  Optional. Content to append to the description. Default empty.
1631   */
1632  function the_archive_description( $before = '', $after = '' ) {
1633      $description = get_the_archive_description();
1634      if ( $description ) {
1635          echo $before . $description . $after;
1636      }
1637  }
1638  
1639  /**
1640   * Retrieves the description for an author, post type, or term archive.
1641   *
1642   * @since 4.1.0
1643   * @since 4.7.0 Added support for author archives.
1644   * @since 4.9.0 Added support for post type archives.
1645   *
1646   * @see term_description()
1647   *
1648   * @return string Archive description.
1649   */
1650  function get_the_archive_description() {
1651      if ( is_author() ) {
1652          $description = get_the_author_meta( 'description' );
1653      } elseif ( is_post_type_archive() ) {
1654          $description = get_the_post_type_description();
1655      } else {
1656          $description = term_description();
1657      }
1658  
1659      /**
1660       * Filters the archive description.
1661       *
1662       * @since 4.1.0
1663       *
1664       * @param string $description Archive description to be displayed.
1665       */
1666      return apply_filters( 'get_the_archive_description', $description );
1667  }
1668  
1669  /**
1670   * Retrieves the description for a post type archive.
1671   *
1672   * @since 4.9.0
1673   *
1674   * @return string The post type description.
1675   */
1676  function get_the_post_type_description() {
1677      $post_type = get_query_var( 'post_type' );
1678  
1679      if ( is_array( $post_type ) ) {
1680          $post_type = reset( $post_type );
1681      }
1682  
1683      $post_type_obj = get_post_type_object( $post_type );
1684  
1685      // Check if a description is set.
1686      if ( isset( $post_type_obj->description ) ) {
1687          $description = $post_type_obj->description;
1688      } else {
1689          $description = '';
1690      }
1691  
1692      /**
1693       * Filters the description for a post type archive.
1694       *
1695       * @since 4.9.0
1696       *
1697       * @param string       $description   The post type description.
1698       * @param WP_Post_Type $post_type_obj The post type object.
1699       */
1700      return apply_filters( 'get_the_post_type_description', $description, $post_type_obj );
1701  }
1702  
1703  /**
1704   * Retrieve archive link content based on predefined or custom code.
1705   *
1706   * The format can be one of four styles. The 'link' for head element, 'option'
1707   * for use in the select element, 'html' for use in list (either ol or ul HTML
1708   * elements). Custom content is also supported using the before and after
1709   * parameters.
1710   *
1711   * The 'link' format uses the `<link>` HTML element with the **archives**
1712   * relationship. The before and after parameters are not used. The text
1713   * parameter is used to describe the link.
1714   *
1715   * The 'option' format uses the option HTML element for use in select element.
1716   * The value is the url parameter and the before and after parameters are used
1717   * between the text description.
1718   *
1719   * The 'html' format, which is the default, uses the li HTML element for use in
1720   * the list HTML elements. The before parameter is before the link and the after
1721   * parameter is after the closing link.
1722   *
1723   * The custom format uses the before parameter before the link ('a' HTML
1724   * element) and the after parameter after the closing link tag. If the above
1725   * three values for the format are not used, then custom format is assumed.
1726   *
1727   * @since 1.0.0
1728   * @since 5.2.0 Added the `$selected` parameter.
1729   *
1730   * @param string $url      URL to archive.
1731   * @param string $text     Archive text description.
1732   * @param string $format   Optional, default is 'html'. Can be 'link', 'option', 'html', or custom.
1733   * @param string $before   Optional. Content to prepend to the description. Default empty.
1734   * @param string $after    Optional. Content to append to the description. Default empty.
1735   * @param bool   $selected Optional. Set to true if the current page is the selected archive page.
1736   * @return string HTML link content for archive.
1737   */
1738  function get_archives_link( $url, $text, $format = 'html', $before = '', $after = '', $selected = false ) {
1739      $text         = wptexturize( $text );
1740      $url          = esc_url( $url );
1741      $aria_current = $selected ? ' aria-current="page"' : '';
1742  
1743      if ( 'link' === $format ) {
1744          $link_html = "\t<link rel='archives' title='" . esc_attr( $text ) . "' href='$url' />\n";
1745      } elseif ( 'option' === $format ) {
1746          $selected_attr = $selected ? " selected='selected'" : '';
1747          $link_html     = "\t<option value='$url'$selected_attr>$before $text $after</option>\n";
1748      } elseif ( 'html' === $format ) {
1749          $link_html = "\t<li>$before<a href='$url'$aria_current>$text</a>$after</li>\n";
1750      } else { // custom
1751          $link_html = "\t$before<a href='$url'$aria_current>$text</a>$after\n";
1752      }
1753  
1754      /**
1755       * Filters the archive link content.
1756       *
1757       * @since 2.6.0
1758       * @since 4.5.0 Added the `$url`, `$text`, `$format`, `$before`, and `$after` parameters.
1759       * @since 5.2.0 Added the `$selected` parameter.
1760       *
1761       * @param string $link_html The archive HTML link content.
1762       * @param string $url       URL to archive.
1763       * @param string $text      Archive text description.
1764       * @param string $format    Link format. Can be 'link', 'option', 'html', or custom.
1765       * @param string $before    Content to prepend to the description.
1766       * @param string $after     Content to append to the description.
1767       * @param bool   $selected  True if the current page is the selected archive.
1768       */
1769      return apply_filters( 'get_archives_link', $link_html, $url, $text, $format, $before, $after, $selected );
1770  }
1771  
1772  /**
1773   * Display archive links based on type and format.
1774   *
1775   * @since 1.2.0
1776   * @since 4.4.0 The `$post_type` argument was added.
1777   * @since 5.2.0 The `$year`, `$monthnum`, `$day`, and `$w` arguments were added.
1778   *
1779   * @see get_archives_link()
1780   *
1781   * @global wpdb      $wpdb      WordPress database abstraction object.
1782   * @global WP_Locale $wp_locale WordPress date and time locale object.
1783   *
1784   * @param string|array $args {
1785   *     Default archive links arguments. Optional.
1786   *
1787   *     @type string     $type            Type of archive to retrieve. Accepts 'daily', 'weekly', 'monthly',
1788   *                                       'yearly', 'postbypost', or 'alpha'. Both 'postbypost' and 'alpha'
1789   *                                       display the same archive link list as well as post titles instead
1790   *                                       of displaying dates. The difference between the two is that 'alpha'
1791   *                                       will order by post title and 'postbypost' will order by post date.
1792   *                                       Default 'monthly'.
1793   *     @type string|int $limit           Number of links to limit the query to. Default empty (no limit).
1794   *     @type string     $format          Format each link should take using the $before and $after args.
1795   *                                       Accepts 'link' (`<link>` tag), 'option' (`<option>` tag), 'html'
1796   *                                       (`<li>` tag), or a custom format, which generates a link anchor
1797   *                                       with $before preceding and $after succeeding. Default 'html'.
1798   *     @type string     $before          Markup to prepend to the beginning of each link. Default empty.
1799   *     @type string     $after           Markup to append to the end of each link. Default empty.
1800   *     @type bool       $show_post_count Whether to display the post count alongside the link. Default false.
1801   *     @type bool|int   $echo            Whether to echo or return the links list. Default 1|true to echo.
1802   *     @type string     $order           Whether to use ascending or descending order. Accepts 'ASC', or 'DESC'.
1803   *                                       Default 'DESC'.
1804   *     @type string     $post_type       Post type. Default 'post'.
1805   *     @type string     $year            Year. Default current year.
1806   *     @type string     $monthnum        Month number. Default current month number.
1807   *     @type string     $day             Day. Default current day.
1808   *     @type string     $w               Week. Default current week.
1809   * }
1810   * @return void|string Void if 'echo' argument is true, archive links if 'echo' is false.
1811   */
1812  function wp_get_archives( $args = '' ) {
1813      global $wpdb, $wp_locale;
1814  
1815      $defaults = array(
1816          'type'            => 'monthly',
1817          'limit'           => '',
1818          'format'          => 'html',
1819          'before'          => '',
1820          'after'           => '',
1821          'show_post_count' => false,
1822          'echo'            => 1,
1823          'order'           => 'DESC',
1824          'post_type'       => 'post',
1825          'year'            => get_query_var( 'year' ),
1826          'monthnum'        => get_query_var( 'monthnum' ),
1827          'day'             => get_query_var( 'day' ),
1828          'w'               => get_query_var( 'w' ),
1829      );
1830  
1831      $parsed_args = wp_parse_args( $args, $defaults );
1832  
1833      $post_type_object = get_post_type_object( $parsed_args['post_type'] );
1834      if ( ! is_post_type_viewable( $post_type_object ) ) {
1835          return;
1836      }
1837      $parsed_args['post_type'] = $post_type_object->name;
1838  
1839      if ( '' == $parsed_args['type'] ) {
1840          $parsed_args['type'] = 'monthly';
1841      }
1842  
1843      if ( ! empty( $parsed_args['limit'] ) ) {
1844          $parsed_args['limit'] = absint( $parsed_args['limit'] );
1845          $parsed_args['limit'] = ' LIMIT ' . $parsed_args['limit'];
1846      }
1847  
1848      $order = strtoupper( $parsed_args['order'] );
1849      if ( $order !== 'ASC' ) {
1850          $order = 'DESC';
1851      }
1852  
1853      // this is what will separate dates on weekly archive links
1854      $archive_week_separator = '&#8211;';
1855  
1856      $sql_where = $wpdb->prepare( "WHERE post_type = %s AND post_status = 'publish'", $parsed_args['post_type'] );
1857  
1858      /**
1859       * Filters the SQL WHERE clause for retrieving archives.
1860       *
1861       * @since 2.2.0
1862       *
1863       * @param string $sql_where   Portion of SQL query containing the WHERE clause.
1864       * @param array  $parsed_args An array of default arguments.
1865       */
1866      $where = apply_filters( 'getarchives_where', $sql_where, $parsed_args );
1867  
1868      /**
1869       * Filters the SQL JOIN clause for retrieving archives.
1870       *
1871       * @since 2.2.0
1872       *
1873       * @param string $sql_join    Portion of SQL query containing JOIN clause.
1874       * @param array  $parsed_args An array of default arguments.
1875       */
1876      $join = apply_filters( 'getarchives_join', '', $parsed_args );
1877  
1878      $output = '';
1879  
1880      $last_changed = wp_cache_get_last_changed( 'posts' );
1881  
1882      $limit = $parsed_args['limit'];
1883  
1884      if ( 'monthly' == $parsed_args['type'] ) {
1885          $query   = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date) ORDER BY post_date $order $limit";
1886          $key     = md5( $query );
1887          $key     = "wp_get_archives:$key:$last_changed";
1888          $results = wp_cache_get( $key, 'posts' );
1889          if ( ! $results ) {
1890              $results = $wpdb->get_results( $query );
1891              wp_cache_set( $key, $results, 'posts' );
1892          }
1893          if ( $results ) {
1894              $after = $parsed_args['after'];
1895              foreach ( (array) $results as $result ) {
1896                  $url = get_month_link( $result->year, $result->month );
1897                  if ( 'post' !== $parsed_args['post_type'] ) {
1898                      $url = add_query_arg( 'post_type', $parsed_args['post_type'], $url );
1899                  }
1900                  /* translators: 1: Month name, 2: 4-digit year. */
1901                  $text = sprintf( __( '%1$s %2$d' ), $wp_locale->get_month( $result->month ), $result->year );
1902                  if ( $parsed_args['show_post_count'] ) {
1903                      $parsed_args['after'] = '&nbsp;(' . $result->posts . ')' . $after;
1904                  }
1905                  $selected = is_archive() && (string) $parsed_args['year'] === $result->year && (string) $parsed_args['monthnum'] === $result->month;
1906                  $output  .= get_archives_link( $url, $text, $parsed_args['format'], $parsed_args['before'], $parsed_args['after'], $selected );
1907              }
1908          }
1909      } elseif ( 'yearly' == $parsed_args['type'] ) {
1910          $query   = "SELECT YEAR(post_date) AS `year`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date) ORDER BY post_date $order $limit";
1911          $key     = md5( $query );
1912          $key     = "wp_get_archives:$key:$last_changed";
1913          $results = wp_cache_get( $key, 'posts' );
1914          if ( ! $results ) {
1915              $results = $wpdb->get_results( $query );
1916              wp_cache_set( $key, $results, 'posts' );
1917          }
1918          if ( $results ) {
1919              $after = $parsed_args['after'];
1920              foreach ( (array) $results as $result ) {
1921                  $url = get_year_link( $result->year );
1922                  if ( 'post' !== $parsed_args['post_type'] ) {
1923                      $url = add_query_arg( 'post_type', $parsed_args['post_type'], $url );
1924                  }
1925                  $text = sprintf( '%d', $result->year );
1926                  if ( $parsed_args['show_post_count'] ) {
1927                      $parsed_args['after'] = '&nbsp;(' . $result->posts . ')' . $after;
1928                  }
1929                  $selected = is_archive() && (string) $parsed_args['year'] === $result->year;
1930                  $output  .= get_archives_link( $url, $text, $parsed_args['format'], $parsed_args['before'], $parsed_args['after'], $selected );
1931              }
1932          }
1933      } elseif ( 'daily' == $parsed_args['type'] ) {
1934          $query   = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, DAYOFMONTH(post_date) AS `dayofmonth`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date), DAYOFMONTH(post_date) ORDER BY post_date $order $limit";
1935          $key     = md5( $query );
1936          $key     = "wp_get_archives:$key:$last_changed";
1937          $results = wp_cache_get( $key, 'posts' );
1938          if ( ! $results ) {
1939              $results = $wpdb->get_results( $query );
1940              wp_cache_set( $key, $results, 'posts' );
1941          }
1942          if ( $results ) {
1943              $after = $parsed_args['after'];
1944              foreach ( (array) $results as $result ) {
1945                  $url = get_day_link( $result->year, $result->month, $result->dayofmonth );
1946                  if ( 'post' !== $parsed_args['post_type'] ) {
1947                      $url = add_query_arg( 'post_type', $parsed_args['post_type'], $url );
1948                  }
1949                  $date = sprintf( '%1$d-%2$02d-%3$02d 00:00:00', $result->year, $result->month, $result->dayofmonth );
1950                  $text = mysql2date( get_option( 'date_format' ), $date );
1951                  if ( $parsed_args['show_post_count'] ) {
1952                      $parsed_args['after'] = '&nbsp;(' . $result->posts . ')' . $after;
1953                  }
1954                  $selected = is_archive() && (string) $parsed_args['year'] === $result->year && (string) $parsed_args['monthnum'] === $result->month && (string) $parsed_args['day'] === $result->dayofmonth;
1955                  $output  .= get_archives_link( $url, $text, $parsed_args['format'], $parsed_args['before'], $parsed_args['after'], $selected );
1956              }
1957          }
1958      } elseif ( 'weekly' == $parsed_args['type'] ) {
1959          $week    = _wp_mysql_week( '`post_date`' );
1960          $query   = "SELECT DISTINCT $week AS `week`, YEAR( `post_date` ) AS `yr`, DATE_FORMAT( `post_date`, '%Y-%m-%d' ) AS `yyyymmdd`, count( `ID` ) AS `posts` FROM `$wpdb->posts` $join $where GROUP BY $week, YEAR( `post_date` ) ORDER BY `post_date` $order $limit";
1961          $key     = md5( $query );
1962          $key     = "wp_get_archives:$key:$last_changed";
1963          $results = wp_cache_get( $key, 'posts' );
1964          if ( ! $results ) {
1965              $results = $wpdb->get_results( $query );
1966              wp_cache_set( $key, $results, 'posts' );
1967          }
1968          $arc_w_last = '';
1969          if ( $results ) {
1970              $after = $parsed_args['after'];
1971              foreach ( (array) $results as $result ) {
1972                  if ( $result->week != $arc_w_last ) {
1973                      $arc_year       = $result->yr;
1974                      $arc_w_last     = $result->week;
1975                      $arc_week       = get_weekstartend( $result->yyyymmdd, get_option( 'start_of_week' ) );
1976                      $arc_week_start = date_i18n( get_option( 'date_format' ), $arc_week['start'] );
1977                      $arc_week_end   = date_i18n( get_option( 'date_format' ), $arc_week['end'] );
1978                      $url            = add_query_arg(
1979                          array(
1980                              'm' => $arc_year,
1981                              'w' => $result->week,
1982                          ),
1983                          home_url( '/' )
1984                      );
1985                      if ( 'post' !== $parsed_args['post_type'] ) {
1986                          $url = add_query_arg( 'post_type', $parsed_args['post_type'], $url );
1987                      }
1988                      $text = $arc_week_start . $archive_week_separator . $arc_week_end;
1989                      if ( $parsed_args['show_post_count'] ) {
1990                          $parsed_args['after'] = '&nbsp;(' . $result->posts . ')' . $after;
1991                      }
1992                      $selected = is_archive() && (string) $parsed_args['year'] === $result->yr && (string) $parsed_args['w'] === $result->week;
1993                      $output  .= get_archives_link( $url, $text, $parsed_args['format'], $parsed_args['before'], $parsed_args['after'], $selected );
1994                  }
1995              }
1996          }
1997      } elseif ( ( 'postbypost' == $parsed_args['type'] ) || ( 'alpha' == $parsed_args['type'] ) ) {
1998          $orderby = ( 'alpha' == $parsed_args['type'] ) ? 'post_title ASC ' : 'post_date DESC, ID DESC ';
1999          $query   = "SELECT * FROM $wpdb->posts $join $where ORDER BY $orderby $limit";
2000          $key     = md5( $query );
2001          $key     = "wp_get_archives:$key:$last_changed";
2002          $results = wp_cache_get( $key, 'posts' );
2003          if ( ! $results ) {
2004              $results = $wpdb->get_results( $query );
2005              wp_cache_set( $key, $results, 'posts' );
2006          }
2007          if ( $results ) {
2008              foreach ( (array) $results as $result ) {
2009                  if ( $result->post_date != '0000-00-00 00:00:00' ) {
2010                      $url = get_permalink( $result );
2011                      if ( $result->post_title ) {
2012                          /** This filter is documented in wp-includes/post-template.php */
2013                          $text = strip_tags( apply_filters( 'the_title', $result->post_title, $result->ID ) );
2014                      } else {
2015                          $text = $result->ID;
2016                      }
2017                      $selected = $result->ID === get_the_ID();
2018                      $output  .= get_archives_link( $url, $text, $parsed_args['format'], $parsed_args['before'], $parsed_args['after'], $selected );
2019                  }
2020              }
2021          }
2022      }
2023  
2024      if ( $parsed_args['echo'] ) {
2025          echo $output;
2026      } else {
2027          return $output;
2028      }
2029  }
2030  
2031  /**
2032   * Get number of days since the start of the week.
2033   *
2034   * @since 1.5.0
2035   *
2036   * @param int $num Number of day.
2037   * @return float Days since the start of the week.
2038   */
2039  function calendar_week_mod( $num ) {
2040      $base = 7;
2041      return ( $num - $base * floor( $num / $base ) );
2042  }
2043  
2044  /**
2045   * Display calendar with days that have posts as links.
2046   *
2047   * The calendar is cached, which will be retrieved, if it exists. If there are
2048   * no posts for the month, then it will not be displayed.
2049   *
2050   * @since 1.0.0
2051   *
2052   * @global wpdb      $wpdb      WordPress database abstraction object.
2053   * @global int       $m
2054   * @global int       $monthnum
2055   * @global int       $year
2056   * @global WP_Locale $wp_locale WordPress date and time locale object.
2057   * @global array     $posts
2058   *
2059   * @param bool $initial Optional, default is true. Use initial calendar names.
2060   * @param bool $echo    Optional, default is true. Set to false for return.
2061   * @return void|string Void if `$echo` argument is true, calendar HTML if `$echo` is false.
2062   */
2063  function get_calendar( $initial = true, $echo = true ) {
2064      global $wpdb, $m, $monthnum, $year, $wp_locale, $posts;
2065  
2066      $key   = md5( $m . $monthnum . $year );
2067      $cache = wp_cache_get( 'get_calendar', 'calendar' );
2068  
2069      if ( $cache && is_array( $cache ) && isset( $cache[ $key ] ) ) {
2070          /** This filter is documented in wp-includes/general-template.php */
2071          $output = apply_filters( 'get_calendar', $cache[ $key ] );
2072  
2073          if ( $echo ) {
2074              echo $output;
2075              return;
2076          }
2077  
2078          return $output;
2079      }
2080  
2081      if ( ! is_array( $cache ) ) {
2082          $cache = array();
2083      }
2084  
2085      // Quick check. If we have no posts at all, abort!
2086      if ( ! $posts ) {
2087          $gotsome = $wpdb->get_var( "SELECT 1 as test FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish' LIMIT 1" );
2088          if ( ! $gotsome ) {
2089              $cache[ $key ] = '';
2090              wp_cache_set( 'get_calendar', $cache, 'calendar' );
2091              return;
2092          }
2093      }
2094  
2095      if ( isset( $_GET['w'] ) ) {
2096          $w = (int) $_GET['w'];
2097      }
2098      // week_begins = 0 stands for Sunday
2099      $week_begins = (int) get_option( 'start_of_week' );
2100  
2101      // Let's figure out when we are
2102      if ( ! empty( $monthnum ) && ! empty( $year ) ) {
2103          $thismonth = zeroise( intval( $monthnum ), 2 );
2104          $thisyear  = (int) $year;
2105      } elseif ( ! empty( $w ) ) {
2106          // We need to get the month from MySQL
2107          $thisyear = (int) substr( $m, 0, 4 );
2108          //it seems MySQL's weeks disagree with PHP's
2109          $d         = ( ( $w - 1 ) * 7 ) + 6;
2110          $thismonth = $wpdb->get_var( "SELECT DATE_FORMAT((DATE_ADD('{$thisyear}0101', INTERVAL $d DAY) ), '%m')" );
2111      } elseif ( ! empty( $m ) ) {
2112          $thisyear = (int) substr( $m, 0, 4 );
2113          if ( strlen( $m ) < 6 ) {
2114              $thismonth = '01';
2115          } else {
2116              $thismonth = zeroise( (int) substr( $m, 4, 2 ), 2 );
2117          }
2118      } else {
2119          $thisyear  = current_time( 'Y' );
2120          $thismonth = current_time( 'm' );
2121      }
2122  
2123      $unixmonth = mktime( 0, 0, 0, $thismonth, 1, $thisyear );
2124      $last_day  = gmdate( 't', $unixmonth );
2125  
2126      // Get the next and previous month and year with at least one post
2127      $previous = $wpdb->get_row(
2128          "SELECT MONTH(post_date) AS month, YEAR(post_date) AS year
2129          FROM $wpdb->posts
2130          WHERE post_date < '$thisyear-$thismonth-01'
2131          AND post_type = 'post' AND post_status = 'publish'
2132              ORDER BY post_date DESC
2133              LIMIT 1"
2134      );
2135      $next     = $wpdb->get_row(
2136          "SELECT MONTH(post_date) AS month, YEAR(post_date) AS year
2137          FROM $wpdb->posts
2138          WHERE post_date > '$thisyear-$thismonth-{$last_day} 23:59:59'
2139          AND post_type = 'post' AND post_status = 'publish'
2140              ORDER BY post_date ASC
2141              LIMIT 1"
2142      );
2143  
2144      /* translators: Calendar caption: 1: Month name, 2: 4-digit year. */
2145      $calendar_caption = _x( '%1$s %2$s', 'calendar caption' );
2146      $calendar_output  = '<table id="wp-calendar">
2147      <caption>' . sprintf(
2148          $calendar_caption,
2149          $wp_locale->get_month( $thismonth ),
2150          gmdate( 'Y', $unixmonth )
2151      ) . '</caption>
2152      <thead>
2153      <tr>';
2154  
2155      $myweek = array();
2156  
2157      for ( $wdcount = 0; $wdcount <= 6; $wdcount++ ) {
2158          $myweek[] = $wp_locale->get_weekday( ( $wdcount + $week_begins ) % 7 );
2159      }
2160  
2161      foreach ( $myweek as $wd ) {
2162          $day_name         = $initial ? $wp_locale->get_weekday_initial( $wd ) : $wp_locale->get_weekday_abbrev( $wd );
2163          $wd               = esc_attr( $wd );
2164          $calendar_output .= "\n\t\t<th scope=\"col\" title=\"$wd\">$day_name</th>";
2165      }
2166  
2167      $calendar_output .= '
2168      </tr>
2169      </thead>
2170  
2171      <tfoot>
2172      <tr>';
2173  
2174      if ( $previous ) {
2175          $calendar_output .= "\n\t\t" . '<td colspan="3" id="prev"><a href="' . get_month_link( $previous->year, $previous->month ) . '">&laquo; ' .
2176              $wp_locale->get_month_abbrev( $wp_locale->get_month( $previous->month ) ) .
2177          '</a></td>';
2178      } else {
2179          $calendar_output .= "\n\t\t" . '<td colspan="3" id="prev" class="pad">&nbsp;</td>';
2180      }
2181  
2182      $calendar_output .= "\n\t\t" . '<td class="pad">&nbsp;</td>';
2183  
2184      if ( $next ) {
2185          $calendar_output .= "\n\t\t" . '<td colspan="3" id="next"><a href="' . get_month_link( $next->year, $next->month ) . '">' .
2186              $wp_locale->get_month_abbrev( $wp_locale->get_month( $next->month ) ) .
2187          ' &raquo;</a></td>';
2188      } else {
2189          $calendar_output .= "\n\t\t" . '<td colspan="3" id="next" class="pad">&nbsp;</td>';
2190      }
2191  
2192      $calendar_output .= '
2193      </tr>
2194      </tfoot>
2195  
2196      <tbody>
2197      <tr>';
2198  
2199      $daywithpost = array();
2200  
2201      // Get days with posts
2202      $dayswithposts = $wpdb->get_results(
2203          "SELECT DISTINCT DAYOFMONTH(post_date)
2204          FROM $wpdb->posts WHERE post_date >= '{$thisyear}-{$thismonth}-01 00:00:00'
2205          AND post_type = 'post' AND post_status = 'publish'
2206          AND post_date <= '{$thisyear}-{$thismonth}-{$last_day} 23:59:59'",
2207          ARRAY_N
2208      );
2209      if ( $dayswithposts ) {
2210          foreach ( (array) $dayswithposts as $daywith ) {
2211              $daywithpost[] = $daywith[0];
2212          }
2213      }
2214  
2215      // See how much we should pad in the beginning
2216      $pad = calendar_week_mod( gmdate( 'w', $unixmonth ) - $week_begins );
2217      if ( 0 != $pad ) {
2218          $calendar_output .= "\n\t\t" . '<td colspan="' . esc_attr( $pad ) . '" class="pad">&nbsp;</td>';
2219      }
2220  
2221      $newrow      = false;
2222      $daysinmonth = (int) gmdate( 't', $unixmonth );
2223  
2224      for ( $day = 1; $day <= $daysinmonth; ++$day ) {
2225          if ( isset( $newrow ) && $newrow ) {
2226              $calendar_output .= "\n\t</tr>\n\t<tr>\n\t\t";
2227          }
2228          $newrow = false;
2229  
2230          if ( $day == current_time( 'j' ) &&
2231              $thismonth == current_time( 'm' ) &&
2232              $thisyear == current_time( 'Y' ) ) {
2233              $calendar_output .= '<td id="today">';
2234          } else {
2235              $calendar_output .= '<td>';
2236          }
2237  
2238          if ( in_array( $day, $daywithpost ) ) {
2239              // any posts today?
2240              $date_format = gmdate( _x( 'F j, Y', 'daily archives date format' ), strtotime( "{$thisyear}-{$thismonth}-{$day}" ) );
2241              /* translators: Post calendar label. %s: Date. */
2242              $label            = sprintf( __( 'Posts published on %s' ), $date_format );
2243              $calendar_output .= sprintf(
2244                  '<a href="%s" aria-label="%s">%s</a>',
2245                  get_day_link( $thisyear, $thismonth, $day ),
2246                  esc_attr( $label ),
2247                  $day
2248              );
2249          } else {
2250              $calendar_output .= $day;
2251          }
2252          $calendar_output .= '</td>';
2253  
2254          if ( 6 == calendar_week_mod( gmdate( 'w', mktime( 0, 0, 0, $thismonth, $day, $thisyear ) ) - $week_begins ) ) {
2255              $newrow = true;
2256          }
2257      }
2258  
2259      $pad = 7 - calendar_week_mod( gmdate( 'w', mktime( 0, 0, 0, $thismonth, $day, $thisyear ) ) - $week_begins );
2260      if ( $pad != 0 && $pad != 7 ) {
2261          $calendar_output .= "\n\t\t" . '<td class="pad" colspan="' . esc_attr( $pad ) . '">&nbsp;</td>';
2262      }
2263      $calendar_output .= "\n\t</tr>\n\t</tbody>\n\t</table>";
2264  
2265      $cache[ $key ] = $calendar_output;
2266      wp_cache_set( 'get_calendar', $cache, 'calendar' );
2267  
2268      if ( $echo ) {
2269          /**
2270           * Filters the HTML calendar output.
2271           *
2272           * @since 3.0.0
2273           *
2274           * @param string $calendar_output HTML output of the calendar.
2275           */
2276          echo apply_filters( 'get_calendar', $calendar_output );
2277          return;
2278      }
2279      /** This filter is documented in wp-includes/general-template.php */
2280      return apply_filters( 'get_calendar', $calendar_output );
2281  }
2282  
2283  /**
2284   * Purge the cached results of get_calendar.
2285   *
2286   * @see get_calendar
2287   * @since 2.1.0
2288   */
2289  function delete_get_calendar_cache() {
2290      wp_cache_delete( 'get_calendar', 'calendar' );
2291  }
2292  
2293  /**
2294   * Display all of the allowed tags in HTML format with attributes.
2295   *
2296   * This is useful for displaying in the comment area, which elements and
2297   * attributes are supported. As well as any plugins which want to display it.
2298   *
2299   * @since 1.0.1
2300   *
2301   * @global array $allowedtags
2302   *
2303   * @return string HTML allowed tags entity encoded.
2304   */
2305  function allowed_tags() {
2306      global $allowedtags;
2307      $allowed = '';
2308      foreach ( (array) $allowedtags as $tag => $attributes ) {
2309          $allowed .= '<' . $tag;
2310          if ( 0 < count( $attributes ) ) {
2311              foreach ( $attributes as $attribute => $limits ) {
2312                  $allowed .= ' ' . $attribute . '=""';
2313              }
2314          }
2315          $allowed .= '> ';
2316      }
2317      return htmlentities( $allowed );
2318  }
2319  
2320  /***** Date/Time tags */
2321  
2322  /**
2323   * Outputs the date in iso8601 format for xml files.
2324   *
2325   * @since 1.0.0
2326   */
2327  function the_date_xml() {
2328      echo mysql2date( 'Y-m-d', get_post()->post_date, false );
2329  }
2330  
2331  /**
2332   * Display or Retrieve the date the current post was written (once per date)
2333   *
2334   * Will only output the date if the current post's date is different from the
2335   * previous one output.
2336   *
2337   * i.e. Only one date listing will show per day worth of posts shown in the loop, even if the
2338   * function is called several times for each post.
2339   *
2340   * HTML output can be filtered with 'the_date'.
2341   * Date string output can be filtered with 'get_the_date'.
2342   *
2343   * @since 0.71
2344   *
2345   * @global string $currentday  The day of the current post in the loop.
2346   * @global string $previousday The day of the previous post in the loop.
2347   *
2348   * @param string $d      Optional. PHP date format defaults to the date_format option if not specified.
2349   * @param string $before Optional. Output before the date.
2350   * @param string $after  Optional. Output after the date.
2351   * @param bool   $echo   Optional, default is display. Whether to echo the date or return it.
2352   * @return string|void String if retrieving.
2353   */
2354  function the_date( $d = '', $before = '', $after = '', $echo = true ) {
2355      global $currentday, $previousday;
2356  
2357      $the_date = '';
2358  
2359      if ( is_new_day() ) {
2360          $the_date    = $before . get_the_date( $d ) . $after;
2361          $previousday = $currentday;
2362      }
2363  
2364      /**
2365       * Filters the date a post was published for display.
2366       *
2367       * @since 0.71
2368       *
2369       * @param string $the_date The formatted date string.
2370       * @param string $d        PHP date format. Defaults to 'date_format' option
2371       *                         if not specified.
2372       * @param string $before   HTML output before the date.
2373       * @param string $after    HTML output after the date.
2374       */
2375      $the_date = apply_filters( 'the_date', $the_date, $d, $before, $after );
2376  
2377      if ( $echo ) {
2378          echo $the_date;
2379      } else {
2380          return $the_date;
2381      }
2382  }
2383  
2384  /**
2385   * Retrieve the date on which the post was written.
2386   *
2387   * Unlike the_date() this function will always return the date.
2388   * Modify output with the {@see 'get_the_date'} filter.
2389   *
2390   * @since 3.0.0
2391   *
2392   * @param  string      $d    Optional. PHP date format defaults to the date_format option if not specified.
2393   * @param  int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
2394   * @return string|false Date the current post was written. False on failure.
2395   */
2396  function get_the_date( $d = '', $post = null ) {
2397      $post = get_post( $post );
2398  
2399      if ( ! $post ) {
2400          return false;
2401      }
2402  
2403      if ( '' == $d ) {
2404          $the_date = get_post_time( get_option( 'date_format' ), false, $post, true );
2405      } else {
2406          $the_date = get_post_time( $d, false, $post, true );
2407      }
2408  
2409      /**
2410       * Filters the date a post was published.
2411       *
2412       * @since 3.0.0
2413       *
2414       * @param string      $the_date The formatted date.
2415       * @param string      $d        PHP date format. Defaults to 'date_format' option
2416       *                              if not specified.
2417       * @param int|WP_Post $post     The post object or ID.
2418       */
2419      return apply_filters( 'get_the_date', $the_date, $d, $post );
2420  }
2421  
2422  /**
2423   * Display the date on which the post was last modified.
2424   *
2425   * @since 2.1.0
2426   *
2427   * @param string $d      Optional. PHP date format defaults to the date_format option if not specified.
2428   * @param string $before Optional. Output before the date.
2429   * @param string $after  Optional. Output after the date.
2430   * @param bool   $echo   Optional, default is display. Whether to echo the date or return it.
2431   * @return string|void String if retrieving.
2432   */
2433  function the_modified_date( $d = '', $before = '', $after = '', $echo = true ) {
2434      $the_modified_date = $before . get_the_modified_date( $d ) . $after;
2435  
2436      /**
2437       * Filters the date a post was last modified for display.
2438       *
2439       * @since 2.1.0
2440       *
2441       * @param string $the_modified_date The last modified date.
2442       * @param string $d                 PHP date format. Defaults to 'date_format' option
2443       *                                  if not specified.
2444       * @param string $before            HTML output before the date.
2445       * @param string $after             HTML output after the date.
2446       */
2447      $the_modified_date = apply_filters( 'the_modified_date', $the_modified_date, $d, $before, $after );
2448  
2449      if ( $echo ) {
2450          echo $the_modified_date;
2451      } else {
2452          return $the_modified_date;
2453      }
2454  
2455  }
2456  
2457  /**
2458   * Retrieve the date on which the post was last modified.
2459   *
2460   * @since 2.1.0
2461   * @since 4.6.0 Added the `$post` parameter.
2462   *
2463   * @param string      $d    Optional. PHP date format defaults to the date_format option if not specified.
2464   * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
2465   * @return string|false Date the current post was modified. False on failure.
2466   */
2467  function get_the_modified_date( $d = '', $post = null ) {
2468      $post = get_post( $post );
2469  
2470      if ( ! $post ) {
2471          // For backward compatibility, failures go through the filter below.
2472          $the_time = false;
2473      } elseif ( empty( $d ) ) {
2474          $the_time = get_post_modified_time( get_option( 'date_format' ), false, $post, true );
2475      } else {
2476          $the_time = get_post_modified_time( $d, false, $post, true );
2477      }
2478  
2479      /**
2480       * Filters the date a post was last modified.
2481       *
2482       * @since 2.1.0
2483       * @since 4.6.0 Added the `$post` parameter.
2484       *
2485       * @param string|bool  $the_time The formatted date or false if no post is found.
2486       * @param string       $d        PHP date format. Defaults to value specified in
2487       *                               'date_format' option.
2488       * @param WP_Post|null $post     WP_Post object or null if no post is found.
2489       */
2490      return apply_filters( 'get_the_modified_date', $the_time, $d, $post );
2491  }
2492  
2493  /**
2494   * Display the time at which the post was written.
2495   *
2496   * @since 0.71
2497   *
2498   * @param string $d Either 'G', 'U', or php date format.
2499   */
2500  function the_time( $d = '' ) {
2501      /**
2502       * Filters the time a post was written for display.
2503       *
2504       * @since 0.71
2505       *
2506       * @param string $get_the_time The formatted time.
2507       * @param string $d            The time format. Accepts 'G', 'U',
2508       *                             or php date format.
2509       */
2510      echo apply_filters( 'the_time', get_the_time( $d ), $d );
2511  }
2512  
2513  /**
2514   * Retrieve the time at which the post was written.
2515   *
2516   * @since 1.5.0
2517   *
2518   * @param string      $d    Optional. Format to use for retrieving the time the post
2519   *                          was written. Either 'G', 'U', or php date format defaults
2520   *                          to the value specified in the time_format option. Default empty.
2521   * @param int|WP_Post $post WP_Post object or ID. Default is global `$post` object.
2522   * @return string|int|false Formatted date string or Unix timestamp if `$d` is 'U' or 'G'. False on failure.
2523   */
2524  function get_the_time( $d = '', $post = null ) {
2525      $post = get_post( $post );
2526  
2527      if ( ! $post ) {
2528          return false;
2529      }
2530  
2531      if ( '' == $d ) {
2532          $the_time = get_post_time( get_option( 'time_format' ), false, $post, true );
2533      } else {
2534          $the_time = get_post_time( $d, false, $post, true );
2535      }
2536  
2537      /**
2538       * Filters the time a post was written.
2539       *
2540       * @since 1.5.0
2541       *
2542       * @param string      $the_time The formatted time.
2543       * @param string      $d        Format to use for retrieving the time the post was written.
2544       *                              Accepts 'G', 'U', or php date format value specified
2545       *                              in 'time_format' option. Default empty.
2546       * @param int|WP_Post $post     WP_Post object or ID.
2547       */
2548      return apply_filters( 'get_the_time', $the_time, $d, $post );
2549  }
2550  
2551  /**
2552   * Retrieve the time at which the post was written.
2553   *
2554   * @since 2.0.0
2555   *
2556   * @param string      $d         Optional. Format to use for retrieving the time the post
2557   *                               was written. Either 'G', 'U', or php date format. Default 'U'.
2558   * @param bool        $gmt       Optional. Whether to retrieve the GMT time. Default false.
2559   * @param int|WP_Post $post      WP_Post object or ID. Default is global `$post` object.
2560   * @param bool        $translate Whether to translate the time string. Default false.
2561   * @return string|int|false Formatted date string or Unix timestamp if `$d` is 'U' or 'G'. False on failure.
2562   */
2563  function get_post_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
2564      $post = get_post( $post );
2565  
2566      if ( ! $post ) {
2567          return false;
2568      }
2569  
2570      $source   = ( $gmt ) ? 'gmt' : 'local';
2571      $datetime = get_post_datetime( $post, 'date', $source );
2572  
2573      if ( false === $datetime ) {
2574          return false;
2575      }
2576  
2577      if ( 'U' === $d || 'G' === $d ) {
2578          $time = $datetime->getTimestamp();
2579  
2580          // Returns a sum of timestamp with timezone offset. Ideally should never be used.
2581          if ( ! $gmt ) {
2582              $time += $datetime->getOffset();
2583          }
2584      } elseif ( $translate ) {
2585          $time = wp_date( $d, $datetime->getTimestamp(), $gmt ? new DateTimeZone( 'UTC' ) : null );
2586      } else {
2587          if ( $gmt ) {
2588              $datetime = $datetime->setTimezone( new DateTimeZone( 'UTC' ) );
2589          }
2590  
2591          $time = $datetime->format( $d );
2592      }
2593  
2594      /**
2595       * Filters the localized time a post was written.
2596       *
2597       * @since 2.6.0
2598       *
2599       * @param string $time The formatted time.
2600       * @param string $d    Format to use for retrieving the time the post was written.
2601       *                     Accepts 'G', 'U', or php date format. Default 'U'.
2602       * @param bool   $gmt  Whether to retrieve the GMT time. Default false.
2603       */
2604      return apply_filters( 'get_post_time', $time, $d, $gmt );
2605  }
2606  
2607  /**
2608   * Retrieve post published or modified time as a `DateTimeImmutable` object instance.
2609   *
2610   * The object will be set to the timezone from WordPress settings.
2611   *
2612   * For legacy reasons, this function allows to choose to instantiate from local or UTC time in database.
2613   * Normally this should make no difference to the result. However, the values might get out of sync in database,
2614   * typically because of timezone setting changes. The parameter ensures the ability to reproduce backwards
2615   * compatible behaviors in such cases.
2616   *
2617   * @since 5.3.0
2618   *
2619   * @param int|WP_Post $post   Optional. WP_Post object or ID. Default is global `$post` object.
2620   * @param string      $field  Optional. Published or modified time to use from database. Accepts 'date' or 'modified'.
2621   *                            Default 'date'.
2622   * @param string      $source Optional. Local or UTC time to use from database. Accepts 'local' or 'gmt'.
2623   *                            Default 'local'.
2624   * @return DateTimeImmutable|false Time object on success, false on failure.
2625   */
2626  function get_post_datetime( $post = null, $field = 'date', $source = 'local' ) {
2627      $post = get_post( $post );
2628  
2629      if ( ! $post ) {
2630          return false;
2631      }
2632  
2633      $wp_timezone = wp_timezone();
2634  
2635      if ( 'gmt' === $source ) {
2636          $time     = ( 'modified' === $field ) ? $post->post_modified_gmt : $post->post_date_gmt;
2637          $timezone = new DateTimeZone( 'UTC' );
2638      } else {
2639          $time     = ( 'modified' === $field ) ? $post->post_modified : $post->post_date;
2640          $timezone = $wp_timezone;
2641      }
2642  
2643      if ( empty( $time ) || '0000-00-00 00:00:00' === $time ) {
2644          return false;
2645      }
2646  
2647      $datetime = date_create_immutable_from_format( 'Y-m-d H:i:s', $time, $timezone );
2648  
2649      if ( false === $datetime ) {
2650          return false;
2651      }
2652  
2653      return $datetime->setTimezone( $wp_timezone );
2654  }
2655  
2656  /**
2657   * Retrieve post published or modified time as a Unix timestamp.
2658   *
2659   * Note that this function returns a true Unix timestamp, not summed with timezone offset
2660   * like older WP functions.
2661   *
2662   * @since 5.3.0
2663   *
2664   * @param int|WP_Post $post  Optional. WP_Post object or ID. Default is global `$post` object.
2665   * @param string      $field Optional. Published or modified time to use from database. Accepts 'date' or 'modified'.
2666   *                           Default 'date'.
2667   * @return int|false Unix timestamp on success, false on failure.
2668   */
2669  function get_post_timestamp( $post = null, $field = 'date' ) {
2670      $datetime = get_post_datetime( $post, $field );
2671  
2672      if ( false === $datetime ) {
2673          return false;
2674      }
2675  
2676      return $datetime->getTimestamp();
2677  }
2678  
2679  /**
2680   * Display the time at which the post was last modified.
2681   *
2682   * @since 2.0.0
2683   *
2684   * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
2685   */
2686  function the_modified_time( $d = '' ) {
2687      /**
2688       * Filters the localized time a post was last modified, for display.
2689       *
2690       * @since 2.0.0
2691       *
2692       * @param string $get_the_modified_time The formatted time.
2693       * @param string $d                     The time format. Accepts 'G', 'U',
2694       *                                      or php date format. Defaults to value
2695       *                                      specified in 'time_format' option.
2696       */
2697      echo apply_filters( 'the_modified_time', get_the_modified_time( $d ), $d );
2698  }
2699  
2700  /**
2701   * Retrieve the time at which the post was last modified.
2702   *
2703   * @since 2.0.0
2704   * @since 4.6.0 Added the `$post` parameter.
2705   *
2706   * @param string      $d     Optional. Format to use for retrieving the time the post
2707   *                           was modified. Either 'G', 'U', or php date format defaults
2708   *                           to the value specified in the time_format option. Default empty.
2709   * @param int|WP_Post $post  Optional. Post ID or WP_Post object. Default current post.
2710   * @return string|false Formatted date string or Unix timestamp. False on failure.
2711   */
2712  function get_the_modified_time( $d = '', $post = null ) {
2713      $post = get_post( $post );
2714  
2715      if ( ! $post ) {
2716          // For backward compatibility, failures go through the filter below.
2717          $the_time = false;
2718      } elseif ( empty( $d ) ) {
2719          $the_time = get_post_modified_time( get_option( 'time_format' ), false, $post, true );
2720      } else {
2721          $the_time = get_post_modified_time( $d, false, $post, true );
2722      }
2723  
2724      /**
2725       * Filters the localized time a post was last modified.
2726       *
2727       * @since 2.0.0
2728       * @since 4.6.0 Added the `$post` parameter.
2729       *
2730       * @param string|bool  $the_time The formatted time or false if no post is found.
2731       * @param string       $d        Format to use for retrieving the time the post was
2732       *                               written. Accepts 'G', 'U', or php date format. Defaults
2733       *                               to value specified in 'time_format' option.
2734       * @param WP_Post|null $post     WP_Post object or null if no post is found.
2735       */
2736      return apply_filters( 'get_the_modified_time', $the_time, $d, $post );
2737  }
2738  
2739  /**
2740   * Retrieve the time at which the post was last modified.
2741   *
2742   * @since 2.0.0
2743   *
2744   * @param string      $d         Optional. Format to use for retrieving the time the post
2745   *                               was modified. Either 'G', 'U', or php date format. Default 'U'.
2746   * @param bool        $gmt       Optional. Whether to retrieve the GMT time. Default false.
2747   * @param int|WP_Post $post      WP_Post object or ID. Default is global `$post` object.
2748   * @param bool        $translate Whether to translate the time string. Default false.
2749   * @return string|int|false Formatted date string or Unix timestamp if `$d` is 'U' or 'G'. False on failure.
2750   */
2751  function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
2752      $post = get_post( $post );
2753  
2754      if ( ! $post ) {
2755          return false;
2756      }
2757  
2758      $source   = ( $gmt ) ? 'gmt' : 'local';
2759      $datetime = get_post_datetime( $post, 'modified', $source );
2760  
2761      if ( false === $datetime ) {
2762          return false;
2763      }
2764  
2765      if ( 'U' === $d || 'G' === $d ) {
2766          $time = $datetime->getTimestamp();
2767  
2768          // Returns a sum of timestamp with timezone offset. Ideally should never be used.
2769          if ( ! $gmt ) {
2770              $time += $datetime->getOffset();
2771          }
2772      } elseif ( $translate ) {
2773          $time = wp_date( $d, $datetime->getTimestamp(), $gmt ? new DateTimeZone( 'UTC' ) : null );
2774      } else {
2775          if ( $gmt ) {
2776              $datetime = $datetime->setTimezone( new DateTimeZone( 'UTC' ) );
2777          }
2778  
2779          $time = $datetime->format( $d );
2780      }
2781  
2782      /**
2783       * Filters the localized time a post was last modified.
2784       *
2785       * @since 2.8.0
2786       *
2787       * @param string $time The formatted time.
2788       * @param string $d    Format to use for retrieving the time the post was modified.
2789       *                     Accepts 'G', 'U', or php date format. Default 'U'.
2790       * @param bool   $gmt  Whether to retrieve the GMT time. Default false.
2791       */
2792      return apply_filters( 'get_post_modified_time', $time, $d, $gmt );
2793  }
2794  
2795  /**
2796   * Display the weekday on which the post was written.
2797   *
2798   * @since 0.71
2799   *
2800   * @global WP_Locale $wp_locale WordPress date and time locale object.
2801   */
2802  function the_weekday() {
2803      global $wp_locale;
2804  
2805      $post = get_post();
2806  
2807      if ( ! $post ) {
2808          return;
2809      }
2810  
2811      $the_weekday = $wp_locale->get_weekday( get_post_time( 'w', false, $post ) );
2812  
2813      /**
2814       * Filters the weekday on which the post was written, for display.
2815       *
2816       * @since 0.71
2817       *
2818       * @param string $the_weekday
2819       */
2820      echo apply_filters( 'the_weekday', $the_weekday );
2821  }
2822  
2823  /**
2824   * Display the weekday on which the post was written.
2825   *
2826   * Will only output the weekday if the current post's weekday is different from
2827   * the previous one output.
2828   *
2829   * @since 0.71
2830   *
2831   * @global WP_Locale $wp_locale       WordPress date and time locale object.
2832   * @global string    $currentday      The day of the current post in the loop.
2833   * @global string    $previousweekday The day of the previous post in the loop.
2834   *
2835   * @param string $before Optional. Output before the date.
2836   * @param string $after  Optional. Output after the date.
2837   */
2838  function the_weekday_date( $before = '', $after = '' ) {
2839      global $wp_locale, $currentday, $previousweekday;
2840  
2841      $post = get_post();
2842  
2843      if ( ! $post ) {
2844          return;
2845      }
2846  
2847      $the_weekday_date = '';
2848  
2849      if ( $currentday !== $previousweekday ) {
2850          $the_weekday_date .= $before;
2851          $the_weekday_date .= $wp_locale->get_weekday( get_post_time( 'w', false, $post ) );
2852          $the_weekday_date .= $after;
2853          $previousweekday   = $currentday;
2854      }
2855  
2856      /**
2857       * Filters the localized date on which the post was written, for display.
2858       *
2859       * @since 0.71
2860       *
2861       * @param string $the_weekday_date The weekday on which the post was written.
2862       * @param string $before           The HTML to output before the date.
2863       * @param string $after            The HTML to output after the date.
2864       */
2865      echo apply_filters( 'the_weekday_date', $the_weekday_date, $before, $after );
2866  }
2867  
2868  /**
2869   * Fire the wp_head action.
2870   *
2871   * See {@see 'wp_head'}.
2872   *
2873   * @since 1.2.0
2874   */
2875  function wp_head() {
2876      /**
2877       * Prints scripts or data in the head tag on the front end.
2878       *
2879       * @since 1.5.0
2880       */
2881      do_action( 'wp_head' );
2882  }
2883  
2884  /**
2885   * Fire the wp_footer action.
2886   *
2887   * See {@see 'wp_footer'}.
2888   *
2889   * @since 1.5.1
2890   */
2891  function wp_footer() {
2892      /**
2893       * Prints scripts or data before the closing body tag on the front end.
2894       *
2895       * @since 1.5.1
2896       */
2897      do_action( 'wp_footer' );
2898  }
2899  
2900  /**
2901   * Fire the wp_body_open action.
2902   *
2903   * See {@see 'wp_body_open'}.
2904   *
2905   * @since 5.2.0
2906   */
2907  function wp_body_open() {
2908      /**
2909       * Triggered after the opening body tag.
2910       *
2911       * @since 5.2.0
2912       */
2913      do_action( 'wp_body_open' );
2914  }
2915  
2916  /**
2917   * Display the links to the general feeds.
2918   *
2919   * @since 2.8.0
2920   *
2921   * @param array $args Optional arguments.
2922   */
2923  function feed_links( $args = array() ) {
2924      if ( ! current_theme_supports( 'automatic-feed-links' ) ) {
2925          return;
2926      }
2927  
2928      $defaults = array(
2929          /* translators: Separator between blog name and feed type in feed links. */
2930          'separator' => _x( '&raquo;', 'feed link' ),
2931          /* translators: 1: Blog title, 2: Separator (raquo). */
2932          'feedtitle' => __( '%1$s %2$s Feed' ),
2933          /* translators: 1: Blog title, 2: Separator (raquo). */
2934          'comstitle' => __( '%1$s %2$s Comments Feed' ),
2935      );
2936  
2937      $args = wp_parse_args( $args, $defaults );
2938  
2939      /**
2940       * Filters whether to display the posts feed link.
2941       *
2942       * @since 4.4.0
2943       *
2944       * @param bool $show Whether to display the posts feed link. Default true.
2945       */
2946      if ( apply_filters( 'feed_links_show_posts_feed', true ) ) {
2947          echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . esc_attr( sprintf( $args['feedtitle'], get_bloginfo( 'name' ), $args['separator'] ) ) . '" href="' . esc_url( get_feed_link() ) . "\" />\n";
2948      }
2949  
2950      /**
2951       * Filters whether to display the comments feed link.
2952       *
2953       * @since 4.4.0
2954       *
2955       * @param bool $show Whether to display the comments feed link. Default true.
2956       */
2957      if ( apply_filters( 'feed_links_show_comments_feed', true ) ) {
2958          echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . esc_attr( sprintf( $args['comstitle'], get_bloginfo( 'name' ), $args['separator'] ) ) . '" href="' . esc_url( get_feed_link( 'comments_' . get_default_feed() ) ) . "\" />\n";
2959      }
2960  }
2961  
2962  /**
2963   * Display the links to the extra feeds such as category feeds.
2964   *
2965   * @since 2.8.0
2966   *
2967   * @param array $args Optional arguments.
2968   */
2969  function feed_links_extra( $args = array() ) {
2970      $defaults = array(
2971          /* translators: Separator between blog name and feed type in feed links. */
2972          'separator'     => _x( '&raquo;', 'feed link' ),
2973          /* translators: 1: Blog name, 2: Separator (raquo), 3: Post title. */
2974          'singletitle'   => __( '%1$s %2$s %3$s Comments Feed' ),
2975          /* translators: 1: Blog name, 2: Separator (raquo), 3: Category name. */
2976          'cattitle'      => __( '%1$s %2$s %3$s Category Feed' ),
2977          /* translators: 1: Blog name, 2: Separator (raquo), 3: Tag name. */
2978          'tagtitle'      => __( '%1$s %2$s %3$s Tag Feed' ),
2979          /* translators: 1: Blog name, 2: Separator (raquo), 3: Term name, 4: Taxonomy singular name. */
2980          'taxtitle'      => __( '%1$s %2$s %3$s %4$s Feed' ),
2981          /* translators: 1: Blog name, 2: Separator (raquo), 3: Author name. */
2982          'authortitle'   => __( '%1$s %2$s Posts by %3$s Feed' ),
2983          /* translators: 1: Blog name, 2: Separator (raquo), 3: Search query. */
2984          'searchtitle'   => __( '%1$s %2$s Search Results for &#8220;%3$s&#8221; Feed' ),
2985          /* translators: 1: Blog name, 2: Separator (raquo), 3: Post type name. */
2986          'posttypetitle' => __( '%1$s %2$s %3$s Feed' ),
2987      );
2988  
2989      $args = wp_parse_args( $args, $defaults );
2990  
2991      if ( is_singular() ) {
2992          $id   = 0;
2993          $post = get_post( $id );
2994  
2995          if ( comments_open() || pings_open() || $post->comment_count > 0 ) {
2996              $title = sprintf( $args['singletitle'], get_bloginfo( 'name' ), $args['separator'], the_title_attribute( array( 'echo' => false ) ) );
2997              $href  = get_post_comments_feed_link( $post->ID );
2998          }
2999      } elseif ( is_post_type_archive() ) {
3000          $post_type = get_query_var( 'post_type' );
3001          if ( is_array( $post_type ) ) {
3002              $post_type = reset( $post_type );
3003          }
3004  
3005          $post_type_obj = get_post_type_object( $post_type );
3006          $title         = sprintf( $args['posttypetitle'], get_bloginfo( 'name' ), $args['separator'], $post_type_obj->labels->name );
3007          $href          = get_post_type_archive_feed_link( $post_type_obj->name );
3008      } elseif ( is_category() ) {
3009          $term = get_queried_object();
3010  
3011          if ( $term ) {
3012              $title = sprintf( $args['cattitle'], get_bloginfo( 'name' ), $args['separator'], $term->name );
3013              $href  = get_category_feed_link( $term->term_id );
3014          }
3015      } elseif ( is_tag() ) {
3016          $term = get_queried_object();
3017  
3018          if ( $term ) {
3019              $title = sprintf( $args['tagtitle'], get_bloginfo( 'name' ), $args['separator'], $term->name );
3020              $href  = get_tag_feed_link( $term->term_id );
3021          }
3022      } elseif ( is_tax() ) {
3023          $term = get_queried_object();
3024  
3025          if ( $term ) {
3026              $tax   = get_taxonomy( $term->taxonomy );
3027              $title = sprintf( $args['taxtitle'], get_bloginfo( 'name' ), $args['separator'], $term->name, $tax->labels->singular_name );
3028              $href  = get_term_feed_link( $term->term_id, $term->taxonomy );
3029          }
3030      } elseif ( is_author() ) {
3031          $author_id = intval( get_query_var( 'author' ) );
3032  
3033          $title = sprintf( $args['authortitle'], get_bloginfo( 'name' ), $args['separator'], get_the_author_meta( 'display_name', $author_id ) );
3034          $href  = get_author_feed_link( $author_id );
3035      } elseif ( is_search() ) {
3036          $title = sprintf( $args['searchtitle'], get_bloginfo( 'name' ), $args['separator'], get_search_query( false ) );
3037          $href  = get_search_feed_link();
3038      } elseif ( is_post_type_archive() ) {
3039          $title         = sprintf( $args['posttypetitle'], get_bloginfo( 'name' ), $args['separator'], post_type_archive_title( '', false ) );
3040          $post_type_obj = get_queried_object();
3041          if ( $post_type_obj ) {
3042              $href = get_post_type_archive_feed_link( $post_type_obj->name );
3043          }
3044      }
3045  
3046      if ( isset( $title ) && isset( $href ) ) {
3047          echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . esc_attr( $title ) . '" href="' . esc_url( $href ) . '" />' . "\n";
3048      }
3049  }
3050  
3051  /**
3052   * Display the link to the Really Simple Discovery service endpoint.
3053   *
3054   * @link http://archipelago.phrasewise.com/rsd
3055   * @since 2.0.0
3056   */
3057  function rsd_link() {
3058      echo '<link rel="EditURI" type="application/rsd+xml" title="RSD" href="' . esc_url( site_url( 'xmlrpc.php?rsd', 'rpc' ) ) . '" />' . "\n";
3059  }
3060  
3061  /**
3062   * Display the link to the Windows Live Writer manifest file.
3063   *
3064   * @link https://msdn.microsoft.com/en-us/library/bb463265.aspx
3065   * @since 2.3.1
3066   */
3067  function wlwmanifest_link() {
3068      echo '<link rel="wlwmanifest" type="application/wlwmanifest+xml" href="' . includes_url( 'wlwmanifest.xml' ) . '" /> ' . "\n";
3069  }
3070  
3071  /**
3072   * Displays a noindex meta tag if required by the blog configuration.
3073   *
3074   * If a blog is marked as not being public then the noindex meta tag will be
3075   * output to tell web robots not to index the page content. Add this to the
3076   * {@see 'wp_head'} action.
3077   *
3078   * Typical usage is as a {@see 'wp_head'} callback:
3079   *
3080   *     add_action( 'wp_head', 'noindex' );
3081   *
3082   * @see wp_no_robots
3083   *
3084   * @since 2.1.0
3085   */
3086  function noindex() {
3087      // If the blog is not public, tell robots to go away.
3088      if ( '0' == get_option( 'blog_public' ) ) {
3089          wp_no_robots();
3090      }
3091  }
3092  
3093  /**
3094   * Display a noindex meta tag.
3095   *
3096   * Outputs a noindex meta tag that tells web robots not to index the page content.
3097   * Typical usage is as a {@see 'wp_head'} callback. add_action( 'wp_head', 'wp_no_robots' );
3098   *
3099   * @since 3.3.0
3100   * @since 5.3.0 Echo "noindex,nofollow" if search engine visibility is discouraged.
3101   */
3102  function wp_no_robots() {
3103      if ( get_option( 'blog_public' ) ) {
3104          echo "<meta name='robots' content='noindex,follow' />\n";
3105          return;
3106      }
3107  
3108      echo "<meta name='robots' content='noindex,nofollow' />\n";
3109  }
3110  
3111  /**
3112   * Display a noindex,noarchive meta tag and referrer origin-when-cross-origin meta tag.
3113   *
3114   * Outputs a noindex,noarchive meta tag that tells web robots not to index or cache the page content.
3115   * Outputs a referrer origin-when-cross-origin meta tag that tells the browser not to send the full
3116   * url as a referrer to other sites when cross-origin assets are loaded.
3117   *
3118   * Typical usage is as a wp_head callback. add_action( 'wp_head', 'wp_sensitive_page_meta' );
3119   *
3120   * @since 5.0.1
3121   */
3122  function wp_sensitive_page_meta() {
3123      ?>
3124      <meta name='robots' content='noindex,noarchive' />
3125      <meta name='referrer' content='strict-origin-when-cross-origin' />
3126      <?php
3127  }
3128  
3129  /**
3130   * Display site icon meta tags.
3131   *
3132   * @since 4.3.0
3133   *
3134   * @link https://www.whatwg.org/specs/web-apps/current-work/multipage/links.html#rel-icon HTML5 specification link icon.
3135   */
3136  function wp_site_icon() {
3137      if ( ! has_site_icon() && ! is_customize_preview() ) {
3138          return;
3139      }
3140  
3141      $meta_tags = array();
3142      $icon_32   = get_site_icon_url( 32 );
3143      if ( empty( $icon_32 ) && is_customize_preview() ) {
3144          $icon_32 = '/favicon.ico'; // Serve default favicon URL in customizer so element can be updated for preview.
3145      }
3146      if ( $icon_32 ) {
3147          $meta_tags[] = sprintf( '<link rel="icon" href="%s" sizes="32x32" />', esc_url( $icon_32 ) );
3148      }
3149      $icon_192 = get_site_icon_url( 192 );
3150      if ( $icon_192 ) {
3151          $meta_tags[] = sprintf( '<link rel="icon" href="%s" sizes="192x192" />', esc_url( $icon_192 ) );
3152      }
3153      $icon_180 = get_site_icon_url( 180 );
3154      if ( $icon_180 ) {
3155          $meta_tags[] = sprintf( '<link rel="apple-touch-icon" href="%s" />', esc_url( $icon_180 ) );
3156      }
3157      $icon_270 = get_site_icon_url( 270 );
3158      if ( $icon_270 ) {
3159          $meta_tags[] = sprintf( '<meta name="msapplication-TileImage" content="%s" />', esc_url( $icon_270 ) );
3160      }
3161  
3162      /**
3163       * Filters the site icon meta tags, so plugins can add their own.
3164       *
3165       * @since 4.3.0
3166       *
3167       * @param string[] $meta_tags Array of Site Icon meta tags.
3168       */
3169      $meta_tags = apply_filters( 'site_icon_meta_tags', $meta_tags );
3170      $meta_tags = array_filter( $meta_tags );
3171  
3172      foreach ( $meta_tags as $meta_tag ) {
3173          echo "$meta_tag\n";
3174      }
3175  }
3176  
3177  /**
3178   * Prints resource hints to browsers for pre-fetching, pre-rendering
3179   * and pre-connecting to web sites.
3180   *
3181   * Gives hints to browsers to prefetch specific pages or render them
3182   * in the background, to perform DNS lookups or to begin the connection
3183   * handshake (DNS, TCP, TLS) in the background.
3184   *
3185   * These performance improving indicators work by using `<link rel"…">`.
3186   *
3187   * @since 4.6.0
3188   */
3189  function wp_resource_hints() {
3190      $hints = array(
3191          'dns-prefetch' => wp_dependencies_unique_hosts(),
3192          'preconnect'   => array(),
3193          'prefetch'     => array(),
3194          'prerender'    => array(),
3195      );
3196  
3197      /*
3198       * Add DNS prefetch for the Emoji CDN.
3199       * The path is removed in the foreach loop below.
3200       */
3201      /** This filter is documented in wp-includes/formatting.php */
3202      $hints['dns-prefetch'][] = apply_filters( 'emoji_svg_url', 'https://s.w.org/images/core/emoji/12.0.0-1/svg/' );
3203  
3204      foreach ( $hints as $relation_type => $urls ) {
3205          $unique_urls = array();
3206  
3207          /**
3208           * Filters domains and URLs for resource hints of relation type.
3209           *
3210           * @since 4.6.0
3211           *
3212           * @param array  $urls          URLs to print for resource hints.
3213           * @param string $relation_type The relation type the URLs are printed for, e.g. 'preconnect' or 'prerender'.
3214           */
3215          $urls = apply_filters( 'wp_resource_hints', $urls, $relation_type );
3216  
3217          foreach ( $urls as $key => $url ) {
3218              $atts = array();
3219  
3220              if ( is_array( $url ) ) {
3221                  if ( isset( $url['href'] ) ) {
3222                      $atts = $url;
3223                      $url  = $url['href'];
3224                  } else {
3225                      continue;
3226                  }
3227              }
3228  
3229              $url = esc_url( $url, array( 'http', 'https' ) );
3230  
3231              if ( ! $url ) {
3232                  continue;
3233              }
3234  
3235              if ( isset( $unique_urls[ $url ] ) ) {
3236                  continue;
3237              }
3238  
3239              if ( in_array( $relation_type, array( 'preconnect', 'dns-prefetch' ) ) ) {
3240                  $parsed = wp_parse_url( $url );
3241  
3242                  if ( empty( $parsed['host'] ) ) {
3243                      continue;
3244                  }
3245  
3246                  if ( 'preconnect' === $relation_type && ! empty( $parsed['scheme'] ) ) {
3247                      $url = $parsed['scheme'] . '://' . $parsed['host'];
3248                  } else {
3249                      // Use protocol-relative URLs for dns-prefetch or if scheme is missing.
3250                      $url = '//' . $parsed['host'];
3251                  }
3252              }
3253  
3254              $atts['rel']  = $relation_type;
3255              $atts['href'] = $url;
3256  
3257              $unique_urls[ $url ] = $atts;
3258          }
3259  
3260          foreach ( $unique_urls as $atts ) {
3261              $html = '';
3262  
3263              foreach ( $atts as $attr => $value ) {
3264                  if ( ! is_scalar( $value ) ||
3265                      ( ! in_array( $attr, array( 'as', 'crossorigin', 'href', 'pr', 'rel', 'type' ), true ) && ! is_numeric( $attr ) ) ) {
3266  
3267                      continue;
3268                  }
3269  
3270                  $value = ( 'href' === $attr ) ? esc_url( $value ) : esc_attr( $value );
3271  
3272                  if ( ! is_string( $attr ) ) {
3273                      $html .= " $value";
3274                  } else {
3275                      $html .= " $attr='$value'";
3276                  }
3277              }
3278  
3279              $html = trim( $html );
3280  
3281              echo "<link $html />\n";
3282          }
3283      }
3284  }
3285  
3286  /**
3287   * Retrieves a list of unique hosts of all enqueued scripts and styles.
3288   *
3289   * @since 4.6.0
3290   *
3291   * @return string[] A list of unique hosts of enqueued scripts and styles.
3292   */
3293  function wp_dependencies_unique_hosts() {
3294      global $wp_scripts, $wp_styles;
3295  
3296      $unique_hosts = array();
3297  
3298      foreach ( array( $wp_scripts, $wp_styles ) as $dependencies ) {
3299          if ( $dependencies instanceof WP_Dependencies && ! empty( $dependencies->queue ) ) {
3300              foreach ( $dependencies->queue as $handle ) {
3301                  if ( ! isset( $dependencies->registered[ $handle ] ) ) {
3302                      continue;
3303                  }
3304  
3305                  /* @var _WP_Dependency $dependency */
3306                  $dependency = $dependencies->registered[ $handle ];
3307                  $parsed     = wp_parse_url( $dependency->src );
3308  
3309                  if ( ! empty( $parsed['host'] ) && ! in_array( $parsed['host'], $unique_hosts ) && $parsed['host'] !== $_SERVER['SERVER_NAME'] ) {
3310                      $unique_hosts[] = $parsed['host'];
3311                  }
3312              }
3313          }
3314      }
3315  
3316      return $unique_hosts;
3317  }
3318  
3319  /**
3320   * Whether the user can access the visual editor.
3321   *
3322   * Checks if the user can access the visual editor and that it's supported by the user's browser.
3323   *
3324   * @since 2.0.0
3325   *
3326   * @global bool $wp_rich_edit Whether the user can access the visual editor.
3327   * @global bool $is_gecko     Whether the browser is Gecko-based.
3328   * @global bool $is_opera     Whether the browser is Opera.
3329   * @global bool $is_safari    Whether the browser is Safari.
3330   * @global bool $is_chrome    Whether the browser is Chrome.
3331   * @global bool $is_IE        Whether the browser is Internet Explorer.
3332   * @global bool $is_edge      Whether the browser is Microsoft Edge.
3333   *
3334   * @return bool True if the user can access the visual editor, false otherwise.
3335   */
3336  function user_can_richedit() {
3337      global $wp_rich_edit, $is_gecko, $is_opera, $is_safari, $is_chrome, $is_IE, $is_edge;
3338  
3339      if ( ! isset( $wp_rich_edit ) ) {
3340          $wp_rich_edit = false;
3341  
3342          if ( get_user_option( 'rich_editing' ) == 'true' || ! is_user_logged_in() ) { // default to 'true' for logged out users
3343              if ( $is_safari ) {
3344                  $wp_rich_edit = ! wp_is_mobile() || ( preg_match( '!AppleWebKit/(\d+)!', $_SERVER['HTTP_USER_AGENT'], $match ) && intval( $match[1] ) >= 534 );
3345              } elseif ( $is_IE ) {
3346                  $wp_rich_edit = ( strpos( $_SERVER['HTTP_USER_AGENT'], 'Trident/7.0;' ) !== false );
3347              } elseif ( $is_gecko || $is_chrome || $is_edge || ( $is_opera && ! wp_is_mobile() ) ) {
3348                  $wp_rich_edit = true;
3349              }
3350          }
3351      }
3352  
3353      /**
3354       * Filters whether the user can access the visual editor.
3355       *
3356       * @since 2.1.0
3357       *
3358       * @param bool $wp_rich_edit Whether the user can access the visual editor.
3359       */
3360      return apply_filters( 'user_can_richedit', $wp_rich_edit );
3361  }
3362  
3363  /**
3364   * Find out which editor should be displayed by default.
3365   *
3366   * Works out which of the two editors to display as the current editor for a
3367   * user. The 'html' setting is for the "Text" editor tab.
3368   *
3369   * @since 2.5.0
3370   *
3371   * @return string Either 'tinymce', or 'html', or 'test'
3372   */
3373  function wp_default_editor() {
3374      $r = user_can_richedit() ? 'tinymce' : 'html'; // defaults
3375      if ( wp_get_current_user() ) { // look for cookie
3376          $ed = get_user_setting( 'editor', 'tinymce' );
3377          $r  = ( in_array( $ed, array( 'tinymce', 'html', 'test' ) ) ) ? $ed : $r;
3378      }
3379  
3380      /**
3381       * Filters which editor should be displayed by default.
3382       *
3383       * @since 2.5.0
3384       *
3385       * @param string $r Which editor should be displayed by default. Either 'tinymce', 'html', or 'test'.
3386       */
3387      return apply_filters( 'wp_default_editor', $r );
3388  }
3389  
3390  /**
3391   * Renders an editor.
3392   *
3393   * Using this function is the proper way to output all needed components for both TinyMCE and Quicktags.
3394   * _WP_Editors should not be used directly. See https://core.trac.wordpress.org/ticket/17144.
3395   *
3396   * NOTE: Once initialized the TinyMCE editor cannot be safely moved in the DOM. For that reason
3397   * running wp_editor() inside of a meta box is not a good idea unless only Quicktags is used.
3398   * On the post edit screen several actions can be used to include additional editors
3399   * containing TinyMCE: 'edit_page_form', 'edit_form_advanced' and 'dbx_post_sidebar'.
3400   * See https://core.trac.wordpress.org/ticket/19173 for more information.
3401   *
3402   * @see _WP_Editors::editor()
3403   * @since 3.3.0
3404   *
3405   * @param string $content   Initial content for the editor.
3406   * @param string $editor_id HTML ID attribute value for the textarea and TinyMCE. Can only be /[a-z]+/.
3407   * @param array  $settings  See _WP_Editors::editor().
3408   */
3409  function wp_editor( $content, $editor_id, $settings = array() ) {
3410      if ( ! class_exists( '_WP_Editors', false ) ) {
3411          require ( ABSPATH . WPINC . '/class-wp-editor.php' );
3412      }
3413      _WP_Editors::editor( $content, $editor_id, $settings );
3414  }
3415  
3416  /**
3417   * Outputs the editor scripts, stylesheets, and default settings.
3418   *
3419   * The editor can be initialized when needed after page load.
3420   * See wp.editor.initialize() in wp-admin/js/editor.js for initialization options.
3421   *
3422   * @uses _WP_Editors
3423   * @since 4.8.0
3424   */
3425  function wp_enqueue_editor() {
3426      if ( ! class_exists( '_WP_Editors', false ) ) {
3427          require ( ABSPATH . WPINC . '/class-wp-editor.php' );
3428      }
3429  
3430      _WP_Editors::enqueue_default_editor();
3431  }
3432  
3433  /**
3434   * Enqueue assets needed by the code editor for the given settings.
3435   *
3436   * @since 4.9.0
3437   *
3438   * @see wp_enqueue_editor()
3439   * @see wp_get_code_editor_settings();
3440   * @see _WP_Editors::parse_settings()
3441   *
3442   * @param array $args {
3443   *     Args.
3444   *
3445   *     @type string   $type       The MIME type of the file to be edited.
3446   *     @type string   $file       Filename to be edited. Extension is used to sniff the type. Can be supplied as alternative to `$type` param.
3447   *     @type WP_Theme $theme      Theme being edited when on theme editor.
3448   *     @type string   $plugin     Plugin being edited when on plugin editor.
3449   *     @type array    $codemirror Additional CodeMirror setting overrides.
3450   *     @type array    $csslint    CSSLint rule overrides.
3451   *     @type array    $jshint     JSHint rule overrides.
3452   *     @type array    $htmlhint   JSHint rule overrides.
3453   * }
3454   * @return array|false Settings for the enqueued code editor, or false if the editor was not enqueued.
3455   */
3456  function wp_enqueue_code_editor( $args ) {
3457      if ( is_user_logged_in() && 'false' === wp_get_current_user()->syntax_highlighting ) {
3458          return false;
3459      }
3460  
3461      $settings = wp_get_code_editor_settings( $args );
3462  
3463      if ( empty( $settings ) || empty( $settings['codemirror'] ) ) {
3464          return false;
3465      }
3466  
3467      wp_enqueue_script( 'code-editor' );
3468      wp_enqueue_style( 'code-editor' );
3469  
3470      if ( isset( $settings['codemirror']['mode'] ) ) {
3471          $mode = $settings['codemirror']['mode'];
3472          if ( is_string( $mode ) ) {
3473              $mode = array(
3474                  'name' => $mode,
3475              );
3476          }
3477  
3478          if ( ! empty( $settings['codemirror']['lint'] ) ) {
3479              switch ( $mode['name'] ) {
3480                  case 'css':
3481                  case 'text/css':
3482                  case 'text/x-scss':
3483                  case 'text/x-less':
3484                      wp_enqueue_script( 'csslint' );
3485                      break;
3486                  case 'htmlmixed':
3487                  case 'text/html':
3488                  case 'php':
3489                  case 'application/x-httpd-php':
3490                  case 'text/x-php':
3491                      wp_enqueue_script( 'htmlhint' );
3492                      wp_enqueue_script( 'csslint' );
3493                      wp_enqueue_script( 'jshint' );
3494                      if ( ! current_user_can( 'unfiltered_html' ) ) {
3495                          wp_enqueue_script( 'htmlhint-kses' );
3496                      }
3497                      break;
3498                  case 'javascript':
3499                  case 'application/ecmascript':
3500                  case 'application/json':
3501                  case 'application/javascript':
3502                  case 'application/ld+json':
3503                  case 'text/typescript':
3504                  case 'application/typescript':
3505                      wp_enqueue_script( 'jshint' );
3506                      wp_enqueue_script( 'jsonlint' );
3507                      break;
3508              }
3509          }
3510      }
3511  
3512      wp_add_inline_script( 'code-editor', sprintf( 'jQuery.extend( wp.codeEditor.defaultSettings, %s );', wp_json_encode( $settings ) ) );
3513  
3514      /**
3515       * Fires when scripts and styles are enqueued for the code editor.
3516       *
3517       * @since 4.9.0
3518       *
3519       * @param array $settings Settings for the enqueued code editor.
3520       */
3521      do_action( 'wp_enqueue_code_editor', $settings );
3522  
3523      return $settings;
3524  }
3525  
3526  /**
3527   * Generate and return code editor settings.
3528   *
3529   * @since 5.0.0
3530   *
3531   * @see wp_enqueue_code_editor()
3532   *
3533   * @param array $args {
3534   *     Args.
3535   *
3536   *     @type string   $type       The MIME type of the file to be edited.
3537   *     @type string   $file       Filename to be edited. Extension is used to sniff the type. Can be supplied as alternative to `$type` param.
3538   *     @type WP_Theme $theme      Theme being edited when on theme editor.
3539   *     @type string   $plugin     Plugin being edited when on plugin editor.
3540   *     @type array    $codemirror Additional CodeMirror setting overrides.
3541   *     @type array    $csslint    CSSLint rule overrides.
3542   *     @type array    $jshint     JSHint rule overrides.
3543   *     @type array    $htmlhint   JSHint rule overrides.
3544   * }
3545   * @return array|false Settings for the code editor.
3546   */
3547  function wp_get_code_editor_settings( $args ) {
3548      $settings = array(
3549          'codemirror' => array(
3550              'indentUnit'       => 4,
3551              'indentWithTabs'   => true,
3552              'inputStyle'       => 'contenteditable',
3553              'lineNumbers'      => true,
3554              'lineWrapping'     => true,
3555              'styleActiveLine'  => true,
3556              'continueComments' => true,
3557              'extraKeys'        => array(
3558                  'Ctrl-Space' => 'autocomplete',
3559                  'Ctrl-/'     => 'toggleComment',
3560                  'Cmd-/'      => 'toggleComment',
3561                  'Alt-F'      => 'findPersistent',
3562                  'Ctrl-F'     => 'findPersistent',
3563                  'Cmd-F'      => 'findPersistent',
3564              ),
3565              'direction'        => 'ltr', // Code is shown in LTR even in RTL languages.
3566              'gutters'          => array(),
3567          ),
3568          'csslint'    => array(
3569              'errors'                    => true, // Parsing errors.
3570              'box-model'                 => true,
3571              'display-property-grouping' => true,
3572              'duplicate-properties'      => true,
3573              'known-properties'          => true,
3574              'outline-none'              => true,
3575          ),
3576          'jshint'     => array(
3577              // The following are copied from <https://github.com/WordPress/wordpress-develop/blob/4.8.1/.jshintrc>.
3578              'boss'     => true,
3579              'curly'    => true,
3580              'eqeqeq'   => true,
3581              'eqnull'   => true,
3582              'es3'      => true,
3583              'expr'     => true,
3584              'immed'    => true,
3585              'noarg'    => true,
3586              'nonbsp'   => true,
3587              'onevar'   => true,
3588              'quotmark' => 'single',
3589              'trailing' => true,
3590              'undef'    => true,
3591              'unused'   => true,
3592  
3593              'browser'  => true,
3594  
3595              'globals'  => array(
3596                  '_'        => false,
3597                  'Backbone' => false,
3598                  'jQuery'   => false,
3599                  'JSON'     => false,
3600                  'wp'       => false,
3601              ),
3602          ),
3603          'htmlhint'   => array(
3604              'tagname-lowercase'        => true,
3605              'attr-lowercase'           => true,
3606              'attr-value-double-quotes' => false,
3607              'doctype-first'            => false,
3608              'tag-pair'                 => true,
3609              'spec-char-escape'         => true,
3610              'id-unique'                => true,
3611              'src-not-empty'            => true,
3612              'attr-no-duplication'      => true,
3613              'alt-require'              => true,
3614              'space-tab-mixed-disabled' => 'tab',
3615              'attr-unsafe-chars'        => true,
3616          ),
3617      );
3618  
3619      $type = '';
3620      if ( isset( $args['type'] ) ) {
3621          $type = $args['type'];
3622  
3623          // Remap MIME types to ones that CodeMirror modes will recognize.
3624          if ( 'application/x-patch' === $type || 'text/x-patch' === $type ) {
3625              $type = 'text/x-diff';
3626          }
3627      } elseif ( isset( $args['file'] ) && false !== strpos( basename( $args['file'] ), '.' ) ) {
3628          $extension = strtolower( pathinfo( $args['file'], PATHINFO_EXTENSION ) );
3629          foreach ( wp_get_mime_types() as $exts => $mime ) {
3630              if ( preg_match( '!^(' . $exts . ')$!i', $extension ) ) {
3631                  $type = $mime;
3632                  break;
3633              }
3634          }
3635  
3636          // Supply any types that are not matched by wp_get_mime_types().
3637          if ( empty( $type ) ) {
3638              switch ( $extension ) {
3639                  case 'conf':
3640                      $type = 'text/nginx';
3641                      break;
3642                  case 'css':
3643                      $type = 'text/css';
3644                      break;
3645                  case 'diff':
3646                  case 'patch':
3647                      $type = 'text/x-diff';
3648                      break;
3649                  case 'html':
3650                  case 'htm':
3651                      $type = 'text/html';
3652                      break;
3653                  case 'http':
3654                      $type = 'message/http';
3655                      break;
3656                  case 'js':
3657                      $type = 'text/javascript';
3658                      break;
3659                  case 'json':
3660                      $type = 'application/json';
3661                      break;
3662                  case 'jsx':
3663                      $type = 'text/jsx';
3664                      break;
3665                  case 'less':
3666                      $type = 'text/x-less';
3667                      break;
3668                  case 'md':
3669                      $type = 'text/x-gfm';
3670                      break;
3671                  case 'php':
3672                  case 'phtml':
3673                  case 'php3':
3674                  case 'php4':
3675                  case 'php5':
3676                  case 'php7':
3677                  case 'phps':
3678                      $type = 'application/x-httpd-php';
3679                      break;
3680                  case 'scss':
3681                      $type = 'text/x-scss';
3682                      break;
3683                  case 'sass':
3684                      $type = 'text/x-sass';
3685                      break;
3686                  case 'sh':
3687                  case 'bash':
3688                      $type = 'text/x-sh';
3689                      break;
3690                  case 'sql':
3691                      $type = 'text/x-sql';
3692                      break;
3693                  case 'svg':
3694                      $type = 'application/svg+xml';
3695                      break;
3696                  case 'xml':
3697                      $type = 'text/xml';
3698                      break;
3699                  case 'yml':
3700                  case 'yaml':
3701                      $type = 'text/x-yaml';
3702                      break;
3703                  case 'txt':
3704                  default:
3705                      $type = 'text/plain';
3706                      break;
3707              }
3708          }
3709      }
3710  
3711      if ( 'text/css' === $type ) {
3712          $settings['codemirror'] = array_merge(
3713              $settings['codemirror'],
3714              array(
3715                  'mode'              => 'css',
3716                  'lint'              => true,
3717                  'autoCloseBrackets' => true,
3718                  'matchBrackets'     => true,
3719              )
3720          );
3721      } elseif ( 'text/x-scss' === $type || 'text/x-less' === $type || 'text/x-sass' === $type ) {
3722          $settings['codemirror'] = array_merge(
3723              $settings['codemirror'],
3724              array(
3725                  'mode'              => $type,
3726                  'lint'              => false,
3727                  'autoCloseBrackets' => true,
3728                  'matchBrackets'     => true,
3729              )
3730          );
3731      } elseif ( 'text/x-diff' === $type ) {
3732          $settings['codemirror'] = array_merge(
3733              $settings['codemirror'],
3734              array(
3735                  'mode' => 'diff',
3736              )
3737          );
3738      } elseif ( 'text/html' === $type ) {
3739          $settings['codemirror'] = array_merge(
3740              $settings['codemirror'],
3741              array(
3742                  'mode'              => 'htmlmixed',
3743                  'lint'              => true,
3744                  'autoCloseBrackets' => true,
3745                  'autoCloseTags'     => true,
3746                  'matchTags'         => array(
3747                      'bothTags' => true,
3748                  ),
3749              )
3750          );
3751  
3752          if ( ! current_user_can( 'unfiltered_html' ) ) {
3753              $settings['htmlhint']['kses'] = wp_kses_allowed_html( 'post' );
3754          }
3755      } elseif ( 'text/x-gfm' === $type ) {
3756          $settings['codemirror'] = array_merge(
3757              $settings['codemirror'],
3758              array(
3759                  'mode'                => 'gfm',
3760                  'highlightFormatting' => true,
3761              )
3762          );
3763      } elseif ( 'application/javascript' === $type || 'text/javascript' === $type ) {
3764          $settings['codemirror'] = array_merge(
3765              $settings['codemirror'],
3766              array(
3767                  'mode'              => 'javascript',
3768                  'lint'              => true,
3769                  'autoCloseBrackets' => true,
3770                  'matchBrackets'     => true,
3771              )
3772          );
3773      } elseif ( false !== strpos( $type, 'json' ) ) {
3774          $settings['codemirror'] = array_merge(
3775              $settings['codemirror'],
3776              array(
3777                  'mode'              => array(
3778                      'name' => 'javascript',
3779                  ),
3780                  'lint'              => true,
3781                  'autoCloseBrackets' => true,
3782                  'matchBrackets'     => true,
3783              )
3784          );
3785          if ( 'application/ld+json' === $type ) {
3786              $settings['codemirror']['mode']['jsonld'] = true;
3787          } else {
3788              $settings['codemirror']['mode']['json'] = true;
3789          }
3790      } elseif ( false !== strpos( $type, 'jsx' ) ) {
3791          $settings['codemirror'] = array_merge(
3792              $settings['codemirror'],
3793              array(
3794                  'mode'              => 'jsx',
3795                  'autoCloseBrackets' => true,
3796                  'matchBrackets'     => true,
3797              )
3798          );
3799      } elseif ( 'text/x-markdown' === $type ) {
3800          $settings['codemirror'] = array_merge(
3801              $settings['codemirror'],
3802              array(
3803                  'mode'                => 'markdown',
3804                  'highlightFormatting' => true,
3805              )
3806          );
3807      } elseif ( 'text/nginx' === $type ) {
3808          $settings['codemirror'] = array_merge(
3809              $settings['codemirror'],
3810              array(
3811                  'mode' => 'nginx',
3812              )
3813          );
3814      } elseif ( 'application/x-httpd-php' === $type ) {
3815          $settings['codemirror'] = array_merge(
3816              $settings['codemirror'],
3817              array(
3818                  'mode'              => 'php',
3819                  'autoCloseBrackets' => true,
3820                  'autoCloseTags'     => true,
3821                  'matchBrackets'     => true,
3822                  'matchTags'         => array(
3823                      'bothTags' => true,
3824                  ),
3825              )
3826          );
3827      } elseif ( 'text/x-sql' === $type || 'text/x-mysql' === $type ) {
3828          $settings['codemirror'] = array_merge(
3829              $settings['codemirror'],
3830              array(
3831                  'mode'              => 'sql',
3832                  'autoCloseBrackets' => true,
3833                  'matchBrackets'     => true,
3834              )
3835          );
3836      } elseif ( false !== strpos( $type, 'xml' ) ) {
3837          $settings['codemirror'] = array_merge(
3838              $settings['codemirror'],
3839              array(
3840                  'mode'              => 'xml',
3841                  'autoCloseBrackets' => true,
3842                  'autoCloseTags'     => true,
3843                  'matchTags'         => array(
3844                      'bothTags' => true,
3845                  ),
3846              )
3847          );
3848      } elseif ( 'text/x-yaml' === $type ) {
3849          $settings['codemirror'] = array_merge(
3850              $settings['codemirror'],
3851              array(
3852                  'mode' => 'yaml',
3853              )
3854          );
3855      } else {
3856          $settings['codemirror']['mode'] = $type;
3857      }
3858  
3859      if ( ! empty( $settings['codemirror']['lint'] ) ) {
3860          $settings['codemirror']['gutters'][] = 'CodeMirror-lint-markers';
3861      }
3862  
3863      // Let settings supplied via args override any defaults.
3864      foreach ( wp_array_slice_assoc( $args, array( 'codemirror', 'csslint', 'jshint', 'htmlhint' ) ) as $key => $value ) {
3865          $settings[ $key ] = array_merge(
3866              $settings[ $key ],
3867              $value
3868          );
3869      }
3870  
3871      /**
3872       * Filters settings that are passed into the code editor.
3873       *
3874       * Returning a falsey value will disable the syntax-highlighting code editor.
3875       *
3876       * @since 4.9.0
3877       *
3878       * @param array $settings The array of settings passed to the code editor. A falsey value disables the editor.
3879       * @param array $args {
3880       *     Args passed when calling `get_code_editor_settings()`.
3881       *
3882       *     @type string   $type       The MIME type of the file to be edited.
3883       *     @type string   $file       Filename being edited.
3884       *     @type WP_Theme $theme      Theme being edited when on theme editor.
3885       *     @type string   $plugin     Plugin being edited when on plugin editor.
3886       *     @type array    $codemirror Additional CodeMirror setting overrides.
3887       *     @type array    $csslint    CSSLint rule overrides.
3888       *     @type array    $jshint     JSHint rule overrides.
3889       *     @type array    $htmlhint   JSHint rule overrides.
3890       * }
3891       */
3892      return apply_filters( 'wp_code_editor_settings', $settings, $args );
3893  }
3894  
3895  /**
3896   * Retrieves the contents of the search WordPress query variable.
3897   *
3898   * The search query string is passed through esc_attr() to ensure that it is safe
3899   * for placing in an html attribute.
3900   *
3901   * @since 2.3.0
3902   *
3903   * @param bool $escaped Whether the result is escaped. Default true.
3904   *                      Only use when you are later escaping it. Do not use unescaped.
3905   * @return string
3906   */
3907  function get_search_query( $escaped = true ) {
3908      /**
3909       * Filters the contents of the search query variable.
3910       *
3911       * @since 2.3.0
3912       *
3913       * @param mixed $search Contents of the search query variable.
3914       */
3915      $query = apply_filters( 'get_search_query', get_query_var( 's' ) );
3916  
3917      if ( $escaped ) {
3918          $query = esc_attr( $query );
3919      }
3920      return $query;
3921  }
3922  
3923  /**
3924   * Displays the contents of the search query variable.
3925   *
3926   * The search query string is passed through esc_attr() to ensure that it is safe
3927   * for placing in an html attribute.
3928   *
3929   * @since 2.1.0
3930   */
3931  function the_search_query() {
3932      /**
3933       * Filters the contents of the search query variable for display.
3934       *
3935       * @since 2.3.0
3936       *
3937       * @param mixed $search Contents of the search query variable.
3938       */
3939      echo esc_attr( apply_filters( 'the_search_query', get_search_query( false ) ) );
3940  }
3941  
3942  /**
3943   * Gets the language attributes for the html tag.
3944   *
3945   * Builds up a set of html attributes containing the text direction and language
3946   * information for the page.
3947   *
3948   * @since 4.3.0
3949   *
3950   * @param string $doctype Optional. The type of html document. Accepts 'xhtml' or 'html'. Default 'html'.
3951   */
3952  function get_language_attributes( $doctype = 'html' ) {
3953      $attributes = array();
3954  
3955      if ( function_exists( 'is_rtl' ) && is_rtl() ) {
3956          $attributes[] = 'dir="rtl"';
3957      }
3958  
3959      $lang = get_bloginfo( 'language' );
3960      if ( $lang ) {
3961          if ( get_option( 'html_type' ) == 'text/html' || $doctype == 'html' ) {
3962              $attributes[] = 'lang="' . esc_attr( $lang ) . '"';
3963          }
3964  
3965          if ( get_option( 'html_type' ) != 'text/html' || $doctype == 'xhtml' ) {
3966              $attributes[] = 'xml:lang="' . esc_attr( $lang ) . '"';
3967          }
3968      }
3969  
3970      $output = implode( ' ', $attributes );
3971  
3972      /**
3973       * Filters the language attributes for display in the html tag.
3974       *
3975       * @since 2.5.0
3976       * @since 4.3.0 Added the `$doctype` parameter.
3977       *
3978       * @param string $output A space-separated list of language attributes.
3979       * @param string $doctype The type of html document (xhtml|html).
3980       */
3981      return apply_filters( 'language_attributes', $output, $doctype );
3982  }
3983  
3984  /**
3985   * Displays the language attributes for the html tag.
3986   *
3987   * Builds up a set of html attributes containing the text direction and language
3988   * information for the page.
3989   *
3990   * @since 2.1.0
3991   * @since 4.3.0 Converted into a wrapper for get_language_attributes().
3992   *
3993   * @param string $doctype Optional. The type of html document. Accepts 'xhtml' or 'html'. Default 'html'.
3994   */
3995  function language_attributes( $doctype = 'html' ) {
3996      echo get_language_attributes( $doctype );
3997  }
3998  
3999  /**
4000   * Retrieve paginated link for archive post pages.
4001   *
4002   * Technically, the function can be used to create paginated link list for any
4003   * area. The 'base' argument is used to reference the url, which will be used to
4004   * create the paginated links. The 'format' argument is then used for replacing
4005   * the page number. It is however, most likely and by default, to be used on the
4006   * archive post pages.
4007   *
4008   * The 'type' argument controls format of the returned value. The default is
4009   * 'plain', which is just a string with the links separated by a newline
4010   * character. The other possible values are either 'array' or 'list'. The
4011   * 'array' value will return an array of the paginated link list to offer full
4012   * control of display. The 'list' value will place all of the paginated links in
4013   * an unordered HTML list.
4014   *
4015   * The 'total' argument is the total amount of pages and is an integer. The
4016   * 'current' argument is the current page number and is also an integer.
4017   *
4018   * An example of the 'base' argument is "http://example.com/all_posts.php%_%"
4019   * and the '%_%' is required. The '%_%' will be replaced by the contents of in
4020   * the 'format' argument. An example for the 'format' argument is "?page=%#%"
4021   * and the '%#%' is also required. The '%#%' will be replaced with the page
4022   * number.
4023   *
4024   * You can include the previous and next links in the list by setting the
4025   * 'prev_next' argument to true, which it is by default. You can set the
4026   * previous text, by using the 'prev_text' argument. You can set the next text
4027   * by setting the 'next_text' argument.
4028   *
4029   * If the 'show_all' argument is set to true, then it will show all of the pages
4030   * instead of a short list of the pages near the current page. By default, the
4031   * 'show_all' is set to false and controlled by the 'end_size' and 'mid_size'
4032   * arguments. The 'end_size' argument is how many numbers on either the start
4033   * and the end list edges, by default is 1. The 'mid_size' argument is how many
4034   * numbers to either side of current page, but not including current page.
4035   *
4036   * It is possible to add query vars to the link by using the 'add_args' argument
4037   * and see add_query_arg() for more information.
4038   *
4039   * The 'before_page_number' and 'after_page_number' arguments allow users to
4040   * augment the links themselves. Typically this might be to add context to the
4041   * numbered links so that screen reader users understand what the links are for.
4042   * The text strings are added before and after the page number - within the
4043   * anchor tag.
4044   *
4045   * @since 2.1.0
4046   * @since 4.9.0 Added the `aria_current` argument.
4047   *
4048   * @global WP_Query   $wp_query   WordPress Query object.
4049   * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
4050   *
4051   * @param string|array $args {
4052   *     Optional. Array or string of arguments for generating paginated links for archives.
4053   *
4054   *     @type string $base               Base of the paginated url. Default empty.
4055   *     @type string $format             Format for the pagination structure. Default empty.
4056   *     @type int    $total              The total amount of pages. Default is the value WP_Query's
4057   *                                      `max_num_pages` or 1.
4058   *     @type int    $current            The current page number. Default is 'paged' query var or 1.
4059   *     @type string $aria_current       The value for the aria-current attribute. Possible values are 'page',
4060   *                                      'step', 'location', 'date', 'time', 'true', 'false'. Default is 'page'.
4061   *     @type bool   $show_all           Whether to show all pages. Default false.
4062   *     @type int    $end_size           How many numbers on either the start and the end list edges.
4063   *                                      Default 1.
4064   *     @type int    $mid_size           How many numbers to either side of the current pages. Default 2.
4065   *     @type bool   $prev_next          Whether to include the previous and next links in the list. Default true.
4066   *     @type bool   $prev_text          The previous page text. Default '&laquo; Previous'.
4067   *     @type bool   $next_text          The next page text. Default 'Next &raquo;'.
4068   *     @type string $type               Controls format of the returned value. Possible values are 'plain',
4069   *                                      'array' and 'list'. Default is 'plain'.
4070   *     @type array  $add_args           An array of query args to add. Default false.
4071   *     @type string $add_fragment       A string to append to each link. Default empty.
4072   *     @type string $before_page_number A string to appear before the page number. Default empty.
4073   *     @type string $after_page_number  A string to append after the page number. Default empty.
4074   * }
4075   * @return string|array|void String of page links or array of page links, depending on 'type' argument.
4076   *                           Void if total number of pages is less than 2.
4077   */
4078  function paginate_links( $args = '' ) {
4079      global $wp_query, $wp_rewrite;
4080  
4081      // Setting up default values based on the current URL.
4082      $pagenum_link = html_entity_decode( get_pagenum_link() );
4083      $url_parts    = explode( '?', $pagenum_link );
4084  
4085      // Get max pages and current page out of the current query, if available.
4086      $total   = isset( $wp_query->max_num_pages ) ? $wp_query->max_num_pages : 1;
4087      $current = get_query_var( 'paged' ) ? intval( get_query_var( 'paged' ) ) : 1;
4088  
4089      // Append the format placeholder to the base URL.
4090      $pagenum_link = trailingslashit( $url_parts[0] ) . '%_%';
4091  
4092      // URL base depends on permalink settings.
4093      $format  = $wp_rewrite->using_index_permalinks() && ! strpos( $pagenum_link, 'index.php' ) ? 'index.php/' : '';
4094      $format .= $wp_rewrite->using_permalinks() ? user_trailingslashit( $wp_rewrite->pagination_base . '/%#%', 'paged' ) : '?paged=%#%';
4095  
4096      $defaults = array(
4097          'base'               => $pagenum_link, // http://example.com/all_posts.php%_% : %_% is replaced by format (below)
4098          'format'             => $format, // ?page=%#% : %#% is replaced by the page number
4099          'total'              => $total,
4100          'current'            => $current,
4101          'aria_current'       => 'page',
4102          'show_all'           => false,
4103          'prev_next'          => true,
4104          'prev_text'          => __( '&laquo; Previous' ),
4105          'next_text'          => __( 'Next &raquo;' ),
4106          'end_size'           => 1,
4107          'mid_size'           => 2,
4108          'type'               => 'plain',
4109          'add_args'           => array(), // array of query args to add
4110          'add_fragment'       => '',
4111          'before_page_number' => '',
4112          'after_page_number'  => '',
4113      );
4114  
4115      $args = wp_parse_args( $args, $defaults );
4116  
4117      if ( ! is_array( $args['add_args'] ) ) {
4118          $args['add_args'] = array();
4119      }
4120  
4121      // Merge additional query vars found in the original URL into 'add_args' array.
4122      if ( isset( $url_parts[1] ) ) {
4123          // Find the format argument.
4124          $format       = explode( '?', str_replace( '%_%', $args['format'], $args['base'] ) );
4125          $format_query = isset( $format[1] ) ? $format[1] : '';
4126          wp_parse_str( $format_query, $format_args );
4127  
4128          // Find the query args of the requested URL.
4129          wp_parse_str( $url_parts[1], $url_query_args );
4130  
4131          // Remove the format argument from the array of query arguments, to avoid overwriting custom format.
4132          foreach ( $format_args as $format_arg => $format_arg_value ) {
4133              unset( $url_query_args[ $format_arg ] );
4134          }
4135  
4136          $args['add_args'] = array_merge( $args['add_args'], urlencode_deep( $url_query_args ) );
4137      }
4138  
4139      // Who knows what else people pass in $args
4140      $total = (int) $args['total'];
4141      if ( $total < 2 ) {
4142          return;
4143      }
4144      $current  = (int) $args['current'];
4145      $end_size = (int) $args['end_size']; // Out of bounds?  Make it the default.
4146      if ( $end_size < 1 ) {
4147          $end_size = 1;
4148      }
4149      $mid_size = (int) $args['mid_size'];
4150      if ( $mid_size < 0 ) {
4151          $mid_size = 2;
4152      }
4153  
4154      $add_args   = $args['add_args'];
4155      $r          = '';
4156      $page_links = array();
4157      $dots       = false;
4158  
4159      if ( $args['prev_next'] && $current && 1 < $current ) :
4160          $link = str_replace( '%_%', 2 == $current ? '' : $args['format'], $args['base'] );
4161          $link = str_replace( '%#%', $current - 1, $link );
4162          if ( $add_args ) {
4163              $link = add_query_arg( $add_args, $link );
4164          }
4165          $link .= $args['add_fragment'];
4166  
4167          $page_links[] = sprintf(
4168              '<a class="prev page-numbers" href="%s">%s</a>',
4169              /**
4170               * Filters the paginated links for the given archive pages.
4171               *
4172               * @since 3.0.0
4173               *
4174               * @param string $link The paginated link URL.
4175               */
4176              esc_url( apply_filters( 'paginate_links', $link ) ),
4177              $args['prev_text']
4178          );
4179      endif;
4180  
4181      for ( $n = 1; $n <= $total; $n++ ) :
4182          if ( $n == $current ) :
4183              $page_links[] = sprintf(
4184                  '<span aria-current="%s" class="page-numbers current">%s</span>',
4185                  esc_attr( $args['aria_current'] ),
4186                  $args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number']
4187              );
4188  
4189              $dots = true;
4190          else :
4191              if ( $args['show_all'] || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :
4192                  $link = str_replace( '%_%', 1 == $n ? '' : $args['format'], $args['base'] );
4193                  $link = str_replace( '%#%', $n, $link );
4194                  if ( $add_args ) {
4195                      $link = add_query_arg( $add_args, $link );
4196                  }
4197                  $link .= $args['add_fragment'];
4198  
4199                  $page_links[] = sprintf(
4200                      '<a class="page-numbers" href="%s">%s</a>',
4201                      /** This filter is documented in wp-includes/general-template.php */
4202                      esc_url( apply_filters( 'paginate_links', $link ) ),
4203                      $args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number']
4204                  );
4205  
4206                  $dots = true;
4207              elseif ( $dots && ! $args['show_all'] ) :
4208                  $page_links[] = '<span class="page-numbers dots">' . __( '&hellip;' ) . '</span>';
4209  
4210                  $dots = false;
4211              endif;
4212          endif;
4213      endfor;
4214  
4215      if ( $args['prev_next'] && $current && $current < $total ) :
4216          $link = str_replace( '%_%', $args['format'], $args['base'] );
4217          $link = str_replace( '%#%', $current + 1, $link );
4218          if ( $add_args ) {
4219              $link = add_query_arg( $add_args, $link );
4220          }
4221          $link .= $args['add_fragment'];
4222  
4223          $page_links[] = sprintf(
4224              '<a class="next page-numbers" href="%s">%s</a>',
4225              /** This filter is documented in wp-includes/general-template.php */
4226              esc_url( apply_filters( 'paginate_links', $link ) ),
4227              $args['next_text']
4228          );
4229      endif;
4230  
4231      switch ( $args['type'] ) {
4232          case 'array':
4233              return $page_links;
4234  
4235          case 'list':
4236              $r .= "<ul class='page-numbers'>\n\t<li>";
4237              $r .= join( "</li>\n\t<li>", $page_links );
4238              $r .= "</li>\n</ul>\n";
4239              break;
4240  
4241          default:
4242              $r = join( "\n", $page_links );
4243              break;
4244      }
4245  
4246      return $r;
4247  }
4248  
4249  /**
4250   * Registers an admin color scheme css file.
4251   *
4252   * Allows a plugin to register a new admin color scheme. For example:
4253   *
4254   *     wp_admin_css_color( 'classic', __( 'Classic' ), admin_url( "css/colors-classic.css" ), array(
4255   *         '#07273E', '#14568A', '#D54E21', '#2683AE'
4256   *     ) );
4257   *
4258   * @since 2.5.0
4259   *
4260   * @global array $_wp_admin_css_colors
4261   *
4262   * @param string $key    The unique key for this theme.
4263   * @param string $name   The name of the theme.
4264   * @param string $url    The URL of the CSS file containing the color scheme.
4265   * @param array  $colors Optional. An array of CSS color definition strings which are used
4266   *                       to give the user a feel for the theme.
4267   * @param array  $icons {
4268   *     Optional. CSS color definitions used to color any SVG icons.
4269   *
4270   *     @type string $base    SVG icon base color.
4271   *     @type string $focus   SVG icon color on focus.
4272   *     @type string $current SVG icon color of current admin menu link.
4273   * }
4274   */
4275  function wp_admin_css_color( $key, $name, $url, $colors = array(), $icons = array() ) {
4276      global $_wp_admin_css_colors;
4277  
4278      if ( ! isset( $_wp_admin_css_colors ) ) {
4279          $_wp_admin_css_colors = array();
4280      }
4281  
4282      $_wp_admin_css_colors[ $key ] = (object) array(
4283          'name'        => $name,
4284          'url'         => $url,
4285          'colors'      => $colors,
4286          'icon_colors' => $icons,
4287      );
4288  }
4289  
4290  /**
4291   * Registers the default admin color schemes.
4292   *
4293   * Registers the initial set of eight color schemes in the Profile section
4294   * of the dashboard which allows for styling the admin menu and toolbar.
4295   *
4296   * @see wp_admin_css_color()
4297   *
4298   * @since 3.0.0
4299   */
4300  function register_admin_color_schemes() {
4301      $suffix  = is_rtl() ? '-rtl' : '';
4302      $suffix .= SCRIPT_DEBUG ? '' : '.min';
4303  
4304      wp_admin_css_color(
4305          'fresh',
4306          _x( 'Default', 'admin color scheme' ),
4307          false,
4308          array( '#222', '#333', '#0073aa', '#00a0d2' ),
4309          array(
4310              'base'    => '#a0a5aa',
4311              'focus'   => '#00a0d2',
4312              'current' => '#fff',
4313          )
4314      );
4315  
4316      // Other color schemes are not available when running out of src
4317      if ( false !== strpos( get_bloginfo( 'version' ), '-src' ) ) {
4318          return;
4319      }
4320  
4321      wp_admin_css_color(
4322          'light',
4323          _x( 'Light', 'admin color scheme' ),
4324          admin_url( "css/colors/light/colors$suffix.css" ),
4325          array( '#e5e5e5', '#999', '#d64e07', '#04a4cc' ),
4326          array(
4327              'base'    => '#999',
4328              'focus'   => '#ccc',
4329              'current' => '#ccc',
4330          )
4331      );
4332  
4333      wp_admin_css_color(
4334          'blue',
4335          _x( 'Blue', 'admin color scheme' ),
4336          admin_url( "css/colors/blue/colors$suffix.css" ),
4337          array( '#096484', '#4796b3', '#52accc', '#74B6CE' ),
4338          array(
4339              'base'    => '#e5f8ff',
4340              'focus'   => '#fff',
4341              'current' => '#fff',
4342          )
4343      );
4344  
4345      wp_admin_css_color(
4346          'midnight',
4347          _x( 'Midnight', 'admin color scheme' ),
4348          admin_url( "css/colors/midnight/colors$suffix.css" ),
4349          array( '#25282b', '#363b3f', '#69a8bb', '#e14d43' ),
4350          array(
4351              'base'    => '#f1f2f3',
4352              'focus'   => '#fff',
4353              'current' => '#fff',
4354          )
4355      );
4356  
4357      wp_admin_css_color(
4358          'sunrise',
4359          _x( 'Sunrise', 'admin color scheme' ),
4360          admin_url( "css/colors/sunrise/colors$suffix.css" ),
4361          array( '#b43c38', '#cf4944', '#dd823b', '#ccaf0b' ),
4362          array(
4363              'base'    => '#f3f1f1',
4364              'focus'   => '#fff',
4365              'current' => '#fff',
4366          )
4367      );
4368  
4369      wp_admin_css_color(
4370          'ectoplasm',
4371          _x( 'Ectoplasm', 'admin color scheme' ),
4372          admin_url( "css/colors/ectoplasm/colors$suffix.css" ),
4373          array( '#413256', '#523f6d', '#a3b745', '#d46f15' ),
4374          array(
4375              'base'    => '#ece6f6',
4376              'focus'   => '#fff',
4377              'current' => '#fff',
4378          )
4379      );
4380  
4381      wp_admin_css_color(
4382          'ocean',
4383          _x( 'Ocean', 'admin color scheme' ),
4384          admin_url( "css/colors/ocean/colors$suffix.css" ),
4385          array( '#627c83', '#738e96', '#9ebaa0', '#aa9d88' ),
4386          array(
4387              'base'    => '#f2fcff',
4388              'focus'   => '#fff',
4389              'current' => '#fff',
4390          )
4391      );
4392  
4393      wp_admin_css_color(
4394          'coffee',
4395          _x( 'Coffee', 'admin color scheme' ),
4396          admin_url( "css/colors/coffee/colors$suffix.css" ),
4397          array( '#46403c', '#59524c', '#c7a589', '#9ea476' ),
4398          array(
4399              'base'    => '#f3f2f1',
4400              'focus'   => '#fff',
4401              'current' => '#fff',
4402          )
4403      );
4404  
4405  }
4406  
4407  /**
4408   * Displays the URL of a WordPress admin CSS file.
4409   *
4410   * @see WP_Styles::_css_href and its {@see 'style_loader_src'} filter.
4411   *
4412   * @since 2.3.0
4413   *
4414   * @param string $file file relative to wp-admin/ without its ".css" extension.
4415   * @return string
4416   */
4417  function wp_admin_css_uri( $file = 'wp-admin' ) {
4418      if ( defined( 'WP_INSTALLING' ) ) {
4419          $_file = "./$file.css";
4420      } else {
4421          $_file = admin_url( "$file.css" );
4422      }
4423      $_file = add_query_arg( 'version', get_bloginfo( 'version' ), $_file );
4424  
4425      /**
4426       * Filters the URI of a WordPress admin CSS file.
4427       *
4428       * @since 2.3.0
4429       *
4430       * @param string $_file Relative path to the file with query arguments attached.
4431       * @param string $file  Relative path to the file, minus its ".css" extension.
4432       */
4433      return apply_filters( 'wp_admin_css_uri', $_file, $file );
4434  }
4435  
4436  /**
4437   * Enqueues or directly prints a stylesheet link to the specified CSS file.
4438   *
4439   * "Intelligently" decides to enqueue or to print the CSS file. If the
4440   * {@see 'wp_print_styles'} action has *not* yet been called, the CSS file will be
4441   * enqueued. If the {@see 'wp_print_styles'} action has been called, the CSS link will
4442   * be printed. Printing may be forced by passing true as the $force_echo
4443   * (second) parameter.
4444   *
4445   * For backward compatibility with WordPress 2.3 calling method: If the $file
4446   * (first) parameter does not correspond to a registered CSS file, we assume
4447   * $file is a file relative to wp-admin/ without its ".css" extension. A
4448   * stylesheet link to that generated URL is printed.
4449   *
4450   * @since 2.3.0
4451   *
4452   * @param string $file       Optional. Style handle name or file name (without ".css" extension) relative
4453   *                           to wp-admin/. Defaults to 'wp-admin'.
4454   * @param bool   $force_echo Optional. Force the stylesheet link to be printed rather than enqueued.
4455   */
4456  function wp_admin_css( $file = 'wp-admin', $force_echo = false ) {
4457      // For backward compatibility.
4458      $handle = 0 === strpos( $file, 'css/' ) ? substr( $file, 4 ) : $file;
4459  
4460      if ( wp_styles()->query( $handle ) ) {
4461          if ( $force_echo || did_action( 'wp_print_styles' ) ) {
4462              // We already printed the style queue. Print this one immediately.
4463              wp_print_styles( $handle );
4464          } else {
4465              // Add to style queue.
4466              wp_enqueue_style( $handle );
4467          }
4468          return;
4469      }
4470  
4471      $stylesheet_link = sprintf(
4472          "<link rel='stylesheet' href='%s' type='text/css' />\n",
4473          esc_url( wp_admin_css_uri( $file ) )
4474      );
4475  
4476      /**
4477       * Filters the stylesheet link to the specified CSS file.
4478       *
4479       * If the site is set to display right-to-left, the RTL stylesheet link
4480       * will be used instead.
4481       *
4482       * @since 2.3.0
4483       * @param string $stylesheet_link HTML link element for the stylesheet.
4484       * @param string $file            Style handle name or filename (without ".css" extension)
4485       *                                relative to wp-admin/. Defaults to 'wp-admin'.
4486       */
4487      echo apply_filters( 'wp_admin_css', $stylesheet_link, $file );
4488  
4489      if ( function_exists( 'is_rtl' ) && is_rtl() ) {
4490          $rtl_stylesheet_link = sprintf(
4491              "<link rel='stylesheet' href='%s' type='text/css' />\n",
4492              esc_url( wp_admin_css_uri( "$file-rtl" ) )
4493          );
4494  
4495          /** This filter is documented in wp-includes/general-template.php */
4496          echo apply_filters( 'wp_admin_css', $rtl_stylesheet_link, "$file-rtl" );
4497      }
4498  }
4499  
4500  /**
4501   * Enqueues the default ThickBox js and css.
4502   *
4503   * If any of the settings need to be changed, this can be done with another js
4504   * file similar to media-upload.js. That file should
4505   * require array('thickbox') to ensure it is loaded after.
4506   *
4507   * @since 2.5.0
4508   */
4509  function add_thickbox() {
4510      wp_enqueue_script( 'thickbox' );
4511      wp_enqueue_style( 'thickbox' );
4512  
4513      if ( is_network_admin() ) {
4514          add_action( 'admin_head', '_thickbox_path_admin_subfolder' );
4515      }
4516  }
4517  
4518  /**
4519   * Displays the XHTML generator that is generated on the wp_head hook.
4520   *
4521   * See {@see 'wp_head'}.
4522   *
4523   * @since 2.5.0
4524   */
4525  function wp_generator() {
4526      /**
4527       * Filters the output of the XHTML generator tag.
4528       *
4529       * @since 2.5.0
4530       *
4531       * @param string $generator_type The XHTML generator.
4532       */
4533      the_generator( apply_filters( 'wp_generator_type', 'xhtml' ) );
4534  }
4535  
4536  /**
4537   * Display the generator XML or Comment for RSS, ATOM, etc.
4538   *
4539   * Returns the correct generator type for the requested output format. Allows
4540   * for a plugin to filter generators overall the {@see 'the_generator'} filter.
4541   *
4542   * @since 2.5.0
4543   *
4544   * @param string $type The type of generator to output - (html|xhtml|atom|rss2|rdf|comment|export).
4545   */
4546  function the_generator( $type ) {
4547      /**
4548       * Filters the output of the XHTML generator tag for display.
4549       *
4550       * @since 2.5.0
4551       *
4552       * @param string $generator_type The generator output.
4553       * @param string $type           The type of generator to output. Accepts 'html',
4554       *                               'xhtml', 'atom', 'rss2', 'rdf', 'comment', 'export'.
4555       */
4556      echo apply_filters( 'the_generator', get_the_generator( $type ), $type ) . "\n";
4557  }
4558  
4559  /**
4560   * Creates the generator XML or Comment for RSS, ATOM, etc.
4561   *
4562   * Returns the correct generator type for the requested output format. Allows
4563   * for a plugin to filter generators on an individual basis using the
4564   * {@see 'get_the_generator_$type'} filter.
4565   *
4566   * @since 2.5.0
4567   *
4568   * @param string $type The type of generator to return - (html|xhtml|atom|rss2|rdf|comment|export).
4569   * @return string|void The HTML content for the generator.
4570   */
4571  function get_the_generator( $type = '' ) {
4572      if ( empty( $type ) ) {
4573  
4574          $current_filter = current_filter();
4575          if ( empty( $current_filter ) ) {
4576              return;
4577          }
4578  
4579          switch ( $current_filter ) {
4580              case 'rss2_head':
4581              case 'commentsrss2_head':
4582                  $type = 'rss2';
4583                  break;
4584              case 'rss_head':
4585              case 'opml_head':
4586                  $type = 'comment';
4587                  break;
4588              case 'rdf_header':
4589                  $type = 'rdf';
4590                  break;
4591              case 'atom_head':
4592              case 'comments_atom_head':
4593              case 'app_head':
4594                  $type = 'atom';
4595                  break;
4596          }
4597      }
4598  
4599      switch ( $type ) {
4600          case 'html':
4601              $gen = '<meta name="generator" content="WordPress ' . esc_attr( get_bloginfo( 'version' ) ) . '">';
4602              break;
4603          case 'xhtml':
4604              $gen = '<meta name="generator" content="WordPress ' . esc_attr( get_bloginfo( 'version' ) ) . '" />';
4605              break;
4606          case 'atom':
4607              $gen = '<generator uri="https://wordpress.org/" version="' . esc_attr( get_bloginfo_rss( 'version' ) ) . '">WordPress</generator>';
4608              break;
4609          case 'rss2':
4610              $gen = '<generator>' . esc_url_raw( 'https://wordpress.org/?v=' . get_bloginfo_rss( 'version' ) ) . '</generator>';
4611              break;
4612          case 'rdf':
4613              $gen = '<admin:generatorAgent rdf:resource="' . esc_url_raw( 'https://wordpress.org/?v=' . get_bloginfo_rss( 'version' ) ) . '" />';
4614              break;
4615          case 'comment':
4616              $gen = '<!-- generator="WordPress/' . esc_attr( get_bloginfo( 'version' ) ) . '" -->';
4617              break;
4618          case 'export':
4619              $gen = '<!-- generator="WordPress/' . esc_attr( get_bloginfo_rss( 'version' ) ) . '" created="' . gmdate( 'Y-m-d H:i' ) . '" -->';
4620              break;
4621      }
4622  
4623      /**
4624       * Filters the HTML for the retrieved generator type.
4625       *
4626       * The dynamic portion of the hook name, `$type`, refers to the generator type.
4627       *
4628       * @since 2.5.0
4629       *
4630       * @param string $gen  The HTML markup output to wp_head().
4631       * @param string $type The type of generator. Accepts 'html', 'xhtml', 'atom',
4632       *                     'rss2', 'rdf', 'comment', 'export'.
4633       */
4634      return apply_filters( "get_the_generator_{$type}", $gen, $type );
4635  }
4636  
4637  /**
4638   * Outputs the html checked attribute.
4639   *
4640   * Compares the first two arguments and if identical marks as checked
4641   *
4642   * @since 1.0.0
4643   *
4644   * @param mixed $checked One of the values to compare
4645   * @param mixed $current (true) The other value to compare if not just true
4646   * @param bool  $echo    Whether to echo or just return the string
4647   * @return string html attribute or empty string
4648   */
4649  function checked( $checked, $current = true, $echo = true ) {
4650      return __checked_selected_helper( $checked, $current, $echo, 'checked' );
4651  }
4652  
4653  /**
4654   * Outputs the html selected attribute.
4655   *
4656   * Compares the first two arguments and if identical marks as selected
4657   *
4658   * @since 1.0.0
4659   *
4660   * @param mixed $selected One of the values to compare
4661   * @param mixed $current  (true) The other value to compare if not just true
4662   * @param bool  $echo     Whether to echo or just return the string
4663   * @return string html attribute or empty string
4664   */
4665  function selected( $selected, $current = true, $echo = true ) {
4666      return __checked_selected_helper( $selected, $current, $echo, 'selected' );
4667  }
4668  
4669  /**
4670   * Outputs the html disabled attribute.
4671   *
4672   * Compares the first two arguments and if identical marks as disabled
4673   *
4674   * @since 3.0.0
4675   *
4676   * @param mixed $disabled One of the values to compare
4677   * @param mixed $current  (true) The other value to compare if not just true
4678   * @param bool  $echo     Whether to echo or just return the string
4679   * @return string html attribute or empty string
4680   */
4681  function disabled( $disabled, $current = true, $echo = true ) {
4682      return __checked_selected_helper( $disabled, $current, $echo, 'disabled' );
4683  }
4684  
4685  /**
4686   * Outputs the html readonly attribute.
4687   *
4688   * Compares the first two arguments and if identical marks as readonly
4689   *
4690   * @since 4.9.0
4691   *
4692   * @param mixed $readonly One of the values to compare
4693   * @param mixed $current  (true) The other value to compare if not just true
4694   * @param bool  $echo     Whether to echo or just return the string
4695   * @return string html attribute or empty string
4696   */
4697  function readonly( $readonly, $current = true, $echo = true ) {
4698      return __checked_selected_helper( $readonly, $current, $echo, 'readonly' );
4699  }
4700  
4701  /**
4702   * Private helper function for checked, selected, disabled and readonly.
4703   *
4704   * Compares the first two arguments and if identical marks as $type
4705   *
4706   * @since 2.8.0
4707   * @access private
4708   *
4709   * @param mixed  $helper  One of the values to compare
4710   * @param mixed  $current (true) The other value to compare if not just true
4711   * @param bool   $echo    Whether to echo or just return the string
4712   * @param string $type    The type of checked|selected|disabled|readonly we are doing
4713   * @return string html attribute or empty string
4714   */
4715  function __checked_selected_helper( $helper, $current, $echo, $type ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore
4716      if ( (string) $helper === (string) $current ) {
4717          $result = " $type='$type'";
4718      } else {
4719          $result = '';
4720      }
4721  
4722      if ( $echo ) {
4723          echo $result;
4724      }
4725  
4726      return $result;
4727  }
4728  
4729  /**
4730   * Default settings for heartbeat
4731   *
4732   * Outputs the nonce used in the heartbeat XHR
4733   *
4734   * @since 3.6.0
4735   *
4736   * @param array $settings
4737   * @return array $settings
4738   */
4739  function wp_heartbeat_settings( $settings ) {
4740      if ( ! is_admin() ) {
4741          $settings['ajaxurl'] = admin_url( 'admin-ajax.php', 'relative' );
4742      }
4743  
4744      if ( is_user_logged_in() ) {
4745          $settings['nonce'] = wp_create_nonce( 'heartbeat-nonce' );
4746      }
4747  
4748      return $settings;
4749  }