[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

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


Generated: Mon Jul 22 01:00:03 2019 Cross-referenced by PHPXref 0.7.1