[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

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


Generated: Fri Dec 13 01:00:03 2019 Cross-referenced by PHPXref 0.7.1