wp-includes/general-template.php

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