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