[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

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


Generated: Mon Jun 17 08:20:02 2019 Cross-referenced by PHPXref 0.7