| [ 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 $name The name of the specialized header. 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 $name The name of the specialized footer. 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 $name The name of the specialized sidebar. 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. 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 or null if 179 * 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 or an empty 200 * 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_front_page() && ! is_paged() ? ' 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 $prefix = ''; 1428 if ( ! empty( $title ) ) { 1429 $prefix = " $sep "; 1430 } 1431 1432 /** 1433 * Filters the parts of the page title. 1434 * 1435 * @since 4.0.0 1436 * 1437 * @param string[] $title_array Array of parts of the page title. 1438 */ 1439 $title_array = apply_filters( 'wp_title_parts', explode( $t_sep, $title ) ); 1440 1441 // Determines position of the separator and direction of the breadcrumb. 1442 if ( 'right' === $seplocation ) { // Separator on right, so reverse the order. 1443 $title_array = array_reverse( $title_array ); 1444 $title = implode( " $sep ", $title_array ) . $prefix; 1445 } else { 1446 $title = $prefix . implode( " $sep ", $title_array ); 1447 } 1448 1449 /** 1450 * Filters the text of the page title. 1451 * 1452 * @since 2.0.0 1453 * 1454 * @param string $title Page title. 1455 * @param string $sep Title separator. 1456 * @param string $seplocation Location of the separator (either 'left' or 'right'). 1457 */ 1458 $title = apply_filters( 'wp_title', $title, $sep, $seplocation ); 1459 1460 // Send it out. 1461 if ( $display ) { 1462 echo $title; 1463 } else { 1464 return $title; 1465 } 1466 } 1467 1468 /** 1469 * Displays or retrieves page title for post. 1470 * 1471 * This is optimized for single.php template file for displaying the post title. 1472 * 1473 * It does not support placing the separator after the title, but by leaving the 1474 * prefix parameter empty, you can set the title separator manually. The prefix 1475 * does not automatically place a space between the prefix, so if there should 1476 * be a space, the parameter value will need to have it at the end. 1477 * 1478 * @since 0.71 1479 * 1480 * @param string $prefix Optional. What to display before the title. 1481 * @param bool $display Optional. Whether to display or retrieve title. Default true. 1482 * @return string|void Title when retrieving. 1483 */ 1484 function single_post_title( $prefix = '', $display = true ) { 1485 $_post = get_queried_object(); 1486 1487 if ( ! isset( $_post->post_title ) ) { 1488 return; 1489 } 1490 1491 /** 1492 * Filters the page title for a single post. 1493 * 1494 * @since 0.71 1495 * 1496 * @param string $_post_title The single post page title. 1497 * @param WP_Post $_post The current post. 1498 */ 1499 $title = apply_filters( 'single_post_title', $_post->post_title, $_post ); 1500 if ( $display ) { 1501 echo $prefix . $title; 1502 } else { 1503 return $prefix . $title; 1504 } 1505 } 1506 1507 /** 1508 * Displays or retrieves title for a post type archive. 1509 * 1510 * This is optimized for archive.php and archive-{$post_type}.php template files 1511 * for displaying the title of the post type. 1512 * 1513 * @since 3.1.0 1514 * 1515 * @param string $prefix Optional. What to display before the title. 1516 * @param bool $display Optional. Whether to display or retrieve title. Default true. 1517 * @return string|void Title when retrieving, null when displaying or failure. 1518 */ 1519 function post_type_archive_title( $prefix = '', $display = true ) { 1520 if ( ! is_post_type_archive() ) { 1521 return; 1522 } 1523 1524 $post_type = get_query_var( 'post_type' ); 1525 if ( is_array( $post_type ) ) { 1526 $post_type = reset( $post_type ); 1527 } 1528 1529 $post_type_obj = get_post_type_object( $post_type ); 1530 1531 /** 1532 * Filters the post type archive title. 1533 * 1534 * @since 3.1.0 1535 * 1536 * @param string $post_type_name Post type 'name' label. 1537 * @param string $post_type Post type. 1538 */ 1539 $title = apply_filters( 'post_type_archive_title', $post_type_obj->labels->name, $post_type ); 1540 1541 if ( $display ) { 1542 echo $prefix . $title; 1543 } else { 1544 return $prefix . $title; 1545 } 1546 } 1547 1548 /** 1549 * Displays or retrieves page title for category archive. 1550 * 1551 * Useful for category template files for displaying the category page title. 1552 * The prefix does not automatically place a space between the prefix, so if 1553 * there should be a space, the parameter value will need to have it at the end. 1554 * 1555 * @since 0.71 1556 * 1557 * @param string $prefix Optional. What to display before the title. 1558 * @param bool $display Optional. Whether to display or retrieve title. Default true. 1559 * @return string|void Title when retrieving. 1560 */ 1561 function single_cat_title( $prefix = '', $display = true ) { 1562 return single_term_title( $prefix, $display ); 1563 } 1564 1565 /** 1566 * Displays or retrieves page title for tag post archive. 1567 * 1568 * Useful for tag template files for displaying the tag page title. The prefix 1569 * does not automatically place a space between the prefix, so if there should 1570 * be a space, the parameter value will need to have it at the end. 1571 * 1572 * @since 2.3.0 1573 * 1574 * @param string $prefix Optional. What to display before the title. 1575 * @param bool $display Optional. Whether to display or retrieve title. Default true. 1576 * @return string|void Title when retrieving. 1577 */ 1578 function single_tag_title( $prefix = '', $display = true ) { 1579 return single_term_title( $prefix, $display ); 1580 } 1581 1582 /** 1583 * Displays or retrieves page title for taxonomy term archive. 1584 * 1585 * Useful for taxonomy term template files for displaying the taxonomy term page title. 1586 * The prefix does not automatically place a space between the prefix, so if there should 1587 * be a space, the parameter value will need to have it at the end. 1588 * 1589 * @since 3.1.0 1590 * 1591 * @param string $prefix Optional. What to display before the title. 1592 * @param bool $display Optional. Whether to display or retrieve title. Default true. 1593 * @return string|void Title when retrieving. 1594 */ 1595 function single_term_title( $prefix = '', $display = true ) { 1596 $term = get_queried_object(); 1597 1598 if ( ! $term ) { 1599 return; 1600 } 1601 1602 if ( is_category() ) { 1603 /** 1604 * Filters the category archive page title. 1605 * 1606 * @since 2.0.10 1607 * 1608 * @param string $term_name Category name for archive being displayed. 1609 */ 1610 $term_name = apply_filters( 'single_cat_title', $term->name ); 1611 } elseif ( is_tag() ) { 1612 /** 1613 * Filters the tag archive page title. 1614 * 1615 * @since 2.3.0 1616 * 1617 * @param string $term_name Tag name for archive being displayed. 1618 */ 1619 $term_name = apply_filters( 'single_tag_title', $term->name ); 1620 } elseif ( is_tax() ) { 1621 /** 1622 * Filters the custom taxonomy archive page title. 1623 * 1624 * @since 3.1.0 1625 * 1626 * @param string $term_name Term name for archive being displayed. 1627 */ 1628 $term_name = apply_filters( 'single_term_title', $term->name ); 1629 } else { 1630 return; 1631 } 1632 1633 if ( empty( $term_name ) ) { 1634 return; 1635 } 1636 1637 if ( $display ) { 1638 echo $prefix . $term_name; 1639 } else { 1640 return $prefix . $term_name; 1641 } 1642 } 1643 1644 /** 1645 * Displays or retrieves page title for post archive based on date. 1646 * 1647 * Useful for when the template only needs to display the month and year, 1648 * if either are available. The prefix does not automatically place a space 1649 * between the prefix, so if there should be a space, the parameter value 1650 * will need to have it at the end. 1651 * 1652 * @since 0.71 1653 * 1654 * @global WP_Locale $wp_locale WordPress date and time locale object. 1655 * 1656 * @param string $prefix Optional. What to display before the title. 1657 * @param bool $display Optional. Whether to display or retrieve title. Default true. 1658 * @return string|false|void False if there's no valid title for the month. Title when retrieving. 1659 */ 1660 function single_month_title( $prefix = '', $display = true ) { 1661 global $wp_locale; 1662 1663 $m = get_query_var( 'm' ); 1664 $year = get_query_var( 'year' ); 1665 $monthnum = get_query_var( 'monthnum' ); 1666 1667 if ( ! empty( $monthnum ) && ! empty( $year ) ) { 1668 $my_year = $year; 1669 $my_month = $wp_locale->get_month( $monthnum ); 1670 } elseif ( ! empty( $m ) ) { 1671 $my_year = substr( $m, 0, 4 ); 1672 $my_month = $wp_locale->get_month( substr( $m, 4, 2 ) ); 1673 } 1674 1675 if ( empty( $my_month ) ) { 1676 return false; 1677 } 1678 1679 $result = $prefix . $my_month . $prefix . $my_year; 1680 1681 if ( ! $display ) { 1682 return $result; 1683 } 1684 echo $result; 1685 } 1686 1687 /** 1688 * Displays the archive title based on the queried object. 1689 * 1690 * @since 4.1.0 1691 * 1692 * @see get_the_archive_title() 1693 * 1694 * @param string $before Optional. Content to prepend to the title. Default empty. 1695 * @param string $after Optional. Content to append to the title. Default empty. 1696 */ 1697 function the_archive_title( $before = '', $after = '' ) { 1698 $title = get_the_archive_title(); 1699 1700 if ( ! empty( $title ) ) { 1701 echo $before . $title . $after; 1702 } 1703 } 1704 1705 /** 1706 * Retrieves the archive title based on the queried object. 1707 * 1708 * @since 4.1.0 1709 * @since 5.5.0 The title part is wrapped in a `<span>` element. 1710 * 1711 * @return string Archive title. 1712 */ 1713 function get_the_archive_title() { 1714 $title = __( 'Archives' ); 1715 $prefix = ''; 1716 1717 if ( is_category() ) { 1718 $title = single_cat_title( '', false ); 1719 $prefix = _x( 'Category:', 'category archive title prefix' ); 1720 } elseif ( is_tag() ) { 1721 $title = single_tag_title( '', false ); 1722 $prefix = _x( 'Tag:', 'tag archive title prefix' ); 1723 } elseif ( is_author() ) { 1724 $title = get_the_author(); 1725 $prefix = _x( 'Author:', 'author archive title prefix' ); 1726 } elseif ( is_year() ) { 1727 /* translators: See https://www.php.net/manual/datetime.format.php */ 1728 $title = get_the_date( _x( 'Y', 'yearly archives date format' ) ); 1729 $prefix = _x( 'Year:', 'date archive title prefix' ); 1730 } elseif ( is_month() ) { 1731 /* translators: See https://www.php.net/manual/datetime.format.php */ 1732 $title = get_the_date( _x( 'F Y', 'monthly archives date format' ) ); 1733 $prefix = _x( 'Month:', 'date archive title prefix' ); 1734 } elseif ( is_day() ) { 1735 /* translators: See https://www.php.net/manual/datetime.format.php */ 1736 $title = get_the_date( _x( 'F j, Y', 'daily archives date format' ) ); 1737 $prefix = _x( 'Day:', 'date archive title prefix' ); 1738 } elseif ( is_tax( 'post_format' ) ) { 1739 if ( is_tax( 'post_format', 'post-format-aside' ) ) { 1740 $title = _x( 'Asides', 'post format archive title' ); 1741 } elseif ( is_tax( 'post_format', 'post-format-gallery' ) ) { 1742 $title = _x( 'Galleries', 'post format archive title' ); 1743 } elseif ( is_tax( 'post_format', 'post-format-image' ) ) { 1744 $title = _x( 'Images', 'post format archive title' ); 1745 } elseif ( is_tax( 'post_format', 'post-format-video' ) ) { 1746 $title = _x( 'Videos', 'post format archive title' ); 1747 } elseif ( is_tax( 'post_format', 'post-format-quote' ) ) { 1748 $title = _x( 'Quotes', 'post format archive title' ); 1749 } elseif ( is_tax( 'post_format', 'post-format-link' ) ) { 1750 $title = _x( 'Links', 'post format archive title' ); 1751 } elseif ( is_tax( 'post_format', 'post-format-status' ) ) { 1752 $title = _x( 'Statuses', 'post format archive title' ); 1753 } elseif ( is_tax( 'post_format', 'post-format-audio' ) ) { 1754 $title = _x( 'Audio', 'post format archive title' ); 1755 } elseif ( is_tax( 'post_format', 'post-format-chat' ) ) { 1756 $title = _x( 'Chats', 'post format archive title' ); 1757 } 1758 } elseif ( is_post_type_archive() ) { 1759 $title = post_type_archive_title( '', false ); 1760 $prefix = _x( 'Archives:', 'post type archive title prefix' ); 1761 } elseif ( is_tax() ) { 1762 $queried_object = get_queried_object(); 1763 if ( $queried_object ) { 1764 $tax = get_taxonomy( $queried_object->taxonomy ); 1765 $title = single_term_title( '', false ); 1766 $prefix = sprintf( 1767 /* translators: %s: Taxonomy singular name. */ 1768 _x( '%s:', 'taxonomy term archive title prefix' ), 1769 $tax->labels->singular_name 1770 ); 1771 } 1772 } 1773 1774 $original_title = $title; 1775 1776 /** 1777 * Filters the archive title prefix. 1778 * 1779 * @since 5.5.0 1780 * 1781 * @param string $prefix Archive title prefix. 1782 */ 1783 $prefix = apply_filters( 'get_the_archive_title_prefix', $prefix ); 1784 if ( $prefix ) { 1785 $title = sprintf( 1786 /* translators: 1: Title prefix. 2: Title. */ 1787 _x( '%1$s %2$s', 'archive title' ), 1788 $prefix, 1789 '<span>' . $title . '</span>' 1790 ); 1791 } 1792 1793 /** 1794 * Filters the archive title. 1795 * 1796 * @since 4.1.0 1797 * @since 5.5.0 Added the `$prefix` and `$original_title` parameters. 1798 * 1799 * @param string $title Archive title to be displayed. 1800 * @param string $original_title Archive title without prefix. 1801 * @param string $prefix Archive title prefix. 1802 */ 1803 return apply_filters( 'get_the_archive_title', $title, $original_title, $prefix ); 1804 } 1805 1806 /** 1807 * Displays category, tag, term, or author description. 1808 * 1809 * @since 4.1.0 1810 * 1811 * @see get_the_archive_description() 1812 * 1813 * @param string $before Optional. Content to prepend to the description. Default empty. 1814 * @param string $after Optional. Content to append to the description. Default empty. 1815 */ 1816 function the_archive_description( $before = '', $after = '' ) { 1817 $description = get_the_archive_description(); 1818 if ( $description ) { 1819 echo $before . $description . $after; 1820 } 1821 } 1822 1823 /** 1824 * Retrieves the description for an author, post type, or term archive. 1825 * 1826 * @since 4.1.0 1827 * @since 4.7.0 Added support for author archives. 1828 * @since 4.9.0 Added support for post type archives. 1829 * 1830 * @see term_description() 1831 * 1832 * @return string Archive description. 1833 */ 1834 function get_the_archive_description() { 1835 if ( is_author() ) { 1836 $description = get_the_author_meta( 'description' ); 1837 } elseif ( is_post_type_archive() ) { 1838 $description = get_the_post_type_description(); 1839 } else { 1840 $description = term_description(); 1841 } 1842 1843 /** 1844 * Filters the archive description. 1845 * 1846 * @since 4.1.0 1847 * 1848 * @param string $description Archive description to be displayed. 1849 */ 1850 return apply_filters( 'get_the_archive_description', $description ); 1851 } 1852 1853 /** 1854 * Retrieves the description for a post type archive. 1855 * 1856 * @since 4.9.0 1857 * 1858 * @return string The post type description. 1859 */ 1860 function get_the_post_type_description() { 1861 $post_type = get_query_var( 'post_type' ); 1862 1863 if ( is_array( $post_type ) ) { 1864 $post_type = reset( $post_type ); 1865 } 1866 1867 $post_type_obj = get_post_type_object( $post_type ); 1868 1869 // Check if a description is set. 1870 if ( isset( $post_type_obj->description ) ) { 1871 $description = $post_type_obj->description; 1872 } else { 1873 $description = ''; 1874 } 1875 1876 /** 1877 * Filters the description for a post type archive. 1878 * 1879 * @since 4.9.0 1880 * 1881 * @param string $description The post type description. 1882 * @param WP_Post_Type $post_type_obj The post type object. 1883 */ 1884 return apply_filters( 'get_the_post_type_description', $description, $post_type_obj ); 1885 } 1886 1887 /** 1888 * Retrieves archive link content based on predefined or custom code. 1889 * 1890 * The format can be one of four styles. The 'link' for head element, 'option' 1891 * for use in the select element, 'html' for use in list (either ol or ul HTML 1892 * elements). Custom content is also supported using the before and after 1893 * parameters. 1894 * 1895 * The 'link' format uses the `<link>` HTML element with the **archives** 1896 * relationship. The before and after parameters are not used. The text 1897 * parameter is used to describe the link. 1898 * 1899 * The 'option' format uses the option HTML element for use in select element. 1900 * The value is the url parameter and the before and after parameters are used 1901 * between the text description. 1902 * 1903 * The 'html' format, which is the default, uses the li HTML element for use in 1904 * the list HTML elements. The before parameter is before the link and the after 1905 * parameter is after the closing link. 1906 * 1907 * The custom format uses the before parameter before the link ('a' HTML 1908 * element) and the after parameter after the closing link tag. If the above 1909 * three values for the format are not used, then custom format is assumed. 1910 * 1911 * @since 1.0.0 1912 * @since 5.2.0 Added the `$selected` parameter. 1913 * 1914 * @param string $url URL to archive. 1915 * @param string $text Archive text description. 1916 * @param string $format Optional. Can be 'link', 'option', 'html', or custom. Default 'html'. 1917 * @param string $before Optional. Content to prepend to the description. Default empty. 1918 * @param string $after Optional. Content to append to the description. Default empty. 1919 * @param bool $selected Optional. Set to true if the current page is the selected archive page. 1920 * @return string HTML link content for archive. 1921 */ 1922 function get_archives_link( $url, $text, $format = 'html', $before = '', $after = '', $selected = false ) { 1923 $text = wptexturize( $text ); 1924 $url = esc_url( $url ); 1925 $aria_current = $selected ? ' aria-current="page"' : ''; 1926 1927 if ( 'link' === $format ) { 1928 $link_html = "\t<link rel='archives' title='" . esc_attr( $text ) . "' href='$url' />\n"; 1929 } elseif ( 'option' === $format ) { 1930 $selected_attr = $selected ? " selected='selected'" : ''; 1931 $link_html = "\t<option value='$url'$selected_attr>$before $text $after</option>\n"; 1932 } elseif ( 'html' === $format ) { 1933 $link_html = "\t<li>$before<a href='$url'$aria_current>$text</a>$after</li>\n"; 1934 } else { // Custom. 1935 $link_html = "\t$before<a href='$url'$aria_current>$text</a>$after\n"; 1936 } 1937 1938 /** 1939 * Filters the archive link content. 1940 * 1941 * @since 2.6.0 1942 * @since 4.5.0 Added the `$url`, `$text`, `$format`, `$before`, and `$after` parameters. 1943 * @since 5.2.0 Added the `$selected` parameter. 1944 * 1945 * @param string $link_html The archive HTML link content. 1946 * @param string $url URL to archive. 1947 * @param string $text Archive text description. 1948 * @param string $format Link format. Can be 'link', 'option', 'html', or custom. 1949 * @param string $before Content to prepend to the description. 1950 * @param string $after Content to append to the description. 1951 * @param bool $selected True if the current page is the selected archive. 1952 */ 1953 return apply_filters( 'get_archives_link', $link_html, $url, $text, $format, $before, $after, $selected ); 1954 } 1955 1956 /** 1957 * Displays archive links based on type and format. 1958 * 1959 * @since 1.2.0 1960 * @since 4.4.0 The `$post_type` argument was added. 1961 * @since 5.2.0 The `$year`, `$monthnum`, `$day`, and `$w` arguments were added. 1962 * 1963 * @see get_archives_link() 1964 * 1965 * @global wpdb $wpdb WordPress database abstraction object. 1966 * @global WP_Locale $wp_locale WordPress date and time locale object. 1967 * 1968 * @param string|array $args { 1969 * Default archive links arguments. Optional. 1970 * 1971 * @type string $type Type of archive to retrieve. Accepts 'daily', 'weekly', 'monthly', 1972 * 'yearly', 'postbypost', or 'alpha'. Both 'postbypost' and 'alpha' 1973 * display the same archive link list as well as post titles instead 1974 * of displaying dates. The difference between the two is that 'alpha' 1975 * will order by post title and 'postbypost' will order by post date. 1976 * Default 'monthly'. 1977 * @type string|int $limit Number of links to limit the query to. Default empty (no limit). 1978 * @type string $format Format each link should take using the $before and $after args. 1979 * Accepts 'link' (`<link>` tag), 'option' (`<option>` tag), 'html' 1980 * (`<li>` tag), or a custom format, which generates a link anchor 1981 * with $before preceding and $after succeeding. Default 'html'. 1982 * @type string $before Markup to prepend to the beginning of each link. Default empty. 1983 * @type string $after Markup to append to the end of each link. Default empty. 1984 * @type bool $show_post_count Whether to display the post count alongside the link. Default false. 1985 * @type bool|int $echo Whether to echo or return the links list. Default 1|true to echo. 1986 * @type string $order Whether to use ascending or descending order. Accepts 'ASC', or 'DESC'. 1987 * Default 'DESC'. 1988 * @type string $post_type Post type. Default 'post'. 1989 * @type string $year Year. Default current year. 1990 * @type string $monthnum Month number. Default current month number. 1991 * @type string $day Day. Default current day. 1992 * @type string $w Week. Default current week. 1993 * } 1994 * @return void|string Void if 'echo' argument is true, archive links if 'echo' is false. 1995 */ 1996 function wp_get_archives( $args = '' ) { 1997 global $wpdb, $wp_locale; 1998 1999 $defaults = array( 2000 'type' => 'monthly', 2001 'limit' => '', 2002 'format' => 'html', 2003 'before' => '', 2004 'after' => '', 2005 'show_post_count' => false, 2006 'echo' => 1, 2007 'order' => 'DESC', 2008 'post_type' => 'post', 2009 'year' => get_query_var( 'year' ), 2010 'monthnum' => get_query_var( 'monthnum' ), 2011 'day' => get_query_var( 'day' ), 2012 'w' => get_query_var( 'w' ), 2013 ); 2014 2015 $parsed_args = wp_parse_args( $args, $defaults ); 2016 2017 $post_type_object = get_post_type_object( $parsed_args['post_type'] ); 2018 if ( ! is_post_type_viewable( $post_type_object ) ) { 2019 return; 2020 } 2021 2022 $parsed_args['post_type'] = $post_type_object->name; 2023 2024 if ( '' === $parsed_args['type'] ) { 2025 $parsed_args['type'] = 'monthly'; 2026 } 2027 2028 if ( ! empty( $parsed_args['limit'] ) ) { 2029 $parsed_args['limit'] = absint( $parsed_args['limit'] ); 2030 $parsed_args['limit'] = ' LIMIT ' . $parsed_args['limit']; 2031 } 2032 2033 $order = strtoupper( $parsed_args['order'] ); 2034 if ( 'ASC' !== $order ) { 2035 $order = 'DESC'; 2036 } 2037 2038 // This is what will separate dates on weekly archive links. 2039 $archive_week_separator = '–'; 2040 2041 $sql_where = $wpdb->prepare( "WHERE post_type = %s AND post_status = 'publish'", $parsed_args['post_type'] ); 2042 2043 /** 2044 * Filters the SQL WHERE clause for retrieving archives. 2045 * 2046 * @since 2.2.0 2047 * 2048 * @param string $sql_where Portion of SQL query containing the WHERE clause. 2049 * @param array $parsed_args An array of default arguments. 2050 */ 2051 $where = apply_filters( 'getarchives_where', $sql_where, $parsed_args ); 2052 2053 /** 2054 * Filters the SQL JOIN clause for retrieving archives. 2055 * 2056 * @since 2.2.0 2057 * 2058 * @param string $sql_join Portion of SQL query containing JOIN clause. 2059 * @param array $parsed_args An array of default arguments. 2060 */ 2061 $join = apply_filters( 'getarchives_join', '', $parsed_args ); 2062 2063 $output = ''; 2064 2065 $last_changed = wp_cache_get_last_changed( 'posts' ); 2066 2067 $limit = $parsed_args['limit']; 2068 2069 if ( 'monthly' === $parsed_args['type'] ) { 2070 $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"; 2071 $key = md5( $query ); 2072 $key = "wp_get_archives:$key:$last_changed"; 2073 $results = wp_cache_get( $key, 'post-queries' ); 2074 if ( ! $results ) { 2075 $results = $wpdb->get_results( $query ); 2076 wp_cache_set( $key, $results, 'post-queries' ); 2077 } 2078 if ( $results ) { 2079 $after = $parsed_args['after']; 2080 foreach ( (array) $results as $result ) { 2081 $url = get_month_link( $result->year, $result->month ); 2082 if ( 'post' !== $parsed_args['post_type'] ) { 2083 $url = add_query_arg( 'post_type', $parsed_args['post_type'], $url ); 2084 } 2085 /* translators: 1: Month name, 2: 4-digit year. */ 2086 $text = sprintf( __( '%1$s %2$d' ), $wp_locale->get_month( $result->month ), $result->year ); 2087 if ( $parsed_args['show_post_count'] ) { 2088 $parsed_args['after'] = ' (' . $result->posts . ')' . $after; 2089 } 2090 $selected = is_archive() && (string) $parsed_args['year'] === $result->year && (string) $parsed_args['monthnum'] === $result->month; 2091 $output .= get_archives_link( $url, $text, $parsed_args['format'], $parsed_args['before'], $parsed_args['after'], $selected ); 2092 } 2093 } 2094 } elseif ( 'yearly' === $parsed_args['type'] ) { 2095 $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"; 2096 $key = md5( $query ); 2097 $key = "wp_get_archives:$key:$last_changed"; 2098 $results = wp_cache_get( $key, 'post-queries' ); 2099 if ( ! $results ) { 2100 $results = $wpdb->get_results( $query ); 2101 wp_cache_set( $key, $results, 'post-queries' ); 2102 } 2103 if ( $results ) { 2104 $after = $parsed_args['after']; 2105 foreach ( (array) $results as $result ) { 2106 $url = get_year_link( $result->year ); 2107 if ( 'post' !== $parsed_args['post_type'] ) { 2108 $url = add_query_arg( 'post_type', $parsed_args['post_type'], $url ); 2109 } 2110 $text = sprintf( '%d', $result->year ); 2111 if ( $parsed_args['show_post_count'] ) { 2112 $parsed_args['after'] = ' (' . $result->posts . ')' . $after; 2113 } 2114 $selected = is_archive() && (string) $parsed_args['year'] === $result->year; 2115 $output .= get_archives_link( $url, $text, $parsed_args['format'], $parsed_args['before'], $parsed_args['after'], $selected ); 2116 } 2117 } 2118 } elseif ( 'daily' === $parsed_args['type'] ) { 2119 $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"; 2120 $key = md5( $query ); 2121 $key = "wp_get_archives:$key:$last_changed"; 2122 $results = wp_cache_get( $key, 'post-queries' ); 2123 if ( ! $results ) { 2124 $results = $wpdb->get_results( $query ); 2125 wp_cache_set( $key, $results, 'post-queries' ); 2126 } 2127 if ( $results ) { 2128 $after = $parsed_args['after']; 2129 foreach ( (array) $results as $result ) { 2130 $url = get_day_link( $result->year, $result->month, $result->dayofmonth ); 2131 if ( 'post' !== $parsed_args['post_type'] ) { 2132 $url = add_query_arg( 'post_type', $parsed_args['post_type'], $url ); 2133 } 2134 $date = sprintf( '%1$d-%2$02d-%3$02d 00:00:00', $result->year, $result->month, $result->dayofmonth ); 2135 $text = mysql2date( get_option( 'date_format' ), $date ); 2136 if ( $parsed_args['show_post_count'] ) { 2137 $parsed_args['after'] = ' (' . $result->posts . ')' . $after; 2138 } 2139 $selected = is_archive() && (string) $parsed_args['year'] === $result->year && (string) $parsed_args['monthnum'] === $result->month && (string) $parsed_args['day'] === $result->dayofmonth; 2140 $output .= get_archives_link( $url, $text, $parsed_args['format'], $parsed_args['before'], $parsed_args['after'], $selected ); 2141 } 2142 } 2143 } elseif ( 'weekly' === $parsed_args['type'] ) { 2144 $week = _wp_mysql_week( '`post_date`' ); 2145 $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"; 2146 $key = md5( $query ); 2147 $key = "wp_get_archives:$key:$last_changed"; 2148 $results = wp_cache_get( $key, 'post-queries' ); 2149 if ( ! $results ) { 2150 $results = $wpdb->get_results( $query ); 2151 wp_cache_set( $key, $results, 'post-queries' ); 2152 } 2153 $arc_w_last = ''; 2154 if ( $results ) { 2155 $after = $parsed_args['after']; 2156 foreach ( (array) $results as $result ) { 2157 if ( $result->week !== $arc_w_last ) { 2158 $arc_year = $result->yr; 2159 $arc_w_last = $result->week; 2160 $arc_week = get_weekstartend( $result->yyyymmdd, get_option( 'start_of_week' ) ); 2161 $arc_week_start = date_i18n( get_option( 'date_format' ), $arc_week['start'] ); 2162 $arc_week_end = date_i18n( get_option( 'date_format' ), $arc_week['end'] ); 2163 $url = add_query_arg( 2164 array( 2165 'm' => $arc_year, 2166 'w' => $result->week, 2167 ), 2168 home_url( '/' ) 2169 ); 2170 if ( 'post' !== $parsed_args['post_type'] ) { 2171 $url = add_query_arg( 'post_type', $parsed_args['post_type'], $url ); 2172 } 2173 $text = $arc_week_start . $archive_week_separator . $arc_week_end; 2174 if ( $parsed_args['show_post_count'] ) { 2175 $parsed_args['after'] = ' (' . $result->posts . ')' . $after; 2176 } 2177 $selected = is_archive() && (string) $parsed_args['year'] === $result->yr && (string) $parsed_args['w'] === $result->week; 2178 $output .= get_archives_link( $url, $text, $parsed_args['format'], $parsed_args['before'], $parsed_args['after'], $selected ); 2179 } 2180 } 2181 } 2182 } elseif ( ( 'postbypost' === $parsed_args['type'] ) || ( 'alpha' === $parsed_args['type'] ) ) { 2183 $orderby = ( 'alpha' === $parsed_args['type'] ) ? 'post_title ASC ' : 'post_date DESC, ID DESC '; 2184 $query = "SELECT * FROM $wpdb->posts $join $where ORDER BY $orderby $limit"; 2185 $key = md5( $query ); 2186 $key = "wp_get_archives:$key:$last_changed"; 2187 $results = wp_cache_get( $key, 'post-queries' ); 2188 if ( ! $results ) { 2189 $results = $wpdb->get_results( $query ); 2190 wp_cache_set( $key, $results, 'post-queries' ); 2191 } 2192 if ( $results ) { 2193 foreach ( (array) $results as $result ) { 2194 if ( '0000-00-00 00:00:00' !== $result->post_date ) { 2195 $url = get_permalink( $result ); 2196 if ( $result->post_title ) { 2197 /** This filter is documented in wp-includes/post-template.php */ 2198 $text = strip_tags( apply_filters( 'the_title', $result->post_title, $result->ID ) ); 2199 } else { 2200 $text = $result->ID; 2201 } 2202 $selected = get_the_ID() === $result->ID; 2203 $output .= get_archives_link( $url, $text, $parsed_args['format'], $parsed_args['before'], $parsed_args['after'], $selected ); 2204 } 2205 } 2206 } 2207 } 2208 2209 if ( $parsed_args['echo'] ) { 2210 echo $output; 2211 } else { 2212 return $output; 2213 } 2214 } 2215 2216 /** 2217 * Gets number of days since the start of the week. 2218 * 2219 * @since 1.5.0 2220 * 2221 * @param int $num Number of day. 2222 * @return float Days since the start of the week. 2223 */ 2224 function calendar_week_mod( $num ) { 2225 $base = 7; 2226 return ( $num - $base * floor( $num / $base ) ); 2227 } 2228 2229 /** 2230 * Displays calendar with days that have posts as links. 2231 * 2232 * The calendar is cached, which will be retrieved, if it exists. If there are 2233 * no posts for the month, then it will not be displayed. 2234 * 2235 * @since 1.0.0 2236 * @since 6.8.0 Added the `$args` parameter, with backward compatibility 2237 * for the replaced `$initial` and `$display` parameters. 2238 * 2239 * @global wpdb $wpdb WordPress database abstraction object. 2240 * @global int $m 2241 * @global int $monthnum 2242 * @global int $year 2243 * @global WP_Locale $wp_locale WordPress date and time locale object. 2244 * @global array $posts 2245 * 2246 * @param array $args { 2247 * Optional. Arguments for the `get_calendar` function. 2248 * 2249 * @type bool $initial Whether to use initial calendar names. Default true. 2250 * @type bool $display Whether to display the calendar output. Default true. 2251 * @type string $post_type Optional. Post type. Default 'post'. 2252 * } 2253 * @return void|string Void if `$display` argument is true, calendar HTML if `$display` is false. 2254 */ 2255 function get_calendar( $args = array() ) { 2256 global $wpdb, $m, $monthnum, $year, $wp_locale, $posts; 2257 2258 $defaults = array( 2259 'initial' => true, 2260 'display' => true, 2261 'post_type' => 'post', 2262 ); 2263 2264 $original_args = func_get_args(); 2265 $args = array(); 2266 2267 if ( ! empty( $original_args ) ) { 2268 if ( ! is_array( $original_args[0] ) ) { 2269 if ( isset( $original_args[0] ) && is_bool( $original_args[0] ) ) { 2270 $defaults['initial'] = $original_args[0]; 2271 } 2272 if ( isset( $original_args[1] ) && is_bool( $original_args[1] ) ) { 2273 $defaults['display'] = $original_args[1]; 2274 } 2275 } else { 2276 $args = $original_args[0]; 2277 } 2278 } 2279 2280 /** 2281 * Filter the `get_calendar` function arguments before they are used. 2282 * 2283 * @since 6.8.0 2284 * 2285 * @param array $args { 2286 * Optional. Arguments for the `get_calendar` function. 2287 * 2288 * @type bool $initial Whether to use initial calendar names. Default true. 2289 * @type bool $display Whether to display the calendar output. Default true. 2290 * @type string $post_type Optional. Post type. Default 'post'. 2291 * } 2292 * @return array The arguments for the `get_calendar` function. 2293 */ 2294 $args = apply_filters( 'get_calendar_args', wp_parse_args( $args, $defaults ) ); 2295 2296 if ( ! post_type_exists( $args['post_type'] ) ) { 2297 $args['post_type'] = 'post'; 2298 } 2299 2300 $w = 0; 2301 if ( isset( $_GET['w'] ) ) { 2302 $w = (int) $_GET['w']; 2303 } 2304 2305 /* 2306 * Normalize the cache key. 2307 * 2308 * The following ensures the same cache key is used for the same parameter 2309 * and parameter equivalents. This prevents `post_type > post, initial > true` 2310 * from generating a different key from the same values in the reverse order. 2311 * 2312 * `display` is excluded from the cache key as the cache contains the same 2313 * HTML regardless of this function's need to echo or return the output. 2314 * 2315 * The global values contain data generated by the URL query string variables. 2316 */ 2317 $cache_args = $args; 2318 unset( $cache_args['display'] ); 2319 2320 $cache_args['globals'] = array( 2321 'm' => $m, 2322 'monthnum' => $monthnum, 2323 'year' => $year, 2324 'week' => $w, 2325 ); 2326 2327 wp_recursive_ksort( $cache_args ); 2328 $key = md5( serialize( $cache_args ) ); 2329 $cache = wp_cache_get( 'get_calendar', 'calendar' ); 2330 2331 if ( $cache && is_array( $cache ) && isset( $cache[ $key ] ) ) { 2332 /** This filter is documented in wp-includes/general-template.php */ 2333 $output = apply_filters( 'get_calendar', $cache[ $key ], $args ); 2334 2335 if ( $args['display'] ) { 2336 echo $output; 2337 return; 2338 } 2339 2340 return $output; 2341 } 2342 2343 if ( ! is_array( $cache ) ) { 2344 $cache = array(); 2345 } 2346 2347 $post_type = $args['post_type']; 2348 2349 // Quick check. If we have no posts at all, abort! 2350 if ( ! $posts ) { 2351 $gotsome = $wpdb->get_var( 2352 $wpdb->prepare( 2353 "SELECT 1 as test 2354 FROM $wpdb->posts 2355 WHERE post_type = %s 2356 AND post_status = 'publish' 2357 LIMIT 1", 2358 $post_type 2359 ) 2360 ); 2361 2362 if ( ! $gotsome ) { 2363 $cache[ $key ] = ''; 2364 wp_cache_set( 'get_calendar', $cache, 'calendar' ); 2365 return; 2366 } 2367 } 2368 2369 // week_begins = 0 stands for Sunday. 2370 $week_begins = (int) get_option( 'start_of_week' ); 2371 2372 // Let's figure out when we are. 2373 if ( ! empty( $monthnum ) && ! empty( $year ) ) { 2374 $thismonth = (int) $monthnum; 2375 $thisyear = (int) $year; 2376 } elseif ( ! empty( $w ) ) { 2377 // We need to get the month from MySQL. 2378 $thisyear = (int) substr( $m, 0, 4 ); 2379 // It seems MySQL's weeks disagree with PHP's. 2380 $d = ( ( $w - 1 ) * 7 ) + 6; 2381 $thismonth = (int) $wpdb->get_var( 2382 $wpdb->prepare( 2383 "SELECT DATE_FORMAT((DATE_ADD('%d0101', INTERVAL %d DAY) ), '%%m')", 2384 $thisyear, 2385 $d 2386 ) 2387 ); 2388 } elseif ( ! empty( $m ) ) { 2389 $thisyear = (int) substr( $m, 0, 4 ); 2390 if ( strlen( $m ) < 6 ) { 2391 $thismonth = 1; 2392 } else { 2393 $thismonth = (int) substr( $m, 4, 2 ); 2394 } 2395 } else { 2396 $thisyear = (int) current_time( 'Y' ); 2397 $thismonth = (int) current_time( 'm' ); 2398 } 2399 2400 $unixmonth = mktime( 0, 0, 0, $thismonth, 1, $thisyear ); 2401 $last_day = gmdate( 't', $unixmonth ); 2402 2403 // Get the next and previous month and year with at least one post. 2404 $previous = $wpdb->get_row( 2405 $wpdb->prepare( 2406 "SELECT MONTH(post_date) AS month, YEAR(post_date) AS year 2407 FROM $wpdb->posts 2408 WHERE post_date < '%d-%d-01' 2409 AND post_type = %s AND post_status = 'publish' 2410 ORDER BY post_date DESC 2411 LIMIT 1", 2412 $thisyear, 2413 zeroise( $thismonth, 2 ), 2414 $post_type 2415 ) 2416 ); 2417 2418 $next = $wpdb->get_row( 2419 $wpdb->prepare( 2420 "SELECT MONTH(post_date) AS month, YEAR(post_date) AS year 2421 FROM $wpdb->posts 2422 WHERE post_date > '%d-%d-%d 23:59:59' 2423 AND post_type = %s AND post_status = 'publish' 2424 ORDER BY post_date ASC 2425 LIMIT 1", 2426 $thisyear, 2427 zeroise( $thismonth, 2 ), 2428 $last_day, 2429 $post_type 2430 ) 2431 ); 2432 2433 /* translators: Calendar caption: 1: Month name, 2: 4-digit year. */ 2434 $calendar_caption = _x( '%1$s %2$s', 'calendar caption' ); 2435 $calendar_output = '<table id="wp-calendar" class="wp-calendar-table"> 2436 <caption>' . sprintf( 2437 $calendar_caption, 2438 $wp_locale->get_month( $thismonth ), 2439 gmdate( 'Y', $unixmonth ) 2440 ) . '</caption> 2441 <thead> 2442 <tr>'; 2443 2444 $myweek = array(); 2445 2446 for ( $wdcount = 0; $wdcount <= 6; $wdcount++ ) { 2447 $myweek[] = $wp_locale->get_weekday( ( $wdcount + $week_begins ) % 7 ); 2448 } 2449 2450 foreach ( $myweek as $wd ) { 2451 $day_name = $args['initial'] ? $wp_locale->get_weekday_initial( $wd ) : $wp_locale->get_weekday_abbrev( $wd ); 2452 $wd = esc_attr( $wd ); 2453 $calendar_output .= "\n\t\t<th scope=\"col\" aria-label=\"$wd\">$day_name</th>"; 2454 } 2455 2456 $calendar_output .= ' 2457 </tr> 2458 </thead> 2459 <tbody> 2460 <tr>'; 2461 2462 $daywithpost = array(); 2463 2464 // Get days with posts. 2465 $dayswithposts = $wpdb->get_results( 2466 $wpdb->prepare( 2467 "SELECT DISTINCT DAYOFMONTH(post_date) 2468 FROM $wpdb->posts WHERE post_date >= '%d-%d-01 00:00:00' 2469 AND post_type = %s AND post_status = 'publish' 2470 AND post_date <= '%d-%d-%d 23:59:59'", 2471 $thisyear, 2472 zeroise( $thismonth, 2 ), 2473 $post_type, 2474 $thisyear, 2475 zeroise( $thismonth, 2 ), 2476 $last_day 2477 ), 2478 ARRAY_N 2479 ); 2480 2481 if ( $dayswithposts ) { 2482 foreach ( (array) $dayswithposts as $daywith ) { 2483 $daywithpost[] = (int) $daywith[0]; 2484 } 2485 } 2486 2487 // See how much we should pad in the beginning. 2488 $pad = calendar_week_mod( (int) gmdate( 'w', $unixmonth ) - $week_begins ); 2489 if ( $pad > 0 ) { 2490 $calendar_output .= "\n\t\t" . '<td colspan="' . esc_attr( $pad ) . '" class="pad"> </td>'; 2491 } 2492 2493 $newrow = false; 2494 $daysinmonth = (int) gmdate( 't', $unixmonth ); 2495 2496 for ( $day = 1; $day <= $daysinmonth; ++$day ) { 2497 if ( isset( $newrow ) && $newrow ) { 2498 $calendar_output .= "\n\t</tr>\n\t<tr>\n\t\t"; 2499 } 2500 2501 $newrow = false; 2502 2503 if ( (int) current_time( 'j' ) === $day 2504 && (int) current_time( 'm' ) === $thismonth 2505 && (int) current_time( 'Y' ) === $thisyear 2506 ) { 2507 $calendar_output .= '<td id="today">'; 2508 } else { 2509 $calendar_output .= '<td>'; 2510 } 2511 2512 if ( in_array( $day, $daywithpost, true ) ) { 2513 // Any posts today? 2514 $date_format = gmdate( _x( 'F j, Y', 'daily archives date format' ), strtotime( "{$thisyear}-{$thismonth}-{$day}" ) ); 2515 /* translators: Post calendar label. %s: Date. */ 2516 $label = sprintf( __( 'Posts published on %s' ), $date_format ); 2517 $calendar_output .= sprintf( 2518 '<a href="%s" aria-label="%s">%s</a>', 2519 get_day_link( $thisyear, $thismonth, $day ), 2520 esc_attr( $label ), 2521 $day 2522 ); 2523 } else { 2524 $calendar_output .= $day; 2525 } 2526 2527 $calendar_output .= '</td>'; 2528 2529 if ( 6 === (int) calendar_week_mod( (int) gmdate( 'w', mktime( 0, 0, 0, $thismonth, $day, $thisyear ) ) - $week_begins ) ) { 2530 $newrow = true; 2531 } 2532 } 2533 2534 $pad = 7 - calendar_week_mod( (int) gmdate( 'w', mktime( 0, 0, 0, $thismonth, $day, $thisyear ) ) - $week_begins ); 2535 if ( 0 < $pad && $pad < 7 ) { 2536 $calendar_output .= "\n\t\t" . '<td class="pad" colspan="' . esc_attr( $pad ) . '"> </td>'; 2537 } 2538 2539 $calendar_output .= "\n\t</tr>\n\t</tbody>"; 2540 2541 $calendar_output .= "\n\t</table>"; 2542 2543 $calendar_output .= '<nav aria-label="' . __( 'Previous and next months' ) . '" class="wp-calendar-nav">'; 2544 2545 if ( $previous ) { 2546 $calendar_output .= "\n\t\t" . sprintf( 2547 '<span class="wp-calendar-nav-prev"><a href="%1$s">« %2$s</a></span>', 2548 get_month_link( $previous->year, $previous->month ), 2549 $wp_locale->get_month_abbrev( $wp_locale->get_month( $previous->month ) ) 2550 ); 2551 } else { 2552 $calendar_output .= "\n\t\t" . '<span class="wp-calendar-nav-prev"> </span>'; 2553 } 2554 2555 $calendar_output .= "\n\t\t" . '<span class="pad"> </span>'; 2556 2557 if ( $next ) { 2558 $calendar_output .= "\n\t\t" . sprintf( 2559 '<span class="wp-calendar-nav-next"><a href="%1$s">%2$s »</a></span>', 2560 get_month_link( $next->year, $next->month ), 2561 $wp_locale->get_month_abbrev( $wp_locale->get_month( $next->month ) ) 2562 ); 2563 } else { 2564 $calendar_output .= "\n\t\t" . '<span class="wp-calendar-nav-next"> </span>'; 2565 } 2566 2567 $calendar_output .= ' 2568 </nav>'; 2569 2570 $cache[ $key ] = $calendar_output; 2571 wp_cache_set( 'get_calendar', $cache, 'calendar' ); 2572 2573 /** 2574 * Filters the HTML calendar output. 2575 * 2576 * @since 3.0.0 2577 * @since 6.8.0 Added the `$args` parameter. 2578 * 2579 * @param string $calendar_output HTML output of the calendar. 2580 * @param array $args { 2581 * Optional. Array of display arguments. 2582 * 2583 * @type bool $initial Whether to use initial calendar names. Default true. 2584 * @type bool $display Whether to display the calendar output. Default true. 2585 * @type string $post_type Optional. Post type. Default 'post'. 2586 * } 2587 */ 2588 $calendar_output = apply_filters( 'get_calendar', $calendar_output, $args ); 2589 2590 if ( $args['display'] ) { 2591 echo $calendar_output; 2592 return; 2593 } 2594 2595 return $calendar_output; 2596 } 2597 2598 /** 2599 * Purges the cached results of get_calendar. 2600 * 2601 * @see get_calendar() 2602 * @since 2.1.0 2603 */ 2604 function delete_get_calendar_cache() { 2605 wp_cache_delete( 'get_calendar', 'calendar' ); 2606 } 2607 2608 /** 2609 * Displays all of the allowed tags in HTML format with attributes. 2610 * 2611 * This is useful for displaying in the comment area, which elements and 2612 * attributes are supported. As well as any plugins which want to display it. 2613 * 2614 * @since 1.0.1 2615 * @since 4.4.0 No longer used in core. 2616 * 2617 * @global array $allowedtags 2618 * 2619 * @return string HTML allowed tags entity encoded. 2620 */ 2621 function allowed_tags() { 2622 global $allowedtags; 2623 $allowed = ''; 2624 foreach ( (array) $allowedtags as $tag => $attributes ) { 2625 $allowed .= '<' . $tag; 2626 if ( 0 < count( $attributes ) ) { 2627 foreach ( $attributes as $attribute => $limits ) { 2628 $allowed .= ' ' . $attribute . '=""'; 2629 } 2630 } 2631 $allowed .= '> '; 2632 } 2633 return htmlentities( $allowed ); 2634 } 2635 2636 /***** Date/Time tags */ 2637 2638 /** 2639 * Outputs the date in iso8601 format for xml files. 2640 * 2641 * @since 1.0.0 2642 */ 2643 function the_date_xml() { 2644 echo mysql2date( 'Y-m-d', get_post()->post_date, false ); 2645 } 2646 2647 /** 2648 * Displays or retrieves the date of the post (once per date). 2649 * 2650 * Will only output the date if the current post's date is different from the 2651 * previous one output. 2652 * 2653 * i.e. Only one date listing will show per day worth of posts shown in the loop, even if the 2654 * function is called several times for each post. 2655 * 2656 * HTML output can be filtered with {@see 'the_date'}. 2657 * Date string output can be filtered with {@see 'get_the_date'}. 2658 * 2659 * @since 0.71 2660 * 2661 * @global string $currentday The day of the current post in the loop. 2662 * @global string $previousday The day of the previous post in the loop. 2663 * 2664 * @param string $format Optional. PHP date format. Defaults to the 'date_format' option. 2665 * @param string $before Optional. Output before the date. Default empty. 2666 * @param string $after Optional. Output after the date. Default empty. 2667 * @param bool $display Optional. Whether to echo the date or return it. Default true. 2668 * @return string|void String if retrieving. 2669 */ 2670 function the_date( $format = '', $before = '', $after = '', $display = true ) { 2671 global $currentday, $previousday; 2672 2673 $the_date = ''; 2674 2675 if ( is_new_day() ) { 2676 $the_date = $before . get_the_date( $format ) . $after; 2677 $previousday = $currentday; 2678 } 2679 2680 /** 2681 * Filters the date of the post, for display. 2682 * 2683 * @since 0.71 2684 * 2685 * @param string $the_date The formatted date string. 2686 * @param string $format PHP date format. 2687 * @param string $before HTML output before the date. 2688 * @param string $after HTML output after the date. 2689 */ 2690 $the_date = apply_filters( 'the_date', $the_date, $format, $before, $after ); 2691 2692 if ( $display ) { 2693 echo $the_date; 2694 } else { 2695 return $the_date; 2696 } 2697 } 2698 2699 /** 2700 * Retrieves the date of the post. 2701 * 2702 * Unlike the_date() this function will always return the date. 2703 * Modify output with the {@see 'get_the_date'} filter. 2704 * 2705 * @since 3.0.0 2706 * 2707 * @param string $format Optional. PHP date format. Defaults to the 'date_format' option. 2708 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post. 2709 * @return string|int|false Date the current post was written. False on failure. 2710 */ 2711 function get_the_date( $format = '', $post = null ) { 2712 $post = get_post( $post ); 2713 2714 if ( ! $post ) { 2715 return false; 2716 } 2717 2718 $_format = ! empty( $format ) ? $format : get_option( 'date_format' ); 2719 2720 $the_date = get_post_time( $_format, false, $post, true ); 2721 2722 /** 2723 * Filters the date of the post. 2724 * 2725 * @since 3.0.0 2726 * 2727 * @param string|int $the_date Formatted date string or Unix timestamp if `$format` is 'U' or 'G'. 2728 * @param string $format PHP date format. 2729 * @param WP_Post $post The post object. 2730 */ 2731 return apply_filters( 'get_the_date', $the_date, $format, $post ); 2732 } 2733 2734 /** 2735 * Displays the date on which the post was last modified. 2736 * 2737 * @since 2.1.0 2738 * 2739 * @param string $format Optional. PHP date format. Defaults to the 'date_format' option. 2740 * @param string $before Optional. Output before the date. Default empty. 2741 * @param string $after Optional. Output after the date. Default empty. 2742 * @param bool $display Optional. Whether to echo the date or return it. Default true. 2743 * @return string|void String if retrieving. 2744 */ 2745 function the_modified_date( $format = '', $before = '', $after = '', $display = true ) { 2746 $the_modified_date = $before . get_the_modified_date( $format ) . $after; 2747 2748 /** 2749 * Filters the date a post was last modified, for display. 2750 * 2751 * @since 2.1.0 2752 * 2753 * @param string $the_modified_date The last modified date. 2754 * @param string $format PHP date format. 2755 * @param string $before HTML output before the date. 2756 * @param string $after HTML output after the date. 2757 */ 2758 $the_modified_date = apply_filters( 'the_modified_date', $the_modified_date, $format, $before, $after ); 2759 2760 if ( $display ) { 2761 echo $the_modified_date; 2762 } else { 2763 return $the_modified_date; 2764 } 2765 } 2766 2767 /** 2768 * Retrieves the date on which the post was last modified. 2769 * 2770 * @since 2.1.0 2771 * @since 4.6.0 Added the `$post` parameter. 2772 * 2773 * @param string $format Optional. PHP date format. Defaults to the 'date_format' option. 2774 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post. 2775 * @return string|int|false Date the current post was modified. False on failure. 2776 */ 2777 function get_the_modified_date( $format = '', $post = null ) { 2778 $post = get_post( $post ); 2779 2780 if ( ! $post ) { 2781 // For backward compatibility, failures go through the filter below. 2782 $the_time = false; 2783 } else { 2784 $_format = ! empty( $format ) ? $format : get_option( 'date_format' ); 2785 2786 $the_time = get_post_modified_time( $_format, false, $post, true ); 2787 } 2788 2789 /** 2790 * Filters the date a post was last modified. 2791 * 2792 * @since 2.1.0 2793 * @since 4.6.0 Added the `$post` parameter. 2794 * 2795 * @param string|int|false $the_time The formatted date or false if no post is found. 2796 * @param string $format PHP date format. 2797 * @param WP_Post|null $post WP_Post object or null if no post is found. 2798 */ 2799 return apply_filters( 'get_the_modified_date', $the_time, $format, $post ); 2800 } 2801 2802 /** 2803 * Displays the time of the post. 2804 * 2805 * @since 0.71 2806 * 2807 * @param string $format Optional. Format to use for retrieving the time the post 2808 * was written. Accepts 'G', 'U', or PHP date format. 2809 * Defaults to the 'time_format' option. 2810 */ 2811 function the_time( $format = '' ) { 2812 /** 2813 * Filters the time of the post, for display. 2814 * 2815 * @since 0.71 2816 * 2817 * @param string $get_the_time The formatted time. 2818 * @param string $format Format to use for retrieving the time the post 2819 * was written. Accepts 'G', 'U', or PHP date format. 2820 */ 2821 echo apply_filters( 'the_time', get_the_time( $format ), $format ); 2822 } 2823 2824 /** 2825 * Retrieves the time of the post. 2826 * 2827 * @since 1.5.0 2828 * 2829 * @param string $format Optional. Format to use for retrieving the time the post 2830 * was written. Accepts 'G', 'U', or PHP date format. 2831 * Defaults to the 'time_format' option. 2832 * @param int|WP_Post $post Post ID or post object. Default is global `$post` object. 2833 * @return string|int|false Formatted date string or Unix timestamp if `$format` is 'U' or 'G'. 2834 * False on failure. 2835 */ 2836 function get_the_time( $format = '', $post = null ) { 2837 $post = get_post( $post ); 2838 2839 if ( ! $post ) { 2840 return false; 2841 } 2842 2843 $_format = ! empty( $format ) ? $format : get_option( 'time_format' ); 2844 2845 $the_time = get_post_time( $_format, false, $post, true ); 2846 2847 /** 2848 * Filters the time of the post. 2849 * 2850 * @since 1.5.0 2851 * 2852 * @param string|int $the_time Formatted date string or Unix timestamp if `$format` is 'U' or 'G'. 2853 * @param string $format Format to use for retrieving the time the post 2854 * was written. Accepts 'G', 'U', or PHP date format. 2855 * @param WP_Post $post Post object. 2856 */ 2857 return apply_filters( 'get_the_time', $the_time, $format, $post ); 2858 } 2859 2860 /** 2861 * Retrieves the localized time of the post. 2862 * 2863 * @since 2.0.0 2864 * 2865 * @param string $format Optional. Format to use for retrieving the time the post 2866 * was written. Accepts 'G', 'U', or PHP date format. Default 'U'. 2867 * @param bool $gmt Optional. Whether to retrieve the GMT time. Default false. 2868 * @param int|WP_Post $post Post ID or post object. Default is global `$post` object. 2869 * @param bool $translate Whether to translate the time string. Default false. 2870 * @return string|int|false Formatted date string or Unix timestamp if `$format` is 'U' or 'G'. 2871 * False on failure. 2872 */ 2873 function get_post_time( $format = 'U', $gmt = false, $post = null, $translate = false ) { 2874 $post = get_post( $post ); 2875 2876 if ( ! $post ) { 2877 return false; 2878 } 2879 2880 $source = ( $gmt ) ? 'gmt' : 'local'; 2881 $datetime = get_post_datetime( $post, 'date', $source ); 2882 2883 if ( false === $datetime ) { 2884 return false; 2885 } 2886 2887 if ( 'U' === $format || 'G' === $format ) { 2888 $time = $datetime->getTimestamp(); 2889 2890 // Returns a sum of timestamp with timezone offset. Ideally should never be used. 2891 if ( ! $gmt ) { 2892 $time += $datetime->getOffset(); 2893 } 2894 } elseif ( $translate ) { 2895 $time = wp_date( $format, $datetime->getTimestamp(), $gmt ? new DateTimeZone( 'UTC' ) : null ); 2896 } else { 2897 if ( $gmt ) { 2898 $datetime = $datetime->setTimezone( new DateTimeZone( 'UTC' ) ); 2899 } 2900 2901 $time = $datetime->format( $format ); 2902 } 2903 2904 /** 2905 * Filters the localized time of the post. 2906 * 2907 * @since 2.6.0 2908 * 2909 * @param string|int $time Formatted date string or Unix timestamp if `$format` is 'U' or 'G'. 2910 * @param string $format Format to use for retrieving the date of the post. 2911 * Accepts 'G', 'U', or PHP date format. 2912 * @param bool $gmt Whether to retrieve the GMT time. 2913 */ 2914 return apply_filters( 'get_post_time', $time, $format, $gmt ); 2915 } 2916 2917 /** 2918 * Retrieves post published or modified time as a `DateTimeImmutable` object instance. 2919 * 2920 * The object will be set to the timezone from WordPress settings. 2921 * 2922 * For legacy reasons, this function allows to choose to instantiate from local or UTC time in database. 2923 * Normally this should make no difference to the result. However, the values might get out of sync in database, 2924 * typically because of timezone setting changes. The parameter ensures the ability to reproduce backwards 2925 * compatible behaviors in such cases. 2926 * 2927 * @since 5.3.0 2928 * 2929 * @param int|WP_Post $post Optional. Post ID or post object. Default is global `$post` object. 2930 * @param string $field Optional. Published or modified time to use from database. Accepts 'date' or 'modified'. 2931 * Default 'date'. 2932 * @param string $source Optional. Local or UTC time to use from database. Accepts 'local' or 'gmt'. 2933 * Default 'local'. 2934 * @return DateTimeImmutable|false Time object on success, false on failure. 2935 */ 2936 function get_post_datetime( $post = null, $field = 'date', $source = 'local' ) { 2937 $post = get_post( $post ); 2938 2939 if ( ! $post ) { 2940 return false; 2941 } 2942 2943 $wp_timezone = wp_timezone(); 2944 2945 if ( 'gmt' === $source ) { 2946 $time = ( 'modified' === $field ) ? $post->post_modified_gmt : $post->post_date_gmt; 2947 $timezone = new DateTimeZone( 'UTC' ); 2948 } else { 2949 $time = ( 'modified' === $field ) ? $post->post_modified : $post->post_date; 2950 $timezone = $wp_timezone; 2951 } 2952 2953 if ( empty( $time ) || '0000-00-00 00:00:00' === $time ) { 2954 return false; 2955 } 2956 2957 $datetime = date_create_immutable_from_format( 'Y-m-d H:i:s', $time, $timezone ); 2958 2959 if ( false === $datetime ) { 2960 return false; 2961 } 2962 2963 return $datetime->setTimezone( $wp_timezone ); 2964 } 2965 2966 /** 2967 * Retrieves post published or modified time as a Unix timestamp. 2968 * 2969 * Note that this function returns a true Unix timestamp, not summed with timezone offset 2970 * like older WP functions. 2971 * 2972 * @since 5.3.0 2973 * 2974 * @param int|WP_Post $post Optional. Post ID or post object. Default is global `$post` object. 2975 * @param string $field Optional. Published or modified time to use from database. Accepts 'date' or 'modified'. 2976 * Default 'date'. 2977 * @return int|false Unix timestamp on success, false on failure. 2978 */ 2979 function get_post_timestamp( $post = null, $field = 'date' ) { 2980 $datetime = get_post_datetime( $post, $field ); 2981 2982 if ( false === $datetime ) { 2983 return false; 2984 } 2985 2986 return $datetime->getTimestamp(); 2987 } 2988 2989 /** 2990 * Displays the time at which the post was last modified. 2991 * 2992 * @since 2.0.0 2993 * 2994 * @param string $format Optional. Format to use for retrieving the time the post 2995 * was modified. Accepts 'G', 'U', or PHP date format. 2996 * Defaults to the 'time_format' option. 2997 */ 2998 function the_modified_time( $format = '' ) { 2999 /** 3000 * Filters the localized time a post was last modified, for display. 3001 * 3002 * @since 2.0.0 3003 * 3004 * @param string|false $get_the_modified_time The formatted time or false if no post is found. 3005 * @param string $format Format to use for retrieving the time the post 3006 * was modified. Accepts 'G', 'U', or PHP date format. 3007 */ 3008 echo apply_filters( 'the_modified_time', get_the_modified_time( $format ), $format ); 3009 } 3010 3011 /** 3012 * Retrieves the time at which the post was last modified. 3013 * 3014 * @since 2.0.0 3015 * @since 4.6.0 Added the `$post` parameter. 3016 * 3017 * @param string $format Optional. Format to use for retrieving the time the post 3018 * was modified. Accepts 'G', 'U', or PHP date format. 3019 * Defaults to the 'time_format' option. 3020 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post. 3021 * @return string|int|false Formatted date string or Unix timestamp. False on failure. 3022 */ 3023 function get_the_modified_time( $format = '', $post = null ) { 3024 $post = get_post( $post ); 3025 3026 if ( ! $post ) { 3027 // For backward compatibility, failures go through the filter below. 3028 $the_time = false; 3029 } else { 3030 $_format = ! empty( $format ) ? $format : get_option( 'time_format' ); 3031 3032 $the_time = get_post_modified_time( $_format, false, $post, true ); 3033 } 3034 3035 /** 3036 * Filters the localized time a post was last modified. 3037 * 3038 * @since 2.0.0 3039 * @since 4.6.0 Added the `$post` parameter. 3040 * 3041 * @param string|int|false $the_time The formatted time or false if no post is found. 3042 * @param string $format Format to use for retrieving the time the post 3043 * was modified. Accepts 'G', 'U', or PHP date format. 3044 * @param WP_Post|null $post WP_Post object or null if no post is found. 3045 */ 3046 return apply_filters( 'get_the_modified_time', $the_time, $format, $post ); 3047 } 3048 3049 /** 3050 * Retrieves the time at which the post was last modified. 3051 * 3052 * @since 2.0.0 3053 * 3054 * @param string $format Optional. Format to use for retrieving the time the post 3055 * was modified. Accepts 'G', 'U', or PHP date format. Default 'U'. 3056 * @param bool $gmt Optional. Whether to retrieve the GMT time. Default false. 3057 * @param int|WP_Post $post Post ID or post object. Default is global `$post` object. 3058 * @param bool $translate Whether to translate the time string. Default false. 3059 * @return string|int|false Formatted date string or Unix timestamp if `$format` is 'U' or 'G'. 3060 * False on failure. 3061 */ 3062 function get_post_modified_time( $format = 'U', $gmt = false, $post = null, $translate = false ) { 3063 $post = get_post( $post ); 3064 3065 if ( ! $post ) { 3066 return false; 3067 } 3068 3069 $source = ( $gmt ) ? 'gmt' : 'local'; 3070 $datetime = get_post_datetime( $post, 'modified', $source ); 3071 3072 if ( false === $datetime ) { 3073 return false; 3074 } 3075 3076 if ( 'U' === $format || 'G' === $format ) { 3077 $time = $datetime->getTimestamp(); 3078 3079 // Returns a sum of timestamp with timezone offset. Ideally should never be used. 3080 if ( ! $gmt ) { 3081 $time += $datetime->getOffset(); 3082 } 3083 } elseif ( $translate ) { 3084 $time = wp_date( $format, $datetime->getTimestamp(), $gmt ? new DateTimeZone( 'UTC' ) : null ); 3085 } else { 3086 if ( $gmt ) { 3087 $datetime = $datetime->setTimezone( new DateTimeZone( 'UTC' ) ); 3088 } 3089 3090 $time = $datetime->format( $format ); 3091 } 3092 3093 /** 3094 * Filters the localized time a post was last modified. 3095 * 3096 * @since 2.8.0 3097 * 3098 * @param string|int $time Formatted date string or Unix timestamp if `$format` is 'U' or 'G'. 3099 * @param string $format Format to use for retrieving the time the post was modified. 3100 * Accepts 'G', 'U', or PHP date format. Default 'U'. 3101 * @param bool $gmt Whether to retrieve the GMT time. Default false. 3102 */ 3103 return apply_filters( 'get_post_modified_time', $time, $format, $gmt ); 3104 } 3105 3106 /** 3107 * Displays the localized weekday for the post. 3108 * 3109 * @since 0.71 3110 * 3111 * @global WP_Locale $wp_locale WordPress date and time locale object. 3112 */ 3113 function the_weekday() { 3114 global $wp_locale; 3115 3116 $post = get_post(); 3117 3118 if ( ! $post ) { 3119 return; 3120 } 3121 3122 $the_weekday = $wp_locale->get_weekday( get_post_time( 'w', false, $post ) ); 3123 3124 /** 3125 * Filters the localized weekday of the post, for display. 3126 * 3127 * @since 0.71 3128 * 3129 * @param string $the_weekday 3130 */ 3131 echo apply_filters( 'the_weekday', $the_weekday ); 3132 } 3133 3134 /** 3135 * Displays the localized weekday for the post. 3136 * 3137 * Will only output the weekday if the current post's weekday is different from 3138 * the previous one output. 3139 * 3140 * @since 0.71 3141 * 3142 * @global WP_Locale $wp_locale WordPress date and time locale object. 3143 * @global string $currentday The day of the current post in the loop. 3144 * @global string $previousweekday The day of the previous post in the loop. 3145 * 3146 * @param string $before Optional. Output before the date. Default empty. 3147 * @param string $after Optional. Output after the date. Default empty. 3148 */ 3149 function the_weekday_date( $before = '', $after = '' ) { 3150 global $wp_locale, $currentday, $previousweekday; 3151 3152 $post = get_post(); 3153 3154 if ( ! $post ) { 3155 return; 3156 } 3157 3158 $the_weekday_date = ''; 3159 3160 if ( $currentday !== $previousweekday ) { 3161 $the_weekday_date .= $before; 3162 $the_weekday_date .= $wp_locale->get_weekday( get_post_time( 'w', false, $post ) ); 3163 $the_weekday_date .= $after; 3164 $previousweekday = $currentday; 3165 } 3166 3167 /** 3168 * Filters the localized weekday of the post, for display. 3169 * 3170 * @since 0.71 3171 * 3172 * @param string $the_weekday_date The weekday on which the post was written. 3173 * @param string $before The HTML to output before the date. 3174 * @param string $after The HTML to output after the date. 3175 */ 3176 echo apply_filters( 'the_weekday_date', $the_weekday_date, $before, $after ); 3177 } 3178 3179 /** 3180 * Fires the wp_head action. 3181 * 3182 * See {@see 'wp_head'}. 3183 * 3184 * @since 1.2.0 3185 */ 3186 function wp_head() { 3187 /** 3188 * Prints scripts or data in the head tag on the front end. 3189 * 3190 * @since 1.5.0 3191 */ 3192 do_action( 'wp_head' ); 3193 } 3194 3195 /** 3196 * Fires the wp_footer action. 3197 * 3198 * See {@see 'wp_footer'}. 3199 * 3200 * @since 1.5.1 3201 */ 3202 function wp_footer() { 3203 /** 3204 * Prints scripts or data before the closing body tag on the front end. 3205 * 3206 * @since 1.5.1 3207 */ 3208 do_action( 'wp_footer' ); 3209 } 3210 3211 /** 3212 * Fires the wp_body_open action. 3213 * 3214 * See {@see 'wp_body_open'}. 3215 * 3216 * @since 5.2.0 3217 */ 3218 function wp_body_open() { 3219 /** 3220 * Triggered after the opening body tag. 3221 * 3222 * @since 5.2.0 3223 */ 3224 do_action( 'wp_body_open' ); 3225 } 3226 3227 /** 3228 * Displays the links to the general feeds. 3229 * 3230 * @since 2.8.0 3231 * 3232 * @param array $args Optional arguments. 3233 */ 3234 function feed_links( $args = array() ) { 3235 if ( ! current_theme_supports( 'automatic-feed-links' ) ) { 3236 return; 3237 } 3238 3239 $defaults = array( 3240 /* translators: Separator between site name and feed type in feed links. */ 3241 'separator' => _x( '»', 'feed link' ), 3242 /* translators: 1: Site title, 2: Separator (raquo). */ 3243 'feedtitle' => __( '%1$s %2$s Feed' ), 3244 /* translators: 1: Site title, 2: Separator (raquo). */ 3245 'comstitle' => __( '%1$s %2$s Comments Feed' ), 3246 ); 3247 3248 $args = wp_parse_args( $args, $defaults ); 3249 3250 /** 3251 * Filters the feed links arguments. 3252 * 3253 * @since 6.7.0 3254 * 3255 * @param array $args An array of feed links arguments. 3256 */ 3257 $args = apply_filters( 'feed_links_args', $args ); 3258 3259 /** 3260 * Filters whether to display the posts feed link. 3261 * 3262 * @since 4.4.0 3263 * 3264 * @param bool $show Whether to display the posts feed link. Default true. 3265 */ 3266 if ( apply_filters( 'feed_links_show_posts_feed', true ) ) { 3267 printf( 3268 '<link rel="alternate" type="%s" title="%s" href="%s" />' . "\n", 3269 feed_content_type(), 3270 esc_attr( sprintf( $args['feedtitle'], get_bloginfo( 'name' ), $args['separator'] ) ), 3271 esc_url( get_feed_link() ) 3272 ); 3273 } 3274 3275 /** 3276 * Filters whether to display the comments feed link. 3277 * 3278 * @since 4.4.0 3279 * 3280 * @param bool $show Whether to display the comments feed link. Default true. 3281 */ 3282 if ( apply_filters( 'feed_links_show_comments_feed', true ) ) { 3283 printf( 3284 '<link rel="alternate" type="%s" title="%s" href="%s" />' . "\n", 3285 feed_content_type(), 3286 esc_attr( sprintf( $args['comstitle'], get_bloginfo( 'name' ), $args['separator'] ) ), 3287 esc_url( get_feed_link( 'comments_' . get_default_feed() ) ) 3288 ); 3289 } 3290 } 3291 3292 /** 3293 * Displays the links to the extra feeds such as category feeds. 3294 * 3295 * @since 2.8.0 3296 * 3297 * @param array $args Optional arguments. 3298 */ 3299 function feed_links_extra( $args = array() ) { 3300 $defaults = array( 3301 /* translators: Separator between site name and feed type in feed links. */ 3302 'separator' => _x( '»', 'feed link' ), 3303 /* translators: 1: Site name, 2: Separator (raquo), 3: Post title. */ 3304 'singletitle' => __( '%1$s %2$s %3$s Comments Feed' ), 3305 /* translators: 1: Site name, 2: Separator (raquo), 3: Category name. */ 3306 'cattitle' => __( '%1$s %2$s %3$s Category Feed' ), 3307 /* translators: 1: Site name, 2: Separator (raquo), 3: Tag name. */ 3308 'tagtitle' => __( '%1$s %2$s %3$s Tag Feed' ), 3309 /* translators: 1: Site name, 2: Separator (raquo), 3: Term name, 4: Taxonomy singular name. */ 3310 'taxtitle' => __( '%1$s %2$s %3$s %4$s Feed' ), 3311 /* translators: 1: Site name, 2: Separator (raquo), 3: Author name. */ 3312 'authortitle' => __( '%1$s %2$s Posts by %3$s Feed' ), 3313 /* translators: 1: Site name, 2: Separator (raquo), 3: Search query. */ 3314 'searchtitle' => __( '%1$s %2$s Search Results for “%3$s” Feed' ), 3315 /* translators: 1: Site name, 2: Separator (raquo), 3: Post type name. */ 3316 'posttypetitle' => __( '%1$s %2$s %3$s Feed' ), 3317 ); 3318 3319 $args = wp_parse_args( $args, $defaults ); 3320 3321 /** 3322 * Filters the extra feed links arguments. 3323 * 3324 * @since 6.7.0 3325 * 3326 * @param array $args An array of extra feed links arguments. 3327 */ 3328 $args = apply_filters( 'feed_links_extra_args', $args ); 3329 3330 if ( is_singular() ) { 3331 $id = 0; 3332 $post = get_post( $id ); 3333 3334 /** This filter is documented in wp-includes/general-template.php */ 3335 $show_comments_feed = apply_filters( 'feed_links_show_comments_feed', true ); 3336 3337 /** 3338 * Filters whether to display the post comments feed link. 3339 * 3340 * This filter allows to enable or disable the feed link for a singular post 3341 * in a way that is independent of {@see 'feed_links_show_comments_feed'} 3342 * (which controls the global comments feed). The result of that filter 3343 * is accepted as a parameter. 3344 * 3345 * @since 6.1.0 3346 * 3347 * @param bool $show_comments_feed Whether to display the post comments feed link. Defaults to 3348 * the {@see 'feed_links_show_comments_feed'} filter result. 3349 */ 3350 $show_post_comments_feed = apply_filters( 'feed_links_extra_show_post_comments_feed', $show_comments_feed ); 3351 3352 if ( $show_post_comments_feed && ( comments_open() || pings_open() || $post->comment_count > 0 ) ) { 3353 $title = sprintf( 3354 $args['singletitle'], 3355 get_bloginfo( 'name' ), 3356 $args['separator'], 3357 the_title_attribute( array( 'echo' => false ) ) 3358 ); 3359 3360 $feed_link = get_post_comments_feed_link( $post->ID ); 3361 3362 if ( $feed_link ) { 3363 $href = $feed_link; 3364 } 3365 } 3366 } elseif ( is_post_type_archive() ) { 3367 /** 3368 * Filters whether to display the post type archive feed link. 3369 * 3370 * @since 6.1.0 3371 * 3372 * @param bool $show Whether to display the post type archive feed link. Default true. 3373 */ 3374 $show_post_type_archive_feed = apply_filters( 'feed_links_extra_show_post_type_archive_feed', true ); 3375 3376 if ( $show_post_type_archive_feed ) { 3377 $post_type = get_query_var( 'post_type' ); 3378 3379 if ( is_array( $post_type ) ) { 3380 $post_type = reset( $post_type ); 3381 } 3382 3383 $post_type_obj = get_post_type_object( $post_type ); 3384 3385 $title = sprintf( 3386 $args['posttypetitle'], 3387 get_bloginfo( 'name' ), 3388 $args['separator'], 3389 $post_type_obj->labels->name 3390 ); 3391 3392 $href = get_post_type_archive_feed_link( $post_type_obj->name ); 3393 } 3394 } elseif ( is_category() ) { 3395 /** 3396 * Filters whether to display the category feed link. 3397 * 3398 * @since 6.1.0 3399 * 3400 * @param bool $show Whether to display the category feed link. Default true. 3401 */ 3402 $show_category_feed = apply_filters( 'feed_links_extra_show_category_feed', true ); 3403 3404 if ( $show_category_feed ) { 3405 $term = get_queried_object(); 3406 3407 if ( $term ) { 3408 $title = sprintf( 3409 $args['cattitle'], 3410 get_bloginfo( 'name' ), 3411 $args['separator'], 3412 $term->name 3413 ); 3414 3415 $href = get_category_feed_link( $term->term_id ); 3416 } 3417 } 3418 } elseif ( is_tag() ) { 3419 /** 3420 * Filters whether to display the tag feed link. 3421 * 3422 * @since 6.1.0 3423 * 3424 * @param bool $show Whether to display the tag feed link. Default true. 3425 */ 3426 $show_tag_feed = apply_filters( 'feed_links_extra_show_tag_feed', true ); 3427 3428 if ( $show_tag_feed ) { 3429 $term = get_queried_object(); 3430 3431 if ( $term ) { 3432 $title = sprintf( 3433 $args['tagtitle'], 3434 get_bloginfo( 'name' ), 3435 $args['separator'], 3436 $term->name 3437 ); 3438 3439 $href = get_tag_feed_link( $term->term_id ); 3440 } 3441 } 3442 } elseif ( is_tax() ) { 3443 /** 3444 * Filters whether to display the custom taxonomy feed link. 3445 * 3446 * @since 6.1.0 3447 * 3448 * @param bool $show Whether to display the custom taxonomy feed link. Default true. 3449 */ 3450 $show_tax_feed = apply_filters( 'feed_links_extra_show_tax_feed', true ); 3451 3452 if ( $show_tax_feed ) { 3453 $term = get_queried_object(); 3454 3455 if ( $term ) { 3456 $tax = get_taxonomy( $term->taxonomy ); 3457 3458 $title = sprintf( 3459 $args['taxtitle'], 3460 get_bloginfo( 'name' ), 3461 $args['separator'], 3462 $term->name, 3463 $tax->labels->singular_name 3464 ); 3465 3466 $href = get_term_feed_link( $term->term_id, $term->taxonomy ); 3467 } 3468 } 3469 } elseif ( is_author() ) { 3470 /** 3471 * Filters whether to display the author feed link. 3472 * 3473 * @since 6.1.0 3474 * 3475 * @param bool $show Whether to display the author feed link. Default true. 3476 */ 3477 $show_author_feed = apply_filters( 'feed_links_extra_show_author_feed', true ); 3478 3479 if ( $show_author_feed ) { 3480 $author_id = (int) get_query_var( 'author' ); 3481 3482 $title = sprintf( 3483 $args['authortitle'], 3484 get_bloginfo( 'name' ), 3485 $args['separator'], 3486 get_the_author_meta( 'display_name', $author_id ) 3487 ); 3488 3489 $href = get_author_feed_link( $author_id ); 3490 } 3491 } elseif ( is_search() ) { 3492 /** 3493 * Filters whether to display the search results feed link. 3494 * 3495 * @since 6.1.0 3496 * 3497 * @param bool $show Whether to display the search results feed link. Default true. 3498 */ 3499 $show_search_feed = apply_filters( 'feed_links_extra_show_search_feed', true ); 3500 3501 if ( $show_search_feed ) { 3502 $title = sprintf( 3503 $args['searchtitle'], 3504 get_bloginfo( 'name' ), 3505 $args['separator'], 3506 get_search_query( false ) 3507 ); 3508 3509 $href = get_search_feed_link(); 3510 } 3511 } 3512 3513 if ( isset( $title ) && isset( $href ) ) { 3514 printf( 3515 '<link rel="alternate" type="%s" title="%s" href="%s" />' . "\n", 3516 feed_content_type(), 3517 esc_attr( $title ), 3518 esc_url( $href ) 3519 ); 3520 } 3521 } 3522 3523 /** 3524 * Displays the link to the Really Simple Discovery service endpoint. 3525 * 3526 * @link http://archipelago.phrasewise.com/rsd 3527 * @since 2.0.0 3528 */ 3529 function rsd_link() { 3530 printf( 3531 '<link rel="EditURI" type="application/rsd+xml" title="RSD" href="%s" />' . "\n", 3532 esc_url( site_url( 'xmlrpc.php?rsd', 'rpc' ) ) 3533 ); 3534 } 3535 3536 /** 3537 * Displays a referrer `strict-origin-when-cross-origin` meta tag. 3538 * 3539 * Outputs a referrer `strict-origin-when-cross-origin` meta tag that tells the browser not to send 3540 * the full URL as a referrer to other sites when cross-origin assets are loaded. 3541 * 3542 * Typical usage is as a {@see 'wp_head'} callback: 3543 * 3544 * add_action( 'wp_head', 'wp_strict_cross_origin_referrer' ); 3545 * 3546 * @since 5.7.0 3547 */ 3548 function wp_strict_cross_origin_referrer() { 3549 ?> 3550 <meta name='referrer' content='strict-origin-when-cross-origin' /> 3551 <?php 3552 } 3553 3554 /** 3555 * Displays site icon meta tags. 3556 * 3557 * @since 4.3.0 3558 * 3559 * @link https://www.whatwg.org/specs/web-apps/current-work/multipage/links.html#rel-icon HTML5 specification link icon. 3560 */ 3561 function wp_site_icon() { 3562 if ( ! has_site_icon() && ! is_customize_preview() ) { 3563 return; 3564 } 3565 3566 $meta_tags = array(); 3567 $icon_32 = get_site_icon_url( 32 ); 3568 if ( empty( $icon_32 ) && is_customize_preview() ) { 3569 $icon_32 = '/favicon.ico'; // Serve default favicon URL in customizer so element can be updated for preview. 3570 } 3571 if ( $icon_32 ) { 3572 $meta_tags[] = sprintf( '<link rel="icon" href="%s" sizes="32x32" />', esc_url( $icon_32 ) ); 3573 } 3574 $icon_192 = get_site_icon_url( 192 ); 3575 if ( $icon_192 ) { 3576 $meta_tags[] = sprintf( '<link rel="icon" href="%s" sizes="192x192" />', esc_url( $icon_192 ) ); 3577 } 3578 $icon_180 = get_site_icon_url( 180 ); 3579 if ( $icon_180 ) { 3580 $meta_tags[] = sprintf( '<link rel="apple-touch-icon" href="%s" />', esc_url( $icon_180 ) ); 3581 } 3582 $icon_270 = get_site_icon_url( 270 ); 3583 if ( $icon_270 ) { 3584 $meta_tags[] = sprintf( '<meta name="msapplication-TileImage" content="%s" />', esc_url( $icon_270 ) ); 3585 } 3586 3587 /** 3588 * Filters the site icon meta tags, so plugins can add their own. 3589 * 3590 * @since 4.3.0 3591 * 3592 * @param string[] $meta_tags Array of Site Icon meta tags. 3593 */ 3594 $meta_tags = apply_filters( 'site_icon_meta_tags', $meta_tags ); 3595 $meta_tags = array_filter( $meta_tags ); 3596 3597 foreach ( $meta_tags as $meta_tag ) { 3598 echo "$meta_tag\n"; 3599 } 3600 } 3601 3602 /** 3603 * Prints resource hints to browsers for pre-fetching, pre-rendering 3604 * and pre-connecting to websites. 3605 * 3606 * Gives hints to browsers to prefetch specific pages or render them 3607 * in the background, to perform DNS lookups or to begin the connection 3608 * handshake (DNS, TCP, TLS) in the background. 3609 * 3610 * These performance improving indicators work by using `<link rel"…">`. 3611 * 3612 * @since 4.6.0 3613 */ 3614 function wp_resource_hints() { 3615 $hints = array( 3616 'dns-prefetch' => wp_dependencies_unique_hosts(), 3617 'preconnect' => array(), 3618 'prefetch' => array(), 3619 'prerender' => array(), 3620 ); 3621 3622 foreach ( $hints as $relation_type => $urls ) { 3623 $unique_urls = array(); 3624 3625 /** 3626 * Filters domains and URLs for resource hints of the given relation type. 3627 * 3628 * @since 4.6.0 3629 * @since 4.7.0 The `$urls` parameter accepts arrays of specific HTML attributes 3630 * as its child elements. 3631 * 3632 * @param array $urls { 3633 * Array of resources and their attributes, or URLs to print for resource hints. 3634 * 3635 * @type array|string ...$0 { 3636 * Array of resource attributes, or a URL string. 3637 * 3638 * @type string $href URL to include in resource hints. Required. 3639 * @type string $as How the browser should treat the resource 3640 * (`script`, `style`, `image`, `document`, etc). 3641 * @type string $crossorigin Indicates the CORS policy of the specified resource. 3642 * @type float $pr Expected probability that the resource hint will be used. 3643 * @type string $type Type of the resource (`text/html`, `text/css`, etc). 3644 * } 3645 * } 3646 * @param string $relation_type The relation type the URLs are printed for. One of 3647 * 'dns-prefetch', 'preconnect', 'prefetch', or 'prerender'. 3648 */ 3649 $urls = apply_filters( 'wp_resource_hints', $urls, $relation_type ); 3650 3651 foreach ( $urls as $key => $url ) { 3652 $atts = array(); 3653 3654 if ( is_array( $url ) ) { 3655 if ( isset( $url['href'] ) ) { 3656 $atts = $url; 3657 $url = $url['href']; 3658 } else { 3659 continue; 3660 } 3661 } 3662 3663 $url = esc_url( $url, array( 'http', 'https' ) ); 3664 3665 if ( ! $url ) { 3666 continue; 3667 } 3668 3669 if ( isset( $unique_urls[ $url ] ) ) { 3670 continue; 3671 } 3672 3673 if ( in_array( $relation_type, array( 'preconnect', 'dns-prefetch' ), true ) ) { 3674 $parsed = wp_parse_url( $url ); 3675 3676 if ( empty( $parsed['host'] ) ) { 3677 continue; 3678 } 3679 3680 if ( 'preconnect' === $relation_type && ! empty( $parsed['scheme'] ) ) { 3681 $url = $parsed['scheme'] . '://' . $parsed['host']; 3682 } else { 3683 // Use protocol-relative URLs for dns-prefetch or if scheme is missing. 3684 $url = '//' . $parsed['host']; 3685 } 3686 } 3687 3688 $atts['rel'] = $relation_type; 3689 $atts['href'] = $url; 3690 3691 $unique_urls[ $url ] = $atts; 3692 } 3693 3694 foreach ( $unique_urls as $atts ) { 3695 $html = ''; 3696 3697 foreach ( $atts as $attr => $value ) { 3698 if ( ! is_scalar( $value ) 3699 || ( ! in_array( $attr, array( 'as', 'crossorigin', 'href', 'pr', 'rel', 'type' ), true ) && ! is_numeric( $attr ) ) 3700 ) { 3701 3702 continue; 3703 } 3704 3705 $value = ( 'href' === $attr ) ? esc_url( $value ) : esc_attr( $value ); 3706 3707 if ( ! is_string( $attr ) ) { 3708 $html .= " $value"; 3709 } else { 3710 $html .= " $attr='$value'"; 3711 } 3712 } 3713 3714 $html = trim( $html ); 3715 3716 echo "<link $html />\n"; 3717 } 3718 } 3719 } 3720 3721 /** 3722 * Prints resource preloads directives to browsers. 3723 * 3724 * Gives directive to browsers to preload specific resources that website will 3725 * need very soon, this ensures that they are available earlier and are less 3726 * likely to block the page's render. Preload directives should not be used for 3727 * non-render-blocking elements, as then they would compete with the 3728 * render-blocking ones, slowing down the render. 3729 * 3730 * These performance improving indicators work by using `<link rel="preload">`. 3731 * 3732 * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types/preload 3733 * @link https://web.dev/preload-responsive-images/ 3734 * 3735 * @since 6.1.0 3736 */ 3737 function wp_preload_resources() { 3738 /** 3739 * Filters domains and URLs for resource preloads. 3740 * 3741 * @since 6.1.0 3742 * @since 6.6.0 Added the `$fetchpriority` attribute. 3743 * 3744 * @param array $preload_resources { 3745 * Array of resources and their attributes, or URLs to print for resource preloads. 3746 * 3747 * @type array ...$0 { 3748 * Array of resource attributes. 3749 * 3750 * @type string $href URL to include in resource preloads. Required. 3751 * @type string $as How the browser should treat the resource 3752 * (`script`, `style`, `image`, `document`, etc). 3753 * @type string $crossorigin Indicates the CORS policy of the specified resource. 3754 * @type string $type Type of the resource (`text/html`, `text/css`, etc). 3755 * @type string $media Accepts media types or media queries. Allows responsive preloading. 3756 * @type string $imagesizes Responsive source size to the source Set. 3757 * @type string $imagesrcset Responsive image sources to the source set. 3758 * @type string $fetchpriority Fetchpriority value for the resource. 3759 * } 3760 * } 3761 */ 3762 $preload_resources = apply_filters( 'wp_preload_resources', array() ); 3763 3764 if ( ! is_array( $preload_resources ) ) { 3765 return; 3766 } 3767 3768 $unique_resources = array(); 3769 3770 // Parse the complete resource list and extract unique resources. 3771 foreach ( $preload_resources as $resource ) { 3772 if ( ! is_array( $resource ) ) { 3773 continue; 3774 } 3775 3776 $attributes = $resource; 3777 if ( isset( $resource['href'] ) ) { 3778 $href = $resource['href']; 3779 if ( isset( $unique_resources[ $href ] ) ) { 3780 continue; 3781 } 3782 $unique_resources[ $href ] = $attributes; 3783 // Media can use imagesrcset and not href. 3784 } elseif ( ( 'image' === $resource['as'] ) && 3785 ( isset( $resource['imagesrcset'] ) || isset( $resource['imagesizes'] ) ) 3786 ) { 3787 if ( isset( $unique_resources[ $resource['imagesrcset'] ] ) ) { 3788 continue; 3789 } 3790 $unique_resources[ $resource['imagesrcset'] ] = $attributes; 3791 } else { 3792 continue; 3793 } 3794 } 3795 3796 // Build and output the HTML for each unique resource. 3797 foreach ( $unique_resources as $unique_resource ) { 3798 $html = ''; 3799 3800 foreach ( $unique_resource as $resource_key => $resource_value ) { 3801 if ( ! is_scalar( $resource_value ) ) { 3802 continue; 3803 } 3804 3805 // Ignore non-supported attributes. 3806 $non_supported_attributes = array( 'as', 'crossorigin', 'href', 'imagesrcset', 'imagesizes', 'type', 'media', 'fetchpriority' ); 3807 if ( ! in_array( $resource_key, $non_supported_attributes, true ) && ! is_numeric( $resource_key ) ) { 3808 continue; 3809 } 3810 3811 // imagesrcset only usable when preloading image, ignore otherwise. 3812 if ( ( 'imagesrcset' === $resource_key ) && ( ! isset( $unique_resource['as'] ) || ( 'image' !== $unique_resource['as'] ) ) ) { 3813 continue; 3814 } 3815 3816 // imagesizes only usable when preloading image and imagesrcset present, ignore otherwise. 3817 if ( ( 'imagesizes' === $resource_key ) && 3818 ( ! isset( $unique_resource['as'] ) || ( 'image' !== $unique_resource['as'] ) || ! isset( $unique_resource['imagesrcset'] ) ) 3819 ) { 3820 continue; 3821 } 3822 3823 $resource_value = ( 'href' === $resource_key ) ? esc_url( $resource_value, array( 'http', 'https' ) ) : esc_attr( $resource_value ); 3824 3825 if ( ! is_string( $resource_key ) ) { 3826 $html .= " $resource_value"; 3827 } else { 3828 $html .= " $resource_key='$resource_value'"; 3829 } 3830 } 3831 $html = trim( $html ); 3832 3833 printf( "<link rel='preload' %s />\n", $html ); 3834 } 3835 } 3836 3837 /** 3838 * Retrieves a list of unique hosts of all enqueued scripts and styles. 3839 * 3840 * @since 4.6.0 3841 * 3842 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts. 3843 * @global WP_Styles $wp_styles The WP_Styles object for printing styles. 3844 * 3845 * @return string[] A list of unique hosts of enqueued scripts and styles. 3846 */ 3847 function wp_dependencies_unique_hosts() { 3848 global $wp_scripts, $wp_styles; 3849 3850 $unique_hosts = array(); 3851 3852 foreach ( array( $wp_scripts, $wp_styles ) as $dependencies ) { 3853 if ( $dependencies instanceof WP_Dependencies && ! empty( $dependencies->queue ) ) { 3854 foreach ( $dependencies->queue as $handle ) { 3855 if ( ! isset( $dependencies->registered[ $handle ] ) ) { 3856 continue; 3857 } 3858 3859 /* @var _WP_Dependency $dependency */ 3860 $dependency = $dependencies->registered[ $handle ]; 3861 $parsed = wp_parse_url( $dependency->src ); 3862 3863 if ( ! empty( $parsed['host'] ) 3864 && ! in_array( $parsed['host'], $unique_hosts, true ) && $parsed['host'] !== $_SERVER['SERVER_NAME'] 3865 ) { 3866 $unique_hosts[] = $parsed['host']; 3867 } 3868 } 3869 } 3870 } 3871 3872 return $unique_hosts; 3873 } 3874 3875 /** 3876 * Determines whether the user can access the visual editor. 3877 * 3878 * Checks if the user can access the visual editor and that it's supported by the user's browser. 3879 * 3880 * @since 2.0.0 3881 * 3882 * @global bool $wp_rich_edit Whether the user can access the visual editor. 3883 * @global bool $is_gecko Whether the browser is Gecko-based. 3884 * @global bool $is_opera Whether the browser is Opera. 3885 * @global bool $is_safari Whether the browser is Safari. 3886 * @global bool $is_chrome Whether the browser is Chrome. 3887 * @global bool $is_IE Whether the browser is Internet Explorer. 3888 * @global bool $is_edge Whether the browser is Microsoft Edge. 3889 * 3890 * @return bool True if the user can access the visual editor, false otherwise. 3891 */ 3892 function user_can_richedit() { 3893 global $wp_rich_edit, $is_gecko, $is_opera, $is_safari, $is_chrome, $is_IE, $is_edge; 3894 3895 if ( ! isset( $wp_rich_edit ) ) { 3896 $wp_rich_edit = false; 3897 3898 if ( 'true' === get_user_option( 'rich_editing' ) || ! is_user_logged_in() ) { // Default to 'true' for logged out users. 3899 if ( $is_safari ) { 3900 $wp_rich_edit = ! wp_is_mobile() || ( preg_match( '!AppleWebKit/(\d+)!', $_SERVER['HTTP_USER_AGENT'], $match ) && (int) $match[1] >= 534 ); 3901 } elseif ( $is_IE ) { 3902 $wp_rich_edit = str_contains( $_SERVER['HTTP_USER_AGENT'], 'Trident/7.0;' ); 3903 } elseif ( $is_gecko || $is_chrome || $is_edge || ( $is_opera && ! wp_is_mobile() ) ) { 3904 $wp_rich_edit = true; 3905 } 3906 } 3907 } 3908 3909 /** 3910 * Filters whether the user can access the visual editor. 3911 * 3912 * @since 2.1.0 3913 * 3914 * @param bool $wp_rich_edit Whether the user can access the visual editor. 3915 */ 3916 return apply_filters( 'user_can_richedit', $wp_rich_edit ); 3917 } 3918 3919 /** 3920 * Finds out which editor should be displayed by default. 3921 * 3922 * Works out which of the editors to display as the current editor for a 3923 * user. The 'html' setting is for the "Code" editor tab. 3924 * 3925 * @since 2.5.0 3926 * 3927 * @return string Either 'tinymce', 'html', or 'test' 3928 */ 3929 function wp_default_editor() { 3930 $r = user_can_richedit() ? 'tinymce' : 'html'; // Defaults. 3931 if ( wp_get_current_user() ) { // Look for cookie. 3932 $ed = get_user_setting( 'editor', 'tinymce' ); 3933 $r = ( in_array( $ed, array( 'tinymce', 'html', 'test' ), true ) ) ? $ed : $r; 3934 } 3935 3936 /** 3937 * Filters which editor should be displayed by default. 3938 * 3939 * @since 2.5.0 3940 * 3941 * @param string $r Which editor should be displayed by default. Either 'tinymce', 'html', or 'test'. 3942 */ 3943 return apply_filters( 'wp_default_editor', $r ); 3944 } 3945 3946 /** 3947 * Renders an editor. 3948 * 3949 * Using this function is the proper way to output all needed components for both TinyMCE and Quicktags. 3950 * _WP_Editors should not be used directly. See https://core.trac.wordpress.org/ticket/17144. 3951 * 3952 * NOTE: Once initialized the TinyMCE editor cannot be safely moved in the DOM. For that reason 3953 * running wp_editor() inside of a meta box is not a good idea unless only Quicktags is used. 3954 * On the post edit screen several actions can be used to include additional editors 3955 * containing TinyMCE: 'edit_page_form', 'edit_form_advanced' and 'dbx_post_sidebar'. 3956 * See https://core.trac.wordpress.org/ticket/19173 for more information. 3957 * 3958 * @see _WP_Editors::editor() 3959 * @see _WP_Editors::parse_settings() 3960 * @since 3.3.0 3961 * 3962 * @param string $content Initial content for the editor. 3963 * @param string $editor_id HTML ID attribute value for the textarea and TinyMCE. 3964 * Should not contain square brackets. 3965 * @param array $settings See _WP_Editors::parse_settings() for description. 3966 */ 3967 function wp_editor( $content, $editor_id, $settings = array() ) { 3968 if ( ! class_exists( '_WP_Editors', false ) ) { 3969 require ABSPATH . WPINC . '/class-wp-editor.php'; 3970 } 3971 _WP_Editors::editor( $content, $editor_id, $settings ); 3972 } 3973 3974 /** 3975 * Outputs the editor scripts, stylesheets, and default settings. 3976 * 3977 * The editor can be initialized when needed after page load. 3978 * See wp.editor.initialize() in wp-admin/js/editor.js for initialization options. 3979 * 3980 * @uses _WP_Editors 3981 * @since 4.8.0 3982 */ 3983 function wp_enqueue_editor() { 3984 if ( ! class_exists( '_WP_Editors', false ) ) { 3985 require ABSPATH . WPINC . '/class-wp-editor.php'; 3986 } 3987 3988 _WP_Editors::enqueue_default_editor(); 3989 } 3990 3991 /** 3992 * Enqueues assets needed by the code editor for the given settings. 3993 * 3994 * @since 4.9.0 3995 * 3996 * @see wp_enqueue_editor() 3997 * @see wp_get_code_editor_settings(); 3998 * @see _WP_Editors::parse_settings() 3999 * 4000 * @param array $args { 4001 * Args. 4002 * 4003 * @type string $type The MIME type of the file to be edited. 4004 * @type string $file Filename to be edited. Extension is used to sniff the type. Can be supplied as alternative to `$type` param. 4005 * @type WP_Theme $theme Theme being edited when on the theme file editor. 4006 * @type string $plugin Plugin being edited when on the plugin file editor. 4007 * @type array $codemirror Additional CodeMirror setting overrides. 4008 * @type array $csslint CSSLint rule overrides. 4009 * @type array $jshint JSHint rule overrides. 4010 * @type array $htmlhint HTMLHint rule overrides. 4011 * } 4012 * @return array|false Settings for the enqueued code editor, or false if the editor was not enqueued. 4013 */ 4014 function wp_enqueue_code_editor( $args ) { 4015 if ( is_user_logged_in() && 'false' === wp_get_current_user()->syntax_highlighting ) { 4016 return false; 4017 } 4018 4019 $settings = wp_get_code_editor_settings( $args ); 4020 4021 if ( empty( $settings ) || empty( $settings['codemirror'] ) ) { 4022 return false; 4023 } 4024 4025 wp_enqueue_script( 'code-editor' ); 4026 wp_enqueue_style( 'code-editor' ); 4027 4028 if ( isset( $settings['codemirror']['mode'] ) ) { 4029 $mode = $settings['codemirror']['mode']; 4030 if ( is_string( $mode ) ) { 4031 $mode = array( 4032 'name' => $mode, 4033 ); 4034 } 4035 4036 if ( ! empty( $settings['codemirror']['lint'] ) ) { 4037 switch ( $mode['name'] ) { 4038 case 'css': 4039 case 'text/css': 4040 case 'text/x-scss': 4041 case 'text/x-less': 4042 wp_enqueue_script( 'csslint' ); 4043 break; 4044 case 'htmlmixed': 4045 case 'text/html': 4046 case 'php': 4047 case 'application/x-httpd-php': 4048 case 'text/x-php': 4049 wp_enqueue_script( 'htmlhint' ); 4050 wp_enqueue_script( 'csslint' ); 4051 wp_enqueue_script( 'jshint' ); 4052 if ( ! current_user_can( 'unfiltered_html' ) ) { 4053 wp_enqueue_script( 'htmlhint-kses' ); 4054 } 4055 break; 4056 case 'javascript': 4057 case 'application/ecmascript': 4058 case 'application/json': 4059 case 'application/javascript': 4060 case 'application/ld+json': 4061 case 'text/typescript': 4062 case 'application/typescript': 4063 wp_enqueue_script( 'jshint' ); 4064 wp_enqueue_script( 'jsonlint' ); 4065 break; 4066 } 4067 } 4068 } 4069 4070 wp_add_inline_script( 'code-editor', sprintf( 'jQuery.extend( wp.codeEditor.defaultSettings, %s );', wp_json_encode( $settings ) ) ); 4071 4072 /** 4073 * Fires when scripts and styles are enqueued for the code editor. 4074 * 4075 * @since 4.9.0 4076 * 4077 * @param array $settings Settings for the enqueued code editor. 4078 */ 4079 do_action( 'wp_enqueue_code_editor', $settings ); 4080 4081 return $settings; 4082 } 4083 4084 /** 4085 * Generates and returns code editor settings. 4086 * 4087 * @since 5.0.0 4088 * 4089 * @see wp_enqueue_code_editor() 4090 * 4091 * @param array $args { 4092 * Args. 4093 * 4094 * @type string $type The MIME type of the file to be edited. 4095 * @type string $file Filename to be edited. Extension is used to sniff the type. Can be supplied as alternative to `$type` param. 4096 * @type WP_Theme $theme Theme being edited when on the theme file editor. 4097 * @type string $plugin Plugin being edited when on the plugin file editor. 4098 * @type array $codemirror Additional CodeMirror setting overrides. 4099 * @type array $csslint CSSLint rule overrides. 4100 * @type array $jshint JSHint rule overrides. 4101 * @type array $htmlhint HTMLHint rule overrides. 4102 * } 4103 * @return array|false Settings for the code editor. 4104 */ 4105 function wp_get_code_editor_settings( $args ) { 4106 $settings = array( 4107 'codemirror' => array( 4108 'indentUnit' => 4, 4109 'indentWithTabs' => true, 4110 'inputStyle' => 'contenteditable', 4111 'lineNumbers' => true, 4112 'lineWrapping' => true, 4113 'styleActiveLine' => true, 4114 'continueComments' => true, 4115 'extraKeys' => array( 4116 'Ctrl-Space' => 'autocomplete', 4117 'Ctrl-/' => 'toggleComment', 4118 'Cmd-/' => 'toggleComment', 4119 'Alt-F' => 'findPersistent', 4120 'Ctrl-F' => 'findPersistent', 4121 'Cmd-F' => 'findPersistent', 4122 ), 4123 'direction' => 'ltr', // Code is shown in LTR even in RTL languages. 4124 'gutters' => array(), 4125 ), 4126 'csslint' => array( 4127 'errors' => true, // Parsing errors. 4128 'box-model' => true, 4129 'display-property-grouping' => true, 4130 'duplicate-properties' => true, 4131 'known-properties' => true, 4132 'outline-none' => true, 4133 ), 4134 'jshint' => array( 4135 // The following are copied from <https://github.com/WordPress/wordpress-develop/blob/4.8.1/.jshintrc>. 4136 'boss' => true, 4137 'curly' => true, 4138 'eqeqeq' => true, 4139 'eqnull' => true, 4140 'es3' => true, 4141 'expr' => true, 4142 'immed' => true, 4143 'noarg' => true, 4144 'nonbsp' => true, 4145 'onevar' => true, 4146 'quotmark' => 'single', 4147 'trailing' => true, 4148 'undef' => true, 4149 'unused' => true, 4150 4151 'browser' => true, 4152 4153 'globals' => array( 4154 '_' => false, 4155 'Backbone' => false, 4156 'jQuery' => false, 4157 'JSON' => false, 4158 'wp' => false, 4159 ), 4160 ), 4161 'htmlhint' => array( 4162 'tagname-lowercase' => true, 4163 'attr-lowercase' => true, 4164 'attr-value-double-quotes' => false, 4165 'doctype-first' => false, 4166 'tag-pair' => true, 4167 'spec-char-escape' => true, 4168 'id-unique' => true, 4169 'src-not-empty' => true, 4170 'attr-no-duplication' => true, 4171 'alt-require' => true, 4172 'space-tab-mixed-disabled' => 'tab', 4173 'attr-unsafe-chars' => true, 4174 ), 4175 ); 4176 4177 $type = ''; 4178 if ( isset( $args['type'] ) ) { 4179 $type = $args['type']; 4180 4181 // Remap MIME types to ones that CodeMirror modes will recognize. 4182 if ( 'application/x-patch' === $type || 'text/x-patch' === $type ) { 4183 $type = 'text/x-diff'; 4184 } 4185 } elseif ( isset( $args['file'] ) && str_contains( basename( $args['file'] ), '.' ) ) { 4186 $extension = strtolower( pathinfo( $args['file'], PATHINFO_EXTENSION ) ); 4187 foreach ( wp_get_mime_types() as $exts => $mime ) { 4188 if ( preg_match( '!^(' . $exts . ')$!i', $extension ) ) { 4189 $type = $mime; 4190 break; 4191 } 4192 } 4193 4194 // Supply any types that are not matched by wp_get_mime_types(). 4195 if ( empty( $type ) ) { 4196 switch ( $extension ) { 4197 case 'conf': 4198 $type = 'text/nginx'; 4199 break; 4200 case 'css': 4201 $type = 'text/css'; 4202 break; 4203 case 'diff': 4204 case 'patch': 4205 $type = 'text/x-diff'; 4206 break; 4207 case 'html': 4208 case 'htm': 4209 $type = 'text/html'; 4210 break; 4211 case 'http': 4212 $type = 'message/http'; 4213 break; 4214 case 'js': 4215 $type = 'text/javascript'; 4216 break; 4217 case 'json': 4218 $type = 'application/json'; 4219 break; 4220 case 'jsx': 4221 $type = 'text/jsx'; 4222 break; 4223 case 'less': 4224 $type = 'text/x-less'; 4225 break; 4226 case 'md': 4227 $type = 'text/x-gfm'; 4228 break; 4229 case 'php': 4230 case 'phtml': 4231 case 'php3': 4232 case 'php4': 4233 case 'php5': 4234 case 'php7': 4235 case 'phps': 4236 $type = 'application/x-httpd-php'; 4237 break; 4238 case 'scss': 4239 $type = 'text/x-scss'; 4240 break; 4241 case 'sass': 4242 $type = 'text/x-sass'; 4243 break; 4244 case 'sh': 4245 case 'bash': 4246 $type = 'text/x-sh'; 4247 break; 4248 case 'sql': 4249 $type = 'text/x-sql'; 4250 break; 4251 case 'svg': 4252 $type = 'application/svg+xml'; 4253 break; 4254 case 'xml': 4255 $type = 'text/xml'; 4256 break; 4257 case 'yml': 4258 case 'yaml': 4259 $type = 'text/x-yaml'; 4260 break; 4261 case 'txt': 4262 default: 4263 $type = 'text/plain'; 4264 break; 4265 } 4266 } 4267 } 4268 4269 if ( in_array( $type, array( 'text/css', 'text/x-scss', 'text/x-less', 'text/x-sass' ), true ) ) { 4270 $settings['codemirror'] = array_merge( 4271 $settings['codemirror'], 4272 array( 4273 'mode' => $type, 4274 'lint' => false, 4275 'autoCloseBrackets' => true, 4276 'matchBrackets' => true, 4277 ) 4278 ); 4279 } elseif ( 'text/x-diff' === $type ) { 4280 $settings['codemirror'] = array_merge( 4281 $settings['codemirror'], 4282 array( 4283 'mode' => 'diff', 4284 ) 4285 ); 4286 } elseif ( 'text/html' === $type ) { 4287 $settings['codemirror'] = array_merge( 4288 $settings['codemirror'], 4289 array( 4290 'mode' => 'htmlmixed', 4291 'lint' => true, 4292 'autoCloseBrackets' => true, 4293 'autoCloseTags' => true, 4294 'matchTags' => array( 4295 'bothTags' => true, 4296 ), 4297 ) 4298 ); 4299 4300 if ( ! current_user_can( 'unfiltered_html' ) ) { 4301 $settings['htmlhint']['kses'] = wp_kses_allowed_html( 'post' ); 4302 } 4303 } elseif ( 'text/x-gfm' === $type ) { 4304 $settings['codemirror'] = array_merge( 4305 $settings['codemirror'], 4306 array( 4307 'mode' => 'gfm', 4308 'highlightFormatting' => true, 4309 ) 4310 ); 4311 } elseif ( 'application/javascript' === $type || 'text/javascript' === $type ) { 4312 $settings['codemirror'] = array_merge( 4313 $settings['codemirror'], 4314 array( 4315 'mode' => 'javascript', 4316 'lint' => true, 4317 'autoCloseBrackets' => true, 4318 'matchBrackets' => true, 4319 ) 4320 ); 4321 } elseif ( str_contains( $type, 'json' ) ) { 4322 $settings['codemirror'] = array_merge( 4323 $settings['codemirror'], 4324 array( 4325 'mode' => array( 4326 'name' => 'javascript', 4327 ), 4328 'lint' => true, 4329 'autoCloseBrackets' => true, 4330 'matchBrackets' => true, 4331 ) 4332 ); 4333 if ( 'application/ld+json' === $type ) { 4334 $settings['codemirror']['mode']['jsonld'] = true; 4335 } else { 4336 $settings['codemirror']['mode']['json'] = true; 4337 } 4338 } elseif ( str_contains( $type, 'jsx' ) ) { 4339 $settings['codemirror'] = array_merge( 4340 $settings['codemirror'], 4341 array( 4342 'mode' => 'jsx', 4343 'autoCloseBrackets' => true, 4344 'matchBrackets' => true, 4345 ) 4346 ); 4347 } elseif ( 'text/x-markdown' === $type ) { 4348 $settings['codemirror'] = array_merge( 4349 $settings['codemirror'], 4350 array( 4351 'mode' => 'markdown', 4352 'highlightFormatting' => true, 4353 ) 4354 ); 4355 } elseif ( 'text/nginx' === $type ) { 4356 $settings['codemirror'] = array_merge( 4357 $settings['codemirror'], 4358 array( 4359 'mode' => 'nginx', 4360 ) 4361 ); 4362 } elseif ( 'application/x-httpd-php' === $type ) { 4363 $settings['codemirror'] = array_merge( 4364 $settings['codemirror'], 4365 array( 4366 'mode' => 'php', 4367 'autoCloseBrackets' => true, 4368 'autoCloseTags' => true, 4369 'matchBrackets' => true, 4370 'matchTags' => array( 4371 'bothTags' => true, 4372 ), 4373 ) 4374 ); 4375 } elseif ( 'text/x-sql' === $type || 'text/x-mysql' === $type ) { 4376 $settings['codemirror'] = array_merge( 4377 $settings['codemirror'], 4378 array( 4379 'mode' => 'sql', 4380 'autoCloseBrackets' => true, 4381 'matchBrackets' => true, 4382 ) 4383 ); 4384 } elseif ( str_contains( $type, 'xml' ) ) { 4385 $settings['codemirror'] = array_merge( 4386 $settings['codemirror'], 4387 array( 4388 'mode' => 'xml', 4389 'autoCloseBrackets' => true, 4390 'autoCloseTags' => true, 4391 'matchTags' => array( 4392 'bothTags' => true, 4393 ), 4394 ) 4395 ); 4396 } elseif ( 'text/x-yaml' === $type ) { 4397 $settings['codemirror'] = array_merge( 4398 $settings['codemirror'], 4399 array( 4400 'mode' => 'yaml', 4401 ) 4402 ); 4403 } else { 4404 $settings['codemirror']['mode'] = $type; 4405 } 4406 4407 if ( ! empty( $settings['codemirror']['lint'] ) ) { 4408 $settings['codemirror']['gutters'][] = 'CodeMirror-lint-markers'; 4409 } 4410 4411 // Let settings supplied via args override any defaults. 4412 foreach ( wp_array_slice_assoc( $args, array( 'codemirror', 'csslint', 'jshint', 'htmlhint' ) ) as $key => $value ) { 4413 $settings[ $key ] = array_merge( 4414 $settings[ $key ], 4415 $value 4416 ); 4417 } 4418 4419 /** 4420 * Filters settings that are passed into the code editor. 4421 * 4422 * Returning a falsey value will disable the syntax-highlighting code editor. 4423 * 4424 * @since 4.9.0 4425 * 4426 * @param array $settings The array of settings passed to the code editor. 4427 * A falsey value disables the editor. 4428 * @param array $args { 4429 * Args passed when calling `get_code_editor_settings()`. 4430 * 4431 * @type string $type The MIME type of the file to be edited. 4432 * @type string $file Filename being edited. 4433 * @type WP_Theme $theme Theme being edited when on the theme file editor. 4434 * @type string $plugin Plugin being edited when on the plugin file editor. 4435 * @type array $codemirror Additional CodeMirror setting overrides. 4436 * @type array $csslint CSSLint rule overrides. 4437 * @type array $jshint JSHint rule overrides. 4438 * @type array $htmlhint HTMLHint rule overrides. 4439 * } 4440 */ 4441 return apply_filters( 'wp_code_editor_settings', $settings, $args ); 4442 } 4443 4444 /** 4445 * Retrieves the contents of the search WordPress query variable. 4446 * 4447 * The search query string is passed through esc_attr() to ensure that it is safe 4448 * for placing in an HTML attribute. 4449 * 4450 * @since 2.3.0 4451 * 4452 * @param bool $escaped Whether the result is escaped. Default true. 4453 * Only use when you are later escaping it. Do not use unescaped. 4454 * @return string 4455 */ 4456 function get_search_query( $escaped = true ) { 4457 /** 4458 * Filters the contents of the search query variable. 4459 * 4460 * @since 2.3.0 4461 * 4462 * @param mixed $search Contents of the search query variable. 4463 */ 4464 $query = apply_filters( 'get_search_query', get_query_var( 's' ) ); 4465 4466 if ( $escaped ) { 4467 $query = esc_attr( $query ); 4468 } 4469 return $query; 4470 } 4471 4472 /** 4473 * Displays the contents of the search query variable. 4474 * 4475 * The search query string is passed through esc_attr() to ensure that it is safe 4476 * for placing in an HTML attribute. 4477 * 4478 * @since 2.1.0 4479 */ 4480 function the_search_query() { 4481 /** 4482 * Filters the contents of the search query variable, for display. 4483 * 4484 * @since 2.3.0 4485 * 4486 * @param mixed $search Contents of the search query variable. 4487 */ 4488 echo esc_attr( apply_filters( 'the_search_query', get_search_query( false ) ) ); 4489 } 4490 4491 /** 4492 * Gets the language attributes for the 'html' tag. 4493 * 4494 * Builds up a set of HTML attributes containing the text direction and language 4495 * information for the page. 4496 * 4497 * @since 4.3.0 4498 * 4499 * @param string $doctype Optional. The type of HTML document. Accepts 'xhtml' or 'html'. Default 'html'. 4500 * @return string A space-separated list of language attributes. 4501 */ 4502 function get_language_attributes( $doctype = 'html' ) { 4503 $attributes = array(); 4504 4505 if ( function_exists( 'is_rtl' ) && is_rtl() ) { 4506 $attributes[] = 'dir="rtl"'; 4507 } 4508 4509 $lang = get_bloginfo( 'language' ); 4510 if ( $lang ) { 4511 if ( 'text/html' === get_option( 'html_type' ) || 'html' === $doctype ) { 4512 $attributes[] = 'lang="' . esc_attr( $lang ) . '"'; 4513 } 4514 4515 if ( 'text/html' !== get_option( 'html_type' ) || 'xhtml' === $doctype ) { 4516 $attributes[] = 'xml:lang="' . esc_attr( $lang ) . '"'; 4517 } 4518 } 4519 4520 $output = implode( ' ', $attributes ); 4521 4522 /** 4523 * Filters the language attributes for display in the 'html' tag. 4524 * 4525 * @since 2.5.0 4526 * @since 4.3.0 Added the `$doctype` parameter. 4527 * 4528 * @param string $output A space-separated list of language attributes. 4529 * @param string $doctype The type of HTML document (xhtml|html). 4530 */ 4531 return apply_filters( 'language_attributes', $output, $doctype ); 4532 } 4533 4534 /** 4535 * Displays the language attributes for the 'html' tag. 4536 * 4537 * Builds up a set of HTML attributes containing the text direction and language 4538 * information for the page. 4539 * 4540 * @since 2.1.0 4541 * @since 4.3.0 Converted into a wrapper for get_language_attributes(). 4542 * 4543 * @param string $doctype Optional. The type of HTML document. Accepts 'xhtml' or 'html'. Default 'html'. 4544 */ 4545 function language_attributes( $doctype = 'html' ) { 4546 echo get_language_attributes( $doctype ); 4547 } 4548 4549 /** 4550 * Retrieves paginated links for archive post pages. 4551 * 4552 * Technically, the function can be used to create paginated link list for any 4553 * area. The 'base' argument is used to reference the url, which will be used to 4554 * create the paginated links. The 'format' argument is then used for replacing 4555 * the page number. It is however, most likely and by default, to be used on the 4556 * archive post pages. 4557 * 4558 * The 'type' argument controls format of the returned value. The default is 4559 * 'plain', which is just a string with the links separated by a newline 4560 * character. The other possible values are either 'array' or 'list'. The 4561 * 'array' value will return an array of the paginated link list to offer full 4562 * control of display. The 'list' value will place all of the paginated links in 4563 * an unordered HTML list. 4564 * 4565 * The 'total' argument is the total amount of pages and is an integer. The 4566 * 'current' argument is the current page number and is also an integer. 4567 * 4568 * An example of the 'base' argument is "http://example.com/all_posts.php%_%" 4569 * and the '%_%' is required. The '%_%' will be replaced by the contents of in 4570 * the 'format' argument. An example for the 'format' argument is "?page=%#%" 4571 * and the '%#%' is also required. The '%#%' will be replaced with the page 4572 * number. 4573 * 4574 * You can include the previous and next links in the list by setting the 4575 * 'prev_next' argument to true, which it is by default. You can set the 4576 * previous text, by using the 'prev_text' argument. You can set the next text 4577 * by setting the 'next_text' argument. 4578 * 4579 * If the 'show_all' argument is set to true, then it will show all of the pages 4580 * instead of a short list of the pages near the current page. By default, the 4581 * 'show_all' is set to false and controlled by the 'end_size' and 'mid_size' 4582 * arguments. The 'end_size' argument is how many numbers on either the start 4583 * and the end list edges, by default is 1. The 'mid_size' argument is how many 4584 * numbers to either side of current page, but not including current page. 4585 * 4586 * It is possible to add query vars to the link by using the 'add_args' argument 4587 * and see add_query_arg() for more information. 4588 * 4589 * The 'before_page_number' and 'after_page_number' arguments allow users to 4590 * augment the links themselves. Typically this might be to add context to the 4591 * numbered links so that screen reader users understand what the links are for. 4592 * The text strings are added before and after the page number - within the 4593 * anchor tag. 4594 * 4595 * @since 2.1.0 4596 * @since 4.9.0 Added the `aria_current` argument. 4597 * 4598 * @global WP_Query $wp_query WordPress Query object. 4599 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 4600 * 4601 * @param string|array $args { 4602 * Optional. Array or string of arguments for generating paginated links for archives. 4603 * 4604 * @type string $base Base of the paginated url. Default empty. 4605 * @type string $format Format for the pagination structure. Default empty. 4606 * @type int $total The total amount of pages. Default is the value WP_Query's 4607 * `max_num_pages` or 1. 4608 * @type int $current The current page number. Default is 'paged' query var or 1. 4609 * @type string $aria_current The value for the aria-current attribute. Possible values are 'page', 4610 * 'step', 'location', 'date', 'time', 'true', 'false'. Default is 'page'. 4611 * @type bool $show_all Whether to show all pages. Default false. 4612 * @type int $end_size How many numbers on either the start and the end list edges. 4613 * Default 1. 4614 * @type int $mid_size How many numbers to either side of the current pages. Default 2. 4615 * @type bool $prev_next Whether to include the previous and next links in the list. Default true. 4616 * @type string $prev_text The previous page text. Default '« Previous'. 4617 * @type string $next_text The next page text. Default 'Next »'. 4618 * @type string $type Controls format of the returned value. Possible values are 'plain', 4619 * 'array' and 'list'. Default is 'plain'. 4620 * @type array $add_args An array of query args to add. Default false. 4621 * @type string $add_fragment A string to append to each link. Default empty. 4622 * @type string $before_page_number A string to appear before the page number. Default empty. 4623 * @type string $after_page_number A string to append after the page number. Default empty. 4624 * } 4625 * @return string|string[]|void String of page links or array of page links, depending on 'type' argument. 4626 * Void if total number of pages is less than 2. 4627 */ 4628 function paginate_links( $args = '' ) { 4629 global $wp_query, $wp_rewrite; 4630 4631 // Setting up default values based on the current URL. 4632 $pagenum_link = html_entity_decode( get_pagenum_link() ); 4633 $url_parts = explode( '?', $pagenum_link ); 4634 4635 // Get max pages and current page out of the current query, if available. 4636 $total = isset( $wp_query->max_num_pages ) ? $wp_query->max_num_pages : 1; 4637 $current = get_query_var( 'paged' ) ? (int) get_query_var( 'paged' ) : 1; 4638 4639 // Append the format placeholder to the base URL. 4640 $pagenum_link = trailingslashit( $url_parts[0] ) . '%_%'; 4641 4642 // URL base depends on permalink settings. 4643 $format = $wp_rewrite->using_index_permalinks() && ! strpos( $pagenum_link, 'index.php' ) ? 'index.php/' : ''; 4644 $format .= $wp_rewrite->using_permalinks() ? user_trailingslashit( $wp_rewrite->pagination_base . '/%#%', 'paged' ) : '?paged=%#%'; 4645 4646 $defaults = array( 4647 'base' => $pagenum_link, // http://example.com/all_posts.php%_% : %_% is replaced by format (below). 4648 'format' => $format, // ?page=%#% : %#% is replaced by the page number. 4649 'total' => $total, 4650 'current' => $current, 4651 'aria_current' => 'page', 4652 'show_all' => false, 4653 'prev_next' => true, 4654 'prev_text' => __( '« Previous' ), 4655 'next_text' => __( 'Next »' ), 4656 'end_size' => 1, 4657 'mid_size' => 2, 4658 'type' => 'plain', 4659 'add_args' => array(), // Array of query args to add. 4660 'add_fragment' => '', 4661 'before_page_number' => '', 4662 'after_page_number' => '', 4663 ); 4664 4665 $args = wp_parse_args( $args, $defaults ); 4666 4667 if ( ! is_array( $args['add_args'] ) ) { 4668 $args['add_args'] = array(); 4669 } 4670 4671 // Merge additional query vars found in the original URL into 'add_args' array. 4672 if ( isset( $url_parts[1] ) ) { 4673 // Find the format argument. 4674 $format = explode( '?', str_replace( '%_%', $args['format'], $args['base'] ) ); 4675 $format_query = isset( $format[1] ) ? $format[1] : ''; 4676 wp_parse_str( $format_query, $format_args ); 4677 4678 // Find the query args of the requested URL. 4679 wp_parse_str( $url_parts[1], $url_query_args ); 4680 4681 // Remove the format argument from the array of query arguments, to avoid overwriting custom format. 4682 foreach ( $format_args as $format_arg => $format_arg_value ) { 4683 unset( $url_query_args[ $format_arg ] ); 4684 } 4685 4686 $args['add_args'] = array_merge( $args['add_args'], urlencode_deep( $url_query_args ) ); 4687 } 4688 4689 // Who knows what else people pass in $args. 4690 $total = (int) $args['total']; 4691 if ( $total < 2 ) { 4692 return; 4693 } 4694 $current = (int) $args['current']; 4695 $end_size = (int) $args['end_size']; // Out of bounds? Make it the default. 4696 if ( $end_size < 1 ) { 4697 $end_size = 1; 4698 } 4699 $mid_size = (int) $args['mid_size']; 4700 if ( $mid_size < 0 ) { 4701 $mid_size = 2; 4702 } 4703 4704 $add_args = $args['add_args']; 4705 $r = ''; 4706 $page_links = array(); 4707 $dots = false; 4708 4709 if ( $args['prev_next'] && $current && 1 < $current ) : 4710 $link = str_replace( '%_%', 2 === $current ? '' : $args['format'], $args['base'] ); 4711 $link = str_replace( '%#%', $current - 1, $link ); 4712 if ( $add_args ) { 4713 $link = add_query_arg( $add_args, $link ); 4714 } 4715 $link .= $args['add_fragment']; 4716 4717 $page_links[] = sprintf( 4718 '<a class="prev page-numbers" href="%s">%s</a>', 4719 /** 4720 * Filters the paginated links for the given archive pages. 4721 * 4722 * @since 3.0.0 4723 * 4724 * @param string $link The paginated link URL. 4725 */ 4726 esc_url( apply_filters( 'paginate_links', $link ) ), 4727 $args['prev_text'] 4728 ); 4729 endif; 4730 4731 for ( $n = 1; $n <= $total; $n++ ) : 4732 if ( $n === $current ) : 4733 $page_links[] = sprintf( 4734 '<span aria-current="%s" class="page-numbers current">%s</span>', 4735 esc_attr( $args['aria_current'] ), 4736 $args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number'] 4737 ); 4738 4739 $dots = true; 4740 else : 4741 if ( $args['show_all'] || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) : 4742 $link = str_replace( '%_%', 1 === $n ? '' : $args['format'], $args['base'] ); 4743 $link = str_replace( '%#%', $n, $link ); 4744 if ( $add_args ) { 4745 $link = add_query_arg( $add_args, $link ); 4746 } 4747 $link .= $args['add_fragment']; 4748 4749 $page_links[] = sprintf( 4750 '<a class="page-numbers" href="%s">%s</a>', 4751 /** This filter is documented in wp-includes/general-template.php */ 4752 esc_url( apply_filters( 'paginate_links', $link ) ), 4753 $args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number'] 4754 ); 4755 4756 $dots = true; 4757 elseif ( $dots && ! $args['show_all'] ) : 4758 $page_links[] = '<span class="page-numbers dots">' . __( '…' ) . '</span>'; 4759 4760 $dots = false; 4761 endif; 4762 endif; 4763 endfor; 4764 4765 if ( $args['prev_next'] && $current && $current < $total ) : 4766 $link = str_replace( '%_%', $args['format'], $args['base'] ); 4767 $link = str_replace( '%#%', $current + 1, $link ); 4768 if ( $add_args ) { 4769 $link = add_query_arg( $add_args, $link ); 4770 } 4771 $link .= $args['add_fragment']; 4772 4773 $page_links[] = sprintf( 4774 '<a class="next page-numbers" href="%s">%s</a>', 4775 /** This filter is documented in wp-includes/general-template.php */ 4776 esc_url( apply_filters( 'paginate_links', $link ) ), 4777 $args['next_text'] 4778 ); 4779 endif; 4780 4781 switch ( $args['type'] ) { 4782 case 'array': 4783 return $page_links; 4784 4785 case 'list': 4786 $r .= "<ul class='page-numbers'>\n\t<li>"; 4787 $r .= implode( "</li>\n\t<li>", $page_links ); 4788 $r .= "</li>\n</ul>\n"; 4789 break; 4790 4791 default: 4792 $r = implode( "\n", $page_links ); 4793 break; 4794 } 4795 4796 /** 4797 * Filters the HTML output of paginated links for archives. 4798 * 4799 * @since 5.7.0 4800 * 4801 * @param string $r HTML output. 4802 * @param array $args An array of arguments. See paginate_links() 4803 * for information on accepted arguments. 4804 */ 4805 $r = apply_filters( 'paginate_links_output', $r, $args ); 4806 4807 return $r; 4808 } 4809 4810 /** 4811 * Registers an admin color scheme css file. 4812 * 4813 * Allows a plugin to register a new admin color scheme. For example: 4814 * 4815 * wp_admin_css_color( 'classic', __( 'Classic' ), admin_url( "css/colors-classic.css" ), array( 4816 * '#07273E', '#14568A', '#D54E21', '#2683AE' 4817 * ) ); 4818 * 4819 * @since 2.5.0 4820 * 4821 * @global array $_wp_admin_css_colors 4822 * 4823 * @param string $key The unique key for this theme. 4824 * @param string $name The name of the theme. 4825 * @param string $url The URL of the CSS file containing the color scheme. 4826 * @param array $colors Optional. An array of CSS color definition strings which are used 4827 * to give the user a feel for the theme. 4828 * @param array $icons { 4829 * Optional. CSS color definitions used to color any SVG icons. 4830 * 4831 * @type string $base SVG icon base color. 4832 * @type string $focus SVG icon color on focus. 4833 * @type string $current SVG icon color of current admin menu link. 4834 * } 4835 */ 4836 function wp_admin_css_color( $key, $name, $url, $colors = array(), $icons = array() ) { 4837 global $_wp_admin_css_colors; 4838 4839 if ( ! isset( $_wp_admin_css_colors ) ) { 4840 $_wp_admin_css_colors = array(); 4841 } 4842 4843 $_wp_admin_css_colors[ $key ] = (object) array( 4844 'name' => $name, 4845 'url' => $url, 4846 'colors' => $colors, 4847 'icon_colors' => $icons, 4848 ); 4849 } 4850 4851 /** 4852 * Registers the default admin color schemes. 4853 * 4854 * Registers the initial set of eight color schemes in the Profile section 4855 * of the dashboard which allows for styling the admin menu and toolbar. 4856 * 4857 * @see wp_admin_css_color() 4858 * 4859 * @since 3.0.0 4860 */ 4861 function register_admin_color_schemes() { 4862 $suffix = is_rtl() ? '-rtl' : ''; 4863 $suffix .= SCRIPT_DEBUG ? '' : '.min'; 4864 4865 wp_admin_css_color( 4866 'fresh', 4867 _x( 'Default', 'admin color scheme' ), 4868 false, 4869 array( '#1d2327', '#2c3338', '#2271b1', '#72aee6' ), 4870 array( 4871 'base' => '#a7aaad', 4872 'focus' => '#72aee6', 4873 'current' => '#fff', 4874 ) 4875 ); 4876 4877 wp_admin_css_color( 4878 'light', 4879 _x( 'Light', 'admin color scheme' ), 4880 admin_url( "css/colors/light/colors$suffix.css" ), 4881 array( '#e5e5e5', '#999', '#d64e07', '#04a4cc' ), 4882 array( 4883 'base' => '#999', 4884 'focus' => '#ccc', 4885 'current' => '#ccc', 4886 ) 4887 ); 4888 4889 wp_admin_css_color( 4890 'modern', 4891 _x( 'Modern', 'admin color scheme' ), 4892 admin_url( "css/colors/modern/colors$suffix.css" ), 4893 array( '#1e1e1e', '#3858e9', '#7b90ff' ), 4894 array( 4895 'base' => '#f3f1f1', 4896 'focus' => '#fff', 4897 'current' => '#fff', 4898 ) 4899 ); 4900 4901 wp_admin_css_color( 4902 'blue', 4903 _x( 'Blue', 'admin color scheme' ), 4904 admin_url( "css/colors/blue/colors$suffix.css" ), 4905 array( '#096484', '#4796b3', '#52accc', '#74B6CE' ), 4906 array( 4907 'base' => '#e5f8ff', 4908 'focus' => '#fff', 4909 'current' => '#fff', 4910 ) 4911 ); 4912 4913 wp_admin_css_color( 4914 'midnight', 4915 _x( 'Midnight', 'admin color scheme' ), 4916 admin_url( "css/colors/midnight/colors$suffix.css" ), 4917 array( '#25282b', '#363b3f', '#69a8bb', '#e14d43' ), 4918 array( 4919 'base' => '#f1f2f3', 4920 'focus' => '#fff', 4921 'current' => '#fff', 4922 ) 4923 ); 4924 4925 wp_admin_css_color( 4926 'sunrise', 4927 _x( 'Sunrise', 'admin color scheme' ), 4928 admin_url( "css/colors/sunrise/colors$suffix.css" ), 4929 array( '#b43c38', '#cf4944', '#dd823b', '#ccaf0b' ), 4930 array( 4931 'base' => '#f3f1f1', 4932 'focus' => '#fff', 4933 'current' => '#fff', 4934 ) 4935 ); 4936 4937 wp_admin_css_color( 4938 'ectoplasm', 4939 _x( 'Ectoplasm', 'admin color scheme' ), 4940 admin_url( "css/colors/ectoplasm/colors$suffix.css" ), 4941 array( '#413256', '#523f6d', '#a3b745', '#d46f15' ), 4942 array( 4943 'base' => '#ece6f6', 4944 'focus' => '#fff', 4945 'current' => '#fff', 4946 ) 4947 ); 4948 4949 wp_admin_css_color( 4950 'ocean', 4951 _x( 'Ocean', 'admin color scheme' ), 4952 admin_url( "css/colors/ocean/colors$suffix.css" ), 4953 array( '#627c83', '#738e96', '#9ebaa0', '#aa9d88' ), 4954 array( 4955 'base' => '#f2fcff', 4956 'focus' => '#fff', 4957 'current' => '#fff', 4958 ) 4959 ); 4960 4961 wp_admin_css_color( 4962 'coffee', 4963 _x( 'Coffee', 'admin color scheme' ), 4964 admin_url( "css/colors/coffee/colors$suffix.css" ), 4965 array( '#46403c', '#59524c', '#c7a589', '#9ea476' ), 4966 array( 4967 'base' => '#f3f2f1', 4968 'focus' => '#fff', 4969 'current' => '#fff', 4970 ) 4971 ); 4972 } 4973 4974 /** 4975 * Displays the URL of a WordPress admin CSS file. 4976 * 4977 * @see WP_Styles::_css_href() and its {@see 'style_loader_src'} filter. 4978 * 4979 * @since 2.3.0 4980 * 4981 * @param string $file file relative to wp-admin/ without its ".css" extension. 4982 * @return string 4983 */ 4984 function wp_admin_css_uri( $file = 'wp-admin' ) { 4985 if ( defined( 'WP_INSTALLING' ) ) { 4986 $_file = "./$file.css"; 4987 } else { 4988 $_file = admin_url( "$file.css" ); 4989 } 4990 $_file = add_query_arg( 'version', get_bloginfo( 'version' ), $_file ); 4991 4992 /** 4993 * Filters the URI of a WordPress admin CSS file. 4994 * 4995 * @since 2.3.0 4996 * 4997 * @param string $_file Relative path to the file with query arguments attached. 4998 * @param string $file Relative path to the file, minus its ".css" extension. 4999 */ 5000 return apply_filters( 'wp_admin_css_uri', $_file, $file ); 5001 } 5002 5003 /** 5004 * Enqueues or directly prints a stylesheet link to the specified CSS file. 5005 * 5006 * "Intelligently" decides to enqueue or to print the CSS file. If the 5007 * {@see 'wp_print_styles'} action has *not* yet been called, the CSS file will be 5008 * enqueued. If the {@see 'wp_print_styles'} action has been called, the CSS link will 5009 * be printed. Printing may be forced by passing true as the $force_echo 5010 * (second) parameter. 5011 * 5012 * For backward compatibility with WordPress 2.3 calling method: If the $file 5013 * (first) parameter does not correspond to a registered CSS file, we assume 5014 * $file is a file relative to wp-admin/ without its ".css" extension. A 5015 * stylesheet link to that generated URL is printed. 5016 * 5017 * @since 2.3.0 5018 * 5019 * @param string $file Optional. Style handle name or file name (without ".css" extension) relative 5020 * to wp-admin/. Defaults to 'wp-admin'. 5021 * @param bool $force_echo Optional. Force the stylesheet link to be printed rather than enqueued. 5022 */ 5023 function wp_admin_css( $file = 'wp-admin', $force_echo = false ) { 5024 // For backward compatibility. 5025 $handle = str_starts_with( $file, 'css/' ) ? substr( $file, 4 ) : $file; 5026 5027 if ( wp_styles()->query( $handle ) ) { 5028 if ( $force_echo || did_action( 'wp_print_styles' ) ) { 5029 // We already printed the style queue. Print this one immediately. 5030 wp_print_styles( $handle ); 5031 } else { 5032 // Add to style queue. 5033 wp_enqueue_style( $handle ); 5034 } 5035 return; 5036 } 5037 5038 $stylesheet_link = sprintf( 5039 "<link rel='stylesheet' href='%s' type='text/css' />\n", 5040 esc_url( wp_admin_css_uri( $file ) ) 5041 ); 5042 5043 /** 5044 * Filters the stylesheet link to the specified CSS file. 5045 * 5046 * If the site is set to display right-to-left, the RTL stylesheet link 5047 * will be used instead. 5048 * 5049 * @since 2.3.0 5050 * @param string $stylesheet_link HTML link element for the stylesheet. 5051 * @param string $file Style handle name or filename (without ".css" extension) 5052 * relative to wp-admin/. Defaults to 'wp-admin'. 5053 */ 5054 echo apply_filters( 'wp_admin_css', $stylesheet_link, $file ); 5055 5056 if ( function_exists( 'is_rtl' ) && is_rtl() ) { 5057 $rtl_stylesheet_link = sprintf( 5058 "<link rel='stylesheet' href='%s' type='text/css' />\n", 5059 esc_url( wp_admin_css_uri( "$file-rtl" ) ) 5060 ); 5061 5062 /** This filter is documented in wp-includes/general-template.php */ 5063 echo apply_filters( 'wp_admin_css', $rtl_stylesheet_link, "$file-rtl" ); 5064 } 5065 } 5066 5067 /** 5068 * Enqueues the default ThickBox js and css. 5069 * 5070 * If any of the settings need to be changed, this can be done with another js 5071 * file similar to media-upload.js. That file should 5072 * require array('thickbox') to ensure it is loaded after. 5073 * 5074 * @since 2.5.0 5075 */ 5076 function add_thickbox() { 5077 wp_enqueue_script( 'thickbox' ); 5078 wp_enqueue_style( 'thickbox' ); 5079 5080 if ( is_network_admin() ) { 5081 add_action( 'admin_head', '_thickbox_path_admin_subfolder' ); 5082 } 5083 } 5084 5085 /** 5086 * Displays the XHTML generator that is generated on the wp_head hook. 5087 * 5088 * See {@see 'wp_head'}. 5089 * 5090 * @since 2.5.0 5091 */ 5092 function wp_generator() { 5093 /** 5094 * Filters the output of the XHTML generator tag. 5095 * 5096 * @since 2.5.0 5097 * 5098 * @param string $generator_type The XHTML generator. 5099 */ 5100 the_generator( apply_filters( 'wp_generator_type', 'xhtml' ) ); 5101 } 5102 5103 /** 5104 * Displays the generator XML or Comment for RSS, ATOM, etc. 5105 * 5106 * Returns the correct generator type for the requested output format. Allows 5107 * for a plugin to filter generators overall the {@see 'the_generator'} filter. 5108 * 5109 * @since 2.5.0 5110 * 5111 * @param string $type The type of generator to output - (html|xhtml|atom|rss2|rdf|comment|export). 5112 */ 5113 function the_generator( $type ) { 5114 /** 5115 * Filters the output of the XHTML generator tag, for display. 5116 * 5117 * @since 2.5.0 5118 * 5119 * @param string $generator_type The generator output. 5120 * @param string $type The type of generator to output. Accepts 'html', 5121 * 'xhtml', 'atom', 'rss2', 'rdf', 'comment', 'export'. 5122 */ 5123 echo apply_filters( 'the_generator', get_the_generator( $type ), $type ) . "\n"; 5124 } 5125 5126 /** 5127 * Creates the generator XML or Comment for RSS, ATOM, etc. 5128 * 5129 * Returns the correct generator type for the requested output format. Allows 5130 * for a plugin to filter generators on an individual basis using the 5131 * {@see 'get_the_generator_$type'} filter. 5132 * 5133 * @since 2.5.0 5134 * 5135 * @param string $type The type of generator to return - (html|xhtml|atom|rss2|rdf|comment|export). 5136 * @return string|void The HTML content for the generator. 5137 */ 5138 function get_the_generator( $type = '' ) { 5139 if ( empty( $type ) ) { 5140 5141 $current_filter = current_filter(); 5142 if ( empty( $current_filter ) ) { 5143 return; 5144 } 5145 5146 switch ( $current_filter ) { 5147 case 'rss2_head': 5148 case 'commentsrss2_head': 5149 $type = 'rss2'; 5150 break; 5151 case 'rss_head': 5152 case 'opml_head': 5153 $type = 'comment'; 5154 break; 5155 case 'rdf_header': 5156 $type = 'rdf'; 5157 break; 5158 case 'atom_head': 5159 case 'comments_atom_head': 5160 case 'app_head': 5161 $type = 'atom'; 5162 break; 5163 } 5164 } 5165 5166 switch ( $type ) { 5167 case 'html': 5168 $gen = '<meta name="generator" content="WordPress ' . esc_attr( get_bloginfo( 'version' ) ) . '">'; 5169 break; 5170 case 'xhtml': 5171 $gen = '<meta name="generator" content="WordPress ' . esc_attr( get_bloginfo( 'version' ) ) . '" />'; 5172 break; 5173 case 'atom': 5174 $gen = '<generator uri="https://wordpress.org/" version="' . esc_attr( get_bloginfo_rss( 'version' ) ) . '">WordPress</generator>'; 5175 break; 5176 case 'rss2': 5177 $gen = '<generator>' . sanitize_url( 'https://wordpress.org/?v=' . get_bloginfo_rss( 'version' ) ) . '</generator>'; 5178 break; 5179 case 'rdf': 5180 $gen = '<admin:generatorAgent rdf:resource="' . sanitize_url( 'https://wordpress.org/?v=' . get_bloginfo_rss( 'version' ) ) . '" />'; 5181 break; 5182 case 'comment': 5183 $gen = '<!-- generator="WordPress/' . esc_attr( get_bloginfo( 'version' ) ) . '" -->'; 5184 break; 5185 case 'export': 5186 $gen = '<!-- generator="WordPress/' . esc_attr( get_bloginfo_rss( 'version' ) ) . '" created="' . gmdate( 'Y-m-d H:i' ) . '" -->'; 5187 break; 5188 } 5189 5190 /** 5191 * Filters the HTML for the retrieved generator type. 5192 * 5193 * The dynamic portion of the hook name, `$type`, refers to the generator type. 5194 * 5195 * Possible hook names include: 5196 * 5197 * - `get_the_generator_atom` 5198 * - `get_the_generator_comment` 5199 * - `get_the_generator_export` 5200 * - `get_the_generator_html` 5201 * - `get_the_generator_rdf` 5202 * - `get_the_generator_rss2` 5203 * - `get_the_generator_xhtml` 5204 * 5205 * @since 2.5.0 5206 * 5207 * @param string $gen The HTML markup output to wp_head(). 5208 * @param string $type The type of generator. Accepts 'html', 'xhtml', 'atom', 5209 * 'rss2', 'rdf', 'comment', 'export'. 5210 */ 5211 return apply_filters( "get_the_generator_{$type}", $gen, $type ); 5212 } 5213 5214 /** 5215 * Outputs the HTML checked attribute. 5216 * 5217 * Compares the first two arguments and if identical marks as checked. 5218 * 5219 * @since 1.0.0 5220 * 5221 * @param mixed $checked One of the values to compare. 5222 * @param mixed $current Optional. The other value to compare if not just true. 5223 * Default true. 5224 * @param bool $display Optional. Whether to echo or just return the string. 5225 * Default true. 5226 * @return string HTML attribute or empty string. 5227 */ 5228 function checked( $checked, $current = true, $display = true ) { 5229 return __checked_selected_helper( $checked, $current, $display, 'checked' ); 5230 } 5231 5232 /** 5233 * Outputs the HTML selected attribute. 5234 * 5235 * Compares the first two arguments and if identical marks as selected. 5236 * 5237 * @since 1.0.0 5238 * 5239 * @param mixed $selected One of the values to compare. 5240 * @param mixed $current Optional. The other value to compare if not just true. 5241 * Default true. 5242 * @param bool $display Optional. Whether to echo or just return the string. 5243 * Default true. 5244 * @return string HTML attribute or empty string. 5245 */ 5246 function selected( $selected, $current = true, $display = true ) { 5247 return __checked_selected_helper( $selected, $current, $display, 'selected' ); 5248 } 5249 5250 /** 5251 * Outputs the HTML disabled attribute. 5252 * 5253 * Compares the first two arguments and if identical marks as disabled. 5254 * 5255 * @since 3.0.0 5256 * 5257 * @param mixed $disabled One of the values to compare. 5258 * @param mixed $current Optional. The other value to compare if not just true. 5259 * Default true. 5260 * @param bool $display Optional. Whether to echo or just return the string. 5261 * Default true. 5262 * @return string HTML attribute or empty string. 5263 */ 5264 function disabled( $disabled, $current = true, $display = true ) { 5265 return __checked_selected_helper( $disabled, $current, $display, 'disabled' ); 5266 } 5267 5268 /** 5269 * Outputs the HTML readonly attribute. 5270 * 5271 * Compares the first two arguments and if identical marks as readonly. 5272 * 5273 * @since 5.9.0 5274 * 5275 * @param mixed $readonly_value One of the values to compare. 5276 * @param mixed $current Optional. The other value to compare if not just true. 5277 * Default true. 5278 * @param bool $display Optional. Whether to echo or just return the string. 5279 * Default true. 5280 * @return string HTML attribute or empty string. 5281 */ 5282 function wp_readonly( $readonly_value, $current = true, $display = true ) { 5283 return __checked_selected_helper( $readonly_value, $current, $display, 'readonly' ); 5284 } 5285 5286 /* 5287 * Include a compat `readonly()` function on PHP < 8.1. Since PHP 8.1, 5288 * `readonly` is a reserved keyword and cannot be used as a function name. 5289 * In order to avoid PHP parser errors, this function was extracted 5290 * to a separate file and is only included conditionally on PHP < 8.1. 5291 */ 5292 if ( PHP_VERSION_ID < 80100 ) { 5293 require_once __DIR__ . '/php-compat/readonly.php'; 5294 } 5295 5296 /** 5297 * Private helper function for checked, selected, disabled and readonly. 5298 * 5299 * Compares the first two arguments and if identical marks as `$type`. 5300 * 5301 * @since 2.8.0 5302 * @access private 5303 * 5304 * @param mixed $helper One of the values to compare. 5305 * @param mixed $current The other value to compare if not just true. 5306 * @param bool $display Whether to echo or just return the string. 5307 * @param string $type The type of checked|selected|disabled|readonly we are doing. 5308 * @return string HTML attribute or empty string. 5309 */ 5310 function __checked_selected_helper( $helper, $current, $display, $type ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore 5311 if ( (string) $helper === (string) $current ) { 5312 $result = " $type='$type'"; 5313 } else { 5314 $result = ''; 5315 } 5316 5317 if ( $display ) { 5318 echo $result; 5319 } 5320 5321 return $result; 5322 } 5323 5324 /** 5325 * Assigns a visual indicator for required form fields. 5326 * 5327 * @since 6.1.0 5328 * 5329 * @return string Indicator glyph wrapped in a `span` tag. 5330 */ 5331 function wp_required_field_indicator() { 5332 /* translators: Character to identify required form fields. */ 5333 $glyph = __( '*' ); 5334 $indicator = '<span class="required">' . esc_html( $glyph ) . '</span>'; 5335 5336 /** 5337 * Filters the markup for a visual indicator of required form fields. 5338 * 5339 * @since 6.1.0 5340 * 5341 * @param string $indicator Markup for the indicator element. 5342 */ 5343 return apply_filters( 'wp_required_field_indicator', $indicator ); 5344 } 5345 5346 /** 5347 * Creates a message to explain required form fields. 5348 * 5349 * @since 6.1.0 5350 * 5351 * @return string Message text and glyph wrapped in a `span` tag. 5352 */ 5353 function wp_required_field_message() { 5354 $message = sprintf( 5355 '<span class="required-field-message">%s</span>', 5356 /* translators: %s: Asterisk symbol (*). */ 5357 sprintf( __( 'Required fields are marked %s' ), wp_required_field_indicator() ) 5358 ); 5359 5360 /** 5361 * Filters the message to explain required form fields. 5362 * 5363 * @since 6.1.0 5364 * 5365 * @param string $message Message text and glyph wrapped in a `span` tag. 5366 */ 5367 return apply_filters( 'wp_required_field_message', $message ); 5368 } 5369 5370 /** 5371 * Default settings for heartbeat. 5372 * 5373 * Outputs the nonce used in the heartbeat XHR. 5374 * 5375 * @since 3.6.0 5376 * 5377 * @param array $settings 5378 * @return array Heartbeat settings. 5379 */ 5380 function wp_heartbeat_settings( $settings ) { 5381 if ( ! is_admin() ) { 5382 $settings['ajaxurl'] = admin_url( 'admin-ajax.php', 'relative' ); 5383 } 5384 5385 if ( is_user_logged_in() ) { 5386 $settings['nonce'] = wp_create_nonce( 'heartbeat-nonce' ); 5387 } 5388 5389 return $settings; 5390 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Sun Mar 9 08:20:01 2025 | Cross-referenced by PHPXref |