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