| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Misc WordPress Administration API. 4 * 5 * @package WordPress 6 * @subpackage Administration 7 */ 8 9 /** 10 * Returns whether the server is running Apache with the mod_rewrite module loaded. 11 * 12 * @since 2.0.0 13 * 14 * @return bool Whether the server is running Apache with the mod_rewrite module loaded. 15 */ 16 function got_mod_rewrite() { 17 $got_rewrite = apache_mod_loaded( 'mod_rewrite', true ); 18 19 /** 20 * Filters whether Apache and mod_rewrite are present. 21 * 22 * This filter was previously used to force URL rewriting for other servers, 23 * like nginx. Use the {@see 'got_url_rewrite'} filter in got_url_rewrite() instead. 24 * 25 * @since 2.5.0 26 * 27 * @see got_url_rewrite() 28 * 29 * @param bool $got_rewrite Whether Apache and mod_rewrite are present. 30 */ 31 return apply_filters( 'got_rewrite', $got_rewrite ); 32 } 33 34 /** 35 * Returns whether the server supports URL rewriting. 36 * 37 * Detects Apache's mod_rewrite, IIS 7.0+ permalink support, and nginx. 38 * 39 * @since 3.7.0 40 * 41 * @global bool $is_nginx 42 * @global bool $is_caddy 43 * 44 * @return bool Whether the server supports URL rewriting. 45 */ 46 function got_url_rewrite() { 47 $got_url_rewrite = ( got_mod_rewrite() || $GLOBALS['is_nginx'] || $GLOBALS['is_caddy'] || iis7_supports_permalinks() ); 48 49 /** 50 * Filters whether URL rewriting is available. 51 * 52 * @since 3.7.0 53 * 54 * @param bool $got_url_rewrite Whether URL rewriting is available. 55 */ 56 return apply_filters( 'got_url_rewrite', $got_url_rewrite ); 57 } 58 59 /** 60 * Extracts strings from between the BEGIN and END markers in the .htaccess file. 61 * 62 * @since 1.5.0 63 * 64 * @param string $filename Filename to extract the strings from. 65 * @param string $marker The marker to extract the strings from. 66 * @return string[] An array of strings from a file (.htaccess) from between BEGIN and END markers. 67 */ 68 function extract_from_markers( $filename, $marker ) { 69 $result = array(); 70 71 if ( ! file_exists( $filename ) ) { 72 return $result; 73 } 74 75 $markerdata = explode( "\n", implode( '', file( $filename ) ) ); 76 77 $state = false; 78 79 foreach ( $markerdata as $markerline ) { 80 if ( str_contains( $markerline, '# END ' . $marker ) ) { 81 $state = false; 82 } 83 84 if ( $state ) { 85 if ( str_starts_with( $markerline, '#' ) ) { 86 continue; 87 } 88 89 $result[] = $markerline; 90 } 91 92 if ( str_contains( $markerline, '# BEGIN ' . $marker ) ) { 93 $state = true; 94 } 95 } 96 97 return $result; 98 } 99 100 /** 101 * Inserts an array of strings into a file (.htaccess), placing it between 102 * BEGIN and END markers. 103 * 104 * Replaces existing marked info. Retains surrounding 105 * data. Creates file if none exists. 106 * 107 * @since 1.5.0 108 * 109 * @param string $filename Filename to alter. 110 * @param string $marker The marker to alter. 111 * @param array|string $insertion The new content to insert. 112 * @return bool True on write success, false on failure. 113 */ 114 function insert_with_markers( $filename, $marker, $insertion ) { 115 if ( ! file_exists( $filename ) ) { 116 if ( ! is_writable( dirname( $filename ) ) ) { 117 return false; 118 } 119 120 if ( ! touch( $filename ) ) { 121 return false; 122 } 123 124 // Make sure the file is created with a minimum set of permissions. 125 $perms = fileperms( $filename ); 126 127 if ( $perms ) { 128 chmod( $filename, $perms | 0644 ); 129 } 130 } elseif ( ! is_writable( $filename ) ) { 131 return false; 132 } 133 134 if ( ! is_array( $insertion ) ) { 135 $insertion = explode( "\n", $insertion ); 136 } 137 138 $switched_locale = switch_to_locale( get_locale() ); 139 140 $instructions = sprintf( 141 /* translators: 1: Marker. */ 142 __( 143 'The directives (lines) between "BEGIN %1$s" and "END %1$s" are 144 dynamically generated, and should only be modified via WordPress filters. 145 Any changes to the directives between these markers will be overwritten.' 146 ), 147 $marker 148 ); 149 150 $instructions = explode( "\n", $instructions ); 151 152 foreach ( $instructions as $line => $text ) { 153 $instructions[ $line ] = '# ' . $text; 154 } 155 156 /** 157 * Filters the inline instructions inserted before the dynamically generated content. 158 * 159 * @since 5.3.0 160 * 161 * @param string[] $instructions Array of lines with inline instructions. 162 * @param string $marker The marker being inserted. 163 */ 164 $instructions = apply_filters( 'insert_with_markers_inline_instructions', $instructions, $marker ); 165 166 if ( $switched_locale ) { 167 restore_previous_locale(); 168 } 169 170 $insertion = array_merge( $instructions, $insertion ); 171 172 $start_marker = "# BEGIN {$marker}"; 173 $end_marker = "# END {$marker}"; 174 175 $fp = fopen( $filename, 'r+' ); 176 177 if ( ! $fp ) { 178 return false; 179 } 180 181 // Attempt to get a lock. If the filesystem supports locking, this will block until the lock is acquired. 182 flock( $fp, LOCK_EX ); 183 184 $lines = array(); 185 186 while ( ! feof( $fp ) ) { 187 $lines[] = rtrim( fgets( $fp ), "\r\n" ); 188 } 189 190 // Split out the existing file into the preceding lines, and those that appear after the marker. 191 $pre_lines = array(); 192 $post_lines = array(); 193 $existing_lines = array(); 194 $found_marker = false; 195 $found_end_marker = false; 196 197 foreach ( $lines as $line ) { 198 if ( ! $found_marker && str_contains( $line, $start_marker ) ) { 199 $found_marker = true; 200 continue; 201 } elseif ( ! $found_end_marker && str_contains( $line, $end_marker ) ) { 202 $found_end_marker = true; 203 continue; 204 } 205 206 if ( ! $found_marker ) { 207 $pre_lines[] = $line; 208 } elseif ( $found_end_marker ) { 209 $post_lines[] = $line; 210 } else { 211 $existing_lines[] = $line; 212 } 213 } 214 215 // Check to see if there was a change. 216 if ( $existing_lines === $insertion ) { 217 flock( $fp, LOCK_UN ); 218 fclose( $fp ); 219 220 return true; 221 } 222 223 // Generate the new file data. 224 $new_file_data = implode( 225 "\n", 226 array_merge( 227 $pre_lines, 228 array( $start_marker ), 229 $insertion, 230 array( $end_marker ), 231 $post_lines 232 ) 233 ); 234 235 // Write to the start of the file, and truncate it to that length. 236 fseek( $fp, 0 ); 237 $bytes = fwrite( $fp, $new_file_data ); 238 239 if ( $bytes ) { 240 ftruncate( $fp, ftell( $fp ) ); 241 } 242 243 fflush( $fp ); 244 flock( $fp, LOCK_UN ); 245 fclose( $fp ); 246 247 return (bool) $bytes; 248 } 249 250 /** 251 * Updates the htaccess file with the current rules if it is writable. 252 * 253 * Always writes to the file if it exists and is writable to ensure that we 254 * blank out old rules. 255 * 256 * @since 1.5.0 257 * 258 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 259 * 260 * @return bool|null True on write success, false on failure. Null in multisite. 261 */ 262 function save_mod_rewrite_rules() { 263 global $wp_rewrite; 264 265 if ( is_multisite() ) { 266 return null; 267 } 268 269 // Ensure get_home_path() is declared. 270 require_once ABSPATH . 'wp-admin/includes/file.php'; 271 272 $home_path = get_home_path(); 273 $htaccess_file = $home_path . '.htaccess'; 274 275 /* 276 * If the file doesn't already exist check for write access to the directory 277 * and whether we have some rules. Else check for write access to the file. 278 */ 279 if ( ! file_exists( $htaccess_file ) && is_writable( $home_path ) && $wp_rewrite->using_mod_rewrite_permalinks() 280 || is_writable( $htaccess_file ) 281 ) { 282 if ( got_mod_rewrite() ) { 283 $rules = explode( "\n", $wp_rewrite->mod_rewrite_rules() ); 284 285 return insert_with_markers( $htaccess_file, 'WordPress', $rules ); 286 } 287 } 288 289 return false; 290 } 291 292 /** 293 * Updates the IIS web.config file with the current rules if it is writable. 294 * If the permalinks do not require rewrite rules then the rules are deleted from the web.config file. 295 * 296 * @since 2.8.0 297 * 298 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 299 * 300 * @return bool|null True on write success, false on failure. Null in multisite. 301 */ 302 function iis7_save_url_rewrite_rules() { 303 global $wp_rewrite; 304 305 if ( is_multisite() ) { 306 return null; 307 } 308 309 // Ensure get_home_path() is declared. 310 require_once ABSPATH . 'wp-admin/includes/file.php'; 311 312 $home_path = get_home_path(); 313 $web_config_file = $home_path . 'web.config'; 314 315 // Using win_is_writable() instead of is_writable() because of a bug in Windows PHP. 316 if ( iis7_supports_permalinks() 317 && ( ! file_exists( $web_config_file ) && win_is_writable( $home_path ) && $wp_rewrite->using_mod_rewrite_permalinks() 318 || win_is_writable( $web_config_file ) ) 319 ) { 320 $rule = $wp_rewrite->iis7_url_rewrite_rules( false ); 321 322 if ( ! empty( $rule ) ) { 323 return iis7_add_rewrite_rule( $web_config_file, $rule ); 324 } else { 325 return iis7_delete_rewrite_rule( $web_config_file ); 326 } 327 } 328 329 return false; 330 } 331 332 /** 333 * Updates the "recently-edited" file for the plugin or theme file editor. 334 * 335 * @since 1.5.0 336 * 337 * @param string $file Path to the recently edited file. 338 */ 339 function update_recently_edited( $file ) { 340 $oldfiles = (array) get_option( 'recently_edited' ); 341 342 if ( $oldfiles ) { 343 $oldfiles = array_reverse( $oldfiles ); 344 $oldfiles[] = $file; 345 $oldfiles = array_reverse( $oldfiles ); 346 $oldfiles = array_unique( $oldfiles ); 347 348 if ( 5 < count( $oldfiles ) ) { 349 array_pop( $oldfiles ); 350 } 351 } else { 352 $oldfiles[] = $file; 353 } 354 355 update_option( 'recently_edited', $oldfiles ); 356 } 357 358 /** 359 * Makes a tree structure for the theme file editor's file list. 360 * 361 * @since 4.9.0 362 * @access private 363 * 364 * @param array $allowed_files List of theme file paths. 365 * @return array Tree structure for listing theme files. 366 */ 367 function wp_make_theme_file_tree( $allowed_files ) { 368 $tree_list = array(); 369 370 foreach ( $allowed_files as $file_name => $absolute_filename ) { 371 $list = explode( '/', $file_name ); 372 $last_dir = &$tree_list; 373 374 foreach ( $list as $dir ) { 375 $last_dir =& $last_dir[ $dir ]; 376 } 377 378 $last_dir = $file_name; 379 } 380 381 return $tree_list; 382 } 383 384 /** 385 * Outputs the formatted file list for the theme file editor. 386 * 387 * @since 4.9.0 388 * @access private 389 * 390 * @global string $relative_file Name of the file being edited relative to the 391 * theme directory. 392 * @global string $stylesheet The stylesheet name of the theme being edited. 393 * 394 * @param array|string $tree List of file/folder paths, or filename. 395 * @param int $level The aria-level for the current iteration. 396 * @param int $size The aria-setsize for the current iteration. 397 * @param int $index The aria-posinset for the current iteration. 398 */ 399 function wp_print_theme_file_tree( $tree, $level = 2, $size = 1, $index = 1 ) { 400 global $relative_file, $stylesheet; 401 402 if ( is_array( $tree ) ) { 403 $index = 0; 404 $size = count( $tree ); 405 406 foreach ( $tree as $label => $theme_file ) : 407 ++$index; 408 409 if ( ! is_array( $theme_file ) ) { 410 wp_print_theme_file_tree( $theme_file, $level, $index, $size ); 411 continue; 412 } 413 ?> 414 <li role="treeitem" aria-expanded="true" tabindex="-1" 415 aria-level="<?php echo esc_attr( $level ); ?>" 416 aria-setsize="<?php echo esc_attr( $size ); ?>" 417 aria-posinset="<?php echo esc_attr( $index ); ?>"> 418 <span class="folder-label"><?php echo esc_html( $label ); ?> <span class="screen-reader-text"> 419 <?php 420 /* translators: Hidden accessibility text. */ 421 _e( 'folder' ); 422 ?> 423 </span><span aria-hidden="true" class="icon"></span></span> 424 <ul role="group" class="tree-folder"><?php wp_print_theme_file_tree( $theme_file, $level + 1, $index, $size ); ?></ul> 425 </li> 426 <?php 427 endforeach; 428 } else { 429 $filename = $tree; 430 $url = add_query_arg( 431 array( 432 'file' => rawurlencode( $tree ), 433 'theme' => rawurlencode( $stylesheet ), 434 ), 435 self_admin_url( 'theme-editor.php' ) 436 ); 437 ?> 438 <li role="none" class="<?php echo esc_attr( $relative_file === $filename ? 'current-file' : '' ); ?>"> 439 <a role="treeitem" tabindex="<?php echo esc_attr( $relative_file === $filename ? '0' : '-1' ); ?>" 440 href="<?php echo esc_url( $url ); ?>" 441 aria-level="<?php echo esc_attr( $level ); ?>" 442 aria-setsize="<?php echo esc_attr( $size ); ?>" 443 aria-posinset="<?php echo esc_attr( $index ); ?>"> 444 <?php 445 $file_description = esc_html( get_file_description( $filename ) ); 446 447 if ( $file_description !== $filename && wp_basename( $filename ) !== $file_description ) { 448 $file_description .= '<br /><span class="nonessential">(' . esc_html( $filename ) . ')</span>'; 449 } 450 451 if ( $relative_file === $filename ) { 452 echo '<span class="notice notice-info">' . $file_description . '</span>'; 453 } else { 454 echo $file_description; 455 } 456 ?> 457 </a> 458 </li> 459 <?php 460 } 461 } 462 463 /** 464 * Makes a tree structure for the plugin file editor's file list. 465 * 466 * @since 4.9.0 467 * @access private 468 * 469 * @param array $plugin_editable_files List of plugin file paths. 470 * @return array Tree structure for listing plugin files. 471 */ 472 function wp_make_plugin_file_tree( $plugin_editable_files ) { 473 $tree_list = array(); 474 475 foreach ( $plugin_editable_files as $plugin_file ) { 476 $list = explode( '/', preg_replace( '#^.+?/#', '', $plugin_file ) ); 477 $last_dir = &$tree_list; 478 479 foreach ( $list as $dir ) { 480 $last_dir =& $last_dir[ $dir ]; 481 } 482 483 $last_dir = $plugin_file; 484 } 485 486 return $tree_list; 487 } 488 489 /** 490 * Outputs the formatted file list for the plugin file editor. 491 * 492 * @since 4.9.0 493 * @access private 494 * 495 * @global string $file Path to the file being edited. 496 * @global string $plugin Path to the plugin file relative to the plugins directory. 497 * 498 * @param array|string $tree List of file/folder paths, or filename. 499 * @param string $label Name of file or folder to print. 500 * @param int $level The aria-level for the current iteration. 501 * @param int $size The aria-setsize for the current iteration. 502 * @param int $index The aria-posinset for the current iteration. 503 */ 504 function wp_print_plugin_file_tree( $tree, $label = '', $level = 2, $size = 1, $index = 1 ) { 505 global $file, $plugin; 506 507 if ( is_array( $tree ) ) { 508 $index = 0; 509 $size = count( $tree ); 510 511 foreach ( $tree as $label => $plugin_file ) : 512 ++$index; 513 514 if ( ! is_array( $plugin_file ) ) { 515 wp_print_plugin_file_tree( $plugin_file, $label, $level, $index, $size ); 516 continue; 517 } 518 ?> 519 <li role="treeitem" aria-expanded="true" tabindex="-1" 520 aria-level="<?php echo esc_attr( $level ); ?>" 521 aria-setsize="<?php echo esc_attr( $size ); ?>" 522 aria-posinset="<?php echo esc_attr( $index ); ?>"> 523 <span class="folder-label"><?php echo esc_html( $label ); ?> <span class="screen-reader-text"> 524 <?php 525 /* translators: Hidden accessibility text. */ 526 _e( 'folder' ); 527 ?> 528 </span><span aria-hidden="true" class="icon"></span></span> 529 <ul role="group" class="tree-folder"><?php wp_print_plugin_file_tree( $plugin_file, '', $level + 1, $index, $size ); ?></ul> 530 </li> 531 <?php 532 endforeach; 533 } else { 534 $url = add_query_arg( 535 array( 536 'file' => rawurlencode( $tree ), 537 'plugin' => rawurlencode( $plugin ), 538 ), 539 self_admin_url( 'plugin-editor.php' ) 540 ); 541 ?> 542 <li role="none" class="<?php echo esc_attr( $file === $tree ? 'current-file' : '' ); ?>"> 543 <a role="treeitem" tabindex="<?php echo esc_attr( $file === $tree ? '0' : '-1' ); ?>" 544 href="<?php echo esc_url( $url ); ?>" 545 aria-level="<?php echo esc_attr( $level ); ?>" 546 aria-setsize="<?php echo esc_attr( $size ); ?>" 547 aria-posinset="<?php echo esc_attr( $index ); ?>"> 548 <?php 549 if ( $file === $tree ) { 550 echo '<span class="notice notice-info">' . esc_html( $label ) . '</span>'; 551 } else { 552 echo esc_html( $label ); 553 } 554 ?> 555 </a> 556 </li> 557 <?php 558 } 559 } 560 561 /** 562 * Flushes rewrite rules if `siteurl`, `home` or `page_on_front` changed. 563 * 564 * @since 2.1.0 565 * 566 * @param string $old_value The old value of the option. Unused. 567 * @param string $value The new value of the option. Unused. 568 */ 569 function update_home_siteurl( $old_value, $value ) { 570 if ( wp_installing() ) { 571 return; 572 } 573 574 if ( is_multisite() && ms_is_switched() ) { 575 delete_option( 'rewrite_rules' ); 576 } else { 577 flush_rewrite_rules(); 578 } 579 } 580 581 /** 582 * Resets global variables based on `$_GET` and `$_POST`. 583 * 584 * This function resets global variables based on the names passed 585 * in the `$vars` array to the value of `$_POST[$var]` or `$_GET[$var]` or an 586 * empty string if neither is defined. 587 * 588 * @since 2.0.0 589 * 590 * @param array $vars An array of globals to reset. 591 */ 592 function wp_reset_vars( $vars ) { 593 foreach ( $vars as $var ) { 594 if ( empty( $_POST[ $var ] ) ) { 595 if ( empty( $_GET[ $var ] ) ) { 596 $GLOBALS[ $var ] = ''; 597 } else { 598 $GLOBALS[ $var ] = $_GET[ $var ]; 599 } 600 } else { 601 $GLOBALS[ $var ] = $_POST[ $var ]; 602 } 603 } 604 } 605 606 /** 607 * Displays the given administration message. 608 * 609 * @since 2.1.0 610 * 611 * @param string|WP_Error $message The message to display, or a WP_Error object. 612 */ 613 function show_message( $message ) { 614 if ( is_wp_error( $message ) ) { 615 if ( $message->get_error_data() && is_string( $message->get_error_data() ) ) { 616 $message = $message->get_error_message() . ': ' . $message->get_error_data(); 617 } else { 618 $message = $message->get_error_message(); 619 } 620 } 621 622 echo "<p>$message</p>\n"; 623 wp_ob_end_flush_all(); 624 flush(); 625 } 626 627 /** 628 * Parses the PHP content and finds function calls to be used for documentation linking. 629 * 630 * @since 2.8.0 631 * 632 * @param string $content The PHP content to parse. 633 * @return string[] Array of function names. 634 */ 635 function wp_doc_link_parse( $content ) { 636 if ( ! is_string( $content ) || empty( $content ) ) { 637 return array(); 638 } 639 640 if ( ! function_exists( 'token_get_all' ) ) { 641 return array(); 642 } 643 644 $tokens = token_get_all( $content ); 645 $count = count( $tokens ); 646 $functions = array(); 647 $ignore_functions = array(); 648 649 for ( $t = 0; $t < $count - 2; $t++ ) { 650 if ( ! is_array( $tokens[ $t ] ) ) { 651 continue; 652 } 653 654 if ( T_STRING === $tokens[ $t ][0] && ( '(' === $tokens[ $t + 1 ] || '(' === $tokens[ $t + 2 ] ) ) { 655 // If it's a function or class defined locally, there's not going to be any docs available. 656 if ( ( isset( $tokens[ $t - 2 ][1] ) && in_array( $tokens[ $t - 2 ][1], array( 'function', 'class' ), true ) ) 657 || ( isset( $tokens[ $t - 2 ][0] ) && T_OBJECT_OPERATOR === $tokens[ $t - 1 ][0] ) 658 ) { 659 $ignore_functions[] = $tokens[ $t ][1]; 660 } 661 662 // Add this to our stack of unique references. 663 $functions[] = $tokens[ $t ][1]; 664 } 665 } 666 667 $functions = array_unique( $functions ); 668 sort( $functions ); 669 670 /** 671 * Filters the list of functions and classes to be ignored from the documentation lookup. 672 * 673 * @since 2.8.0 674 * 675 * @param string[] $ignore_functions Array of names of functions and classes to be ignored. 676 */ 677 $ignore_functions = apply_filters( 'documentation_ignore_functions', $ignore_functions ); 678 679 $ignore_functions = array_unique( $ignore_functions ); 680 681 $output = array(); 682 683 foreach ( $functions as $function ) { 684 if ( in_array( $function, $ignore_functions, true ) ) { 685 continue; 686 } 687 688 $output[] = $function; 689 } 690 691 return $output; 692 } 693 694 /** 695 * Saves option for number of rows when listing posts, pages, comments, etc. 696 * 697 * @since 2.8.0 698 */ 699 function set_screen_options() { 700 if ( ! isset( $_POST['wp_screen_options'] ) || ! is_array( $_POST['wp_screen_options'] ) ) { 701 return; 702 } 703 704 check_admin_referer( 'screen-options-nonce', 'screenoptionnonce' ); 705 706 $user = wp_get_current_user(); 707 708 if ( ! $user ) { 709 return; 710 } 711 712 $option = $_POST['wp_screen_options']['option']; 713 $value = $_POST['wp_screen_options']['value']; 714 715 if ( sanitize_key( $option ) !== $option ) { 716 return; 717 } 718 719 $map_option = $option; 720 $type = str_replace( 'edit_', '', $map_option ); 721 $type = str_replace( '_per_page', '', $type ); 722 723 if ( in_array( $type, get_taxonomies(), true ) ) { 724 $map_option = 'edit_tags_per_page'; 725 } elseif ( in_array( $type, get_post_types(), true ) ) { 726 $map_option = 'edit_per_page'; 727 } else { 728 $option = str_replace( '-', '_', $option ); 729 } 730 731 switch ( $map_option ) { 732 case 'edit_per_page': 733 case 'users_per_page': 734 case 'edit_comments_per_page': 735 case 'upload_per_page': 736 case 'edit_tags_per_page': 737 case 'plugins_per_page': 738 case 'export_personal_data_requests_per_page': 739 case 'remove_personal_data_requests_per_page': 740 // Network admin. 741 case 'sites_network_per_page': 742 case 'users_network_per_page': 743 case 'site_users_network_per_page': 744 case 'plugins_network_per_page': 745 case 'themes_network_per_page': 746 case 'site_themes_network_per_page': 747 $value = (int) $value; 748 749 if ( $value < 1 || $value > 999 ) { 750 return; 751 } 752 753 break; 754 755 default: 756 $screen_option = false; 757 758 if ( str_ends_with( $option, '_page' ) || 'layout_columns' === $option ) { 759 /** 760 * Filters a screen option value before it is set. 761 * 762 * The filter can also be used to modify non-standard `[items]_per_page` 763 * settings. See the parent function for a full list of standard options. 764 * 765 * Returning false from the filter will skip saving the current option. 766 * 767 * @since 2.8.0 768 * @since 5.4.2 Only applied to options ending with '_page', 769 * or the 'layout_columns' option. 770 * 771 * @see set_screen_options() 772 * 773 * @param mixed $screen_option The value to save instead of the option value. 774 * Default false (to skip saving the current option). 775 * @param string $option The option name. 776 * @param int $value The option value. 777 */ 778 $screen_option = apply_filters( 'set-screen-option', $screen_option, $option, $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores 779 } 780 781 /** 782 * Filters a screen option value before it is set. 783 * 784 * The dynamic portion of the hook name, `$option`, refers to the option name. 785 * 786 * Returning false from the filter will skip saving the current option. 787 * 788 * @since 5.4.2 789 * 790 * @see set_screen_options() 791 * 792 * @param mixed $screen_option The value to save instead of the option value. 793 * Default false (to skip saving the current option). 794 * @param string $option The option name. 795 * @param int $value The option value. 796 */ 797 $value = apply_filters( "set_screen_option_{$option}", $screen_option, $option, $value ); 798 799 if ( false === $value ) { 800 return; 801 } 802 803 break; 804 } 805 806 update_user_meta( $user->ID, $option, $value ); 807 808 $url = remove_query_arg( array( 'pagenum', 'apage', 'paged' ), wp_get_referer() ); 809 810 if ( isset( $_POST['mode'] ) ) { 811 $url = add_query_arg( array( 'mode' => $_POST['mode'] ), $url ); 812 } 813 814 wp_safe_redirect( $url ); 815 exit; 816 } 817 818 /** 819 * Checks if rewrite rule for WordPress already exists in the IIS 7+ configuration file. 820 * 821 * @since 2.8.0 822 * 823 * @param string $filename The file path to the configuration file. 824 * @return bool Whether the rule exists. 825 */ 826 function iis7_rewrite_rule_exists( $filename ) { 827 if ( ! file_exists( $filename ) ) { 828 return false; 829 } 830 831 if ( ! class_exists( 'DOMDocument', false ) ) { 832 return false; 833 } 834 835 $doc = new DOMDocument(); 836 if ( $doc->load( $filename ) === false ) { 837 return false; 838 } 839 840 $xpath = new DOMXPath( $doc ); 841 $rules = $xpath->query( '/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')] | /configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'WordPress\')]' ); 842 843 if ( 0 === $rules->length ) { 844 return false; 845 } 846 847 return true; 848 } 849 850 /** 851 * Deletes WordPress rewrite rule from web.config file if it exists there. 852 * 853 * @since 2.8.0 854 * 855 * @param string $filename Name of the configuration file. 856 * @return bool Whether the rule was deleted. 857 */ 858 function iis7_delete_rewrite_rule( $filename ) { 859 // If configuration file does not exist then rules also do not exist, so there is nothing to delete. 860 if ( ! file_exists( $filename ) ) { 861 return true; 862 } 863 864 if ( ! class_exists( 'DOMDocument', false ) ) { 865 return false; 866 } 867 868 $doc = new DOMDocument(); 869 $doc->preserveWhiteSpace = false; 870 871 if ( $doc->load( $filename ) === false ) { 872 return false; 873 } 874 875 $xpath = new DOMXPath( $doc ); 876 $rules = $xpath->query( '/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')] | /configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'WordPress\')]' ); 877 878 if ( $rules->length > 0 ) { 879 $child = $rules->item( 0 ); 880 $parent = $child->parentNode; 881 $parent->removeChild( $child ); 882 $doc->formatOutput = true; 883 saveDomDocument( $doc, $filename ); 884 } 885 886 return true; 887 } 888 889 /** 890 * Adds WordPress rewrite rule to the IIS 7+ configuration file. 891 * 892 * @since 2.8.0 893 * 894 * @param string $filename The file path to the configuration file. 895 * @param string $rewrite_rule The XML fragment with URL Rewrite rule. 896 * @return bool Whether the rule was added. 897 */ 898 function iis7_add_rewrite_rule( $filename, $rewrite_rule ) { 899 if ( ! class_exists( 'DOMDocument', false ) ) { 900 return false; 901 } 902 903 // If configuration file does not exist then we create one. 904 if ( ! file_exists( $filename ) ) { 905 $fp = fopen( $filename, 'w' ); 906 fwrite( $fp, '<configuration/>' ); 907 fclose( $fp ); 908 } 909 910 $doc = new DOMDocument(); 911 $doc->preserveWhiteSpace = false; 912 913 if ( $doc->load( $filename ) === false ) { 914 return false; 915 } 916 917 $xpath = new DOMXPath( $doc ); 918 919 // First check if the rule already exists as in that case there is no need to re-add it. 920 $wordpress_rules = $xpath->query( '/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')] | /configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'WordPress\')]' ); 921 922 if ( $wordpress_rules->length > 0 ) { 923 return true; 924 } 925 926 // Check the XPath to the rewrite rule and create XML nodes if they do not exist. 927 $xml_nodes = $xpath->query( '/configuration/system.webServer/rewrite/rules' ); 928 929 if ( $xml_nodes->length > 0 ) { 930 $rules_node = $xml_nodes->item( 0 ); 931 } else { 932 $rules_node = $doc->createElement( 'rules' ); 933 934 $xml_nodes = $xpath->query( '/configuration/system.webServer/rewrite' ); 935 936 if ( $xml_nodes->length > 0 ) { 937 $rewrite_node = $xml_nodes->item( 0 ); 938 $rewrite_node->appendChild( $rules_node ); 939 } else { 940 $rewrite_node = $doc->createElement( 'rewrite' ); 941 $rewrite_node->appendChild( $rules_node ); 942 943 $xml_nodes = $xpath->query( '/configuration/system.webServer' ); 944 945 if ( $xml_nodes->length > 0 ) { 946 $system_web_server_node = $xml_nodes->item( 0 ); 947 $system_web_server_node->appendChild( $rewrite_node ); 948 } else { 949 $system_web_server_node = $doc->createElement( 'system.webServer' ); 950 $system_web_server_node->appendChild( $rewrite_node ); 951 952 $xml_nodes = $xpath->query( '/configuration' ); 953 954 if ( $xml_nodes->length > 0 ) { 955 $config_node = $xml_nodes->item( 0 ); 956 $config_node->appendChild( $system_web_server_node ); 957 } else { 958 $config_node = $doc->createElement( 'configuration' ); 959 $doc->appendChild( $config_node ); 960 $config_node->appendChild( $system_web_server_node ); 961 } 962 } 963 } 964 } 965 966 $rule_fragment = $doc->createDocumentFragment(); 967 $rule_fragment->appendXML( $rewrite_rule ); 968 $rules_node->appendChild( $rule_fragment ); 969 970 $doc->encoding = 'UTF-8'; 971 $doc->formatOutput = true; 972 saveDomDocument( $doc, $filename ); 973 974 return true; 975 } 976 977 /** 978 * Saves the XML document into a file. 979 * 980 * @since 2.8.0 981 * 982 * @param DOMDocument $doc The DOMDocument object to save. 983 * @param string $filename The file path to save the XML document to. 984 */ 985 function saveDomDocument( $doc, $filename ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid 986 $config = $doc->saveXML(); 987 $config = preg_replace( "/([^\r])\n/", "$1\r\n", $config ); 988 989 $fp = fopen( $filename, 'w' ); 990 fwrite( $fp, $config ); 991 fclose( $fp ); 992 } 993 994 /** 995 * Displays the default administration color scheme picker (Used in user-edit.php). 996 * 997 * @since 3.0.0 998 * 999 * @global array $_wp_admin_css_colors 1000 * 1001 * @param int $user_id User ID. 1002 */ 1003 function admin_color_scheme_picker( $user_id ) { 1004 global $_wp_admin_css_colors; 1005 1006 ksort( $_wp_admin_css_colors ); 1007 1008 if ( isset( $_wp_admin_css_colors['modern'] ) ) { 1009 // Set Modern (new default), Classic ('fresh'), and Light first. 1010 $_wp_admin_css_colors = array_filter( 1011 array_merge( 1012 array( 1013 'modern' => '', 1014 'fresh' => '', 1015 'light' => '', 1016 ), 1017 $_wp_admin_css_colors 1018 ) 1019 ); 1020 } 1021 1022 $current_color = get_user_option( 'admin_color', $user_id ); 1023 1024 if ( empty( $current_color ) || ! isset( $_wp_admin_css_colors[ $current_color ] ) ) { 1025 $current_color = 'modern'; 1026 } 1027 ?> 1028 <fieldset id="color-picker" class="scheme-list"> 1029 <legend class="screen-reader-text"><span><?php _e( 'Administration Color Scheme' ); ?></span></legend> 1030 <?php 1031 wp_nonce_field( 'save-color-scheme', 'color-nonce', false ); 1032 foreach ( $_wp_admin_css_colors as $color => $color_info ) : 1033 1034 ?> 1035 <div class="color-option <?php echo ( $color === $current_color ) ? 'selected' : ''; ?>"> 1036 <input name="admin_color" id="admin_color_<?php echo esc_attr( $color ); ?>" type="radio" value="<?php echo esc_attr( $color ); ?>" <?php checked( $color, $current_color ); ?> /> 1037 <input type="hidden" class="css_url" value="<?php echo esc_url( $color_info->url ); ?>" /> 1038 <input type="hidden" class="icon_colors" value="<?php echo esc_attr( wp_json_encode( array( 'icons' => $color_info->icon_colors ) ) ); ?>" /> 1039 <input type="hidden" class="menu_icon_styles" value="<?php echo esc_attr( _wp_get_color_scheme_menu_icon_styles( $color ) ); ?>" /> 1040 <label for="admin_color_<?php echo esc_attr( $color ); ?>"><?php echo esc_html( $color_info->name ); ?></label> 1041 <div class="color-palette"> 1042 <?php 1043 foreach ( $color_info->colors as $html_color ) { 1044 ?> 1045 <div class="color-palette-shade" style="background-color: <?php echo esc_attr( $html_color ); ?>"> </div> 1046 <?php 1047 } 1048 ?> 1049 </div> 1050 </div> 1051 <?php 1052 1053 endforeach; 1054 ?> 1055 </fieldset> 1056 <?php 1057 } 1058 1059 /** 1060 * Outputs the JavaScript for the admin color scheme settings. 1061 * 1062 * @since 3.8.0 1063 * 1064 * @global array $_wp_admin_css_colors 1065 */ 1066 function wp_color_scheme_settings() { 1067 global $_wp_admin_css_colors; 1068 1069 $color_scheme = get_user_option( 'admin_color' ); 1070 1071 // It's possible to have a color scheme set that is no longer registered. 1072 if ( empty( $_wp_admin_css_colors[ $color_scheme ] ) ) { 1073 $color_scheme = 'modern'; 1074 } 1075 1076 if ( ! empty( $_wp_admin_css_colors[ $color_scheme ]->icon_colors ) ) { 1077 $icon_colors = $_wp_admin_css_colors[ $color_scheme ]->icon_colors; 1078 } elseif ( ! empty( $_wp_admin_css_colors['modern']->icon_colors ) ) { 1079 $icon_colors = $_wp_admin_css_colors['modern']->icon_colors; 1080 } else { 1081 // Fall back to the default set of icon colors if the default scheme is missing. 1082 $icon_colors = array( 1083 'base' => '#a7aaad', 1084 'focus' => '#72aee6', 1085 'current' => '#fff', 1086 ); 1087 } 1088 1089 echo '<script>var _wpColorScheme = ' . wp_json_encode( array( 'icons' => $icon_colors ), JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ) . ";</script>\n"; 1090 } 1091 1092 /** 1093 * Colors inline SVG admin menu icons with the icon colors of the current admin color scheme. 1094 * 1095 * These are the colors a scheme registers through the `$icons` argument of 1096 * wp_admin_css_color(). svg-painter.js applies the same colors to menu icons 1097 * given as base64-encoded SVG; this does it for inline SVG icons, with CSS. 1098 * 1099 * The rules are printed before the stylesheet of the scheme, so a scheme 1100 * that colors the icon element itself overrides them. 1101 * 1102 * @since 7.2.0 1103 * 1104 * @see wp_color_scheme_settings() 1105 */ 1106 function wp_color_scheme_menu_icon_styles() { 1107 $styles = _wp_get_color_scheme_menu_icon_styles( get_user_option( 'admin_color' ) ); 1108 1109 if ( '' !== $styles ) { 1110 wp_add_inline_style( 'admin-menu', $styles ); 1111 } 1112 } 1113 1114 /** 1115 * Returns the CSS that colors inline SVG admin menu icons with the icon colors of an admin color scheme. 1116 * 1117 * A scheme without icon colors gets CSS that makes the icons follow the 1118 * text color of the menu links instead. 1119 * 1120 * The color scheme picker also passes it to user-profile.js, which applies 1121 * it when another scheme is selected. 1122 * 1123 * @since 7.2.0 1124 * @access private 1125 * 1126 * @global array $_wp_admin_css_colors 1127 * 1128 * @param string $color_scheme The name of the color scheme. 1129 * @return string The CSS, or an empty string if the scheme needs none. 1130 */ 1131 function _wp_get_color_scheme_menu_icon_styles( $color_scheme ) { 1132 global $_wp_admin_css_colors; 1133 1134 if ( empty( $_wp_admin_css_colors[ $color_scheme ] ) ) { 1135 return ''; 1136 } 1137 1138 // The core schemes have no stylesheet of their own, or one from the core colors directory. 1139 $url = $_wp_admin_css_colors[ $color_scheme ]->url; 1140 if ( ! is_string( $url ) || '' === $url || str_starts_with( $url, admin_url( 'css/colors/' ) ) ) { 1141 return ''; 1142 } 1143 1144 $base_selector = '#adminmenu div.wp-menu-image'; 1145 $focus_selector = '#adminmenu li:hover div.wp-menu-image,#adminmenu li a:focus div.wp-menu-image,#adminmenu li.opensub div.wp-menu-image'; 1146 $current_selector = '#adminmenu li.wp-has-current-submenu div.wp-menu-image,#adminmenu li.wp-has-current-submenu:hover div.wp-menu-image,#adminmenu a.wp-has-current-submenu:hover div.wp-menu-image,#adminmenu a.current:hover div.wp-menu-image,#adminmenu li.current div.wp-menu-image,#adminmenu li.wp-has-current-submenu a:focus div.wp-menu-image,#adminmenu li.wp-has-current-submenu.opensub div.wp-menu-image'; 1147 1148 $icon_colors = array_map( 'sanitize_hex_color', wp_parse_args( (array) $_wp_admin_css_colors[ $color_scheme ]->icon_colors, array_fill_keys( array( 'base', 'focus', 'current' ), '' ) ) ); 1149 1150 // Without icon colors, the icons follow the text color that the scheme gives to the menu links. 1151 if ( ! $icon_colors['base'] || ! $icon_colors['focus'] || ! $icon_colors['current'] ) { 1152 return "$base_selector,$focus_selector,$current_selector{color:inherit}"; 1153 } 1154 1155 return "$base_selector{color:{$icon_colors['base']}}" . 1156 "$focus_selector{color:{$icon_colors['focus']}}" . 1157 "$current_selector{color:{$icon_colors['current']}}"; 1158 } 1159 1160 /** 1161 * Displays the viewport meta in the admin. 1162 * 1163 * @since 5.5.0 1164 */ 1165 function wp_admin_viewport_meta() { 1166 /** 1167 * Filters the viewport meta in the admin. 1168 * 1169 * @since 5.5.0 1170 * 1171 * @param string $viewport_meta The viewport meta. 1172 */ 1173 $viewport_meta = apply_filters( 'admin_viewport_meta', 'width=device-width,initial-scale=1.0' ); 1174 1175 if ( empty( $viewport_meta ) ) { 1176 return; 1177 } 1178 1179 echo '<meta name="viewport" content="' . esc_attr( $viewport_meta ) . '">'; 1180 } 1181 1182 /** 1183 * Adds viewport meta for mobile in Customizer. 1184 * 1185 * Hooked to the {@see 'admin_viewport_meta'} filter. 1186 * 1187 * @since 5.5.0 1188 * 1189 * @param string $viewport_meta The viewport meta. 1190 * @return string Filtered viewport meta. 1191 */ 1192 function _customizer_mobile_viewport_meta( $viewport_meta ) { 1193 return trim( $viewport_meta, ',' ) . ',minimum-scale=0.5,maximum-scale=1.2'; 1194 } 1195 1196 /** 1197 * Checks lock status for posts displayed on the Posts screen. 1198 * 1199 * @since 3.6.0 1200 * 1201 * @param array $response The Heartbeat response. 1202 * @param array $data The $_POST data sent. 1203 * @param string $screen_id The screen ID. 1204 * @return array The Heartbeat response. 1205 */ 1206 function wp_check_locked_posts( $response, $data, $screen_id ) { 1207 $checked = array(); 1208 1209 if ( array_key_exists( 'wp-check-locked-posts', $data ) && is_array( $data['wp-check-locked-posts'] ) ) { 1210 foreach ( $data['wp-check-locked-posts'] as $key ) { 1211 $post_id = absint( substr( $key, 5 ) ); 1212 1213 if ( ! $post_id ) { 1214 continue; 1215 } 1216 1217 $user_id = wp_check_post_lock( $post_id ); 1218 1219 if ( $user_id ) { 1220 $user = get_userdata( $user_id ); 1221 1222 if ( $user && current_user_can( 'edit_post', $post_id ) ) { 1223 $send = array( 1224 'name' => $user->display_name, 1225 /* translators: %s: User's display name. */ 1226 'text' => sprintf( __( '%s is currently editing' ), $user->display_name ), 1227 ); 1228 1229 if ( get_option( 'show_avatars' ) ) { 1230 $send['avatar_src'] = get_avatar_url( $user->ID, array( 'size' => 18 ) ); 1231 $send['avatar_src_2x'] = get_avatar_url( $user->ID, array( 'size' => 36 ) ); 1232 } 1233 1234 $checked[ $key ] = $send; 1235 } 1236 } 1237 } 1238 } 1239 1240 if ( ! empty( $checked ) ) { 1241 $response['wp-check-locked-posts'] = $checked; 1242 } 1243 1244 return $response; 1245 } 1246 1247 /** 1248 * Checks lock status on the New/Edit Post screen and refresh the lock. 1249 * 1250 * @since 3.6.0 1251 * 1252 * @param array $response The Heartbeat response. 1253 * @param array $data The $_POST data sent. 1254 * @param string $screen_id The screen ID. 1255 * @return array The Heartbeat response. 1256 */ 1257 function wp_refresh_post_lock( $response, $data, $screen_id ) { 1258 if ( array_key_exists( 'wp-refresh-post-lock', $data ) ) { 1259 $received = $data['wp-refresh-post-lock']; 1260 $send = array(); 1261 1262 $post_id = absint( $received['post_id'] ); 1263 1264 if ( ! $post_id ) { 1265 return $response; 1266 } 1267 1268 if ( ! current_user_can( 'edit_post', $post_id ) ) { 1269 return $response; 1270 } 1271 1272 $user_id = wp_check_post_lock( $post_id ); 1273 $user = get_userdata( $user_id ); 1274 1275 if ( $user ) { 1276 $error = array( 1277 'name' => $user->display_name, 1278 /* translators: %s: User's display name. */ 1279 'text' => sprintf( __( '%s has taken over and is currently editing.' ), $user->display_name ), 1280 ); 1281 1282 if ( get_option( 'show_avatars' ) ) { 1283 $error['avatar_src'] = get_avatar_url( $user->ID, array( 'size' => 64 ) ); 1284 $error['avatar_src_2x'] = get_avatar_url( $user->ID, array( 'size' => 128 ) ); 1285 } 1286 1287 $send['lock_error'] = $error; 1288 } else { 1289 $new_lock = wp_set_post_lock( $post_id ); 1290 1291 if ( $new_lock ) { 1292 $send['new_lock'] = implode( ':', $new_lock ); 1293 } 1294 } 1295 1296 $response['wp-refresh-post-lock'] = $send; 1297 } 1298 1299 return $response; 1300 } 1301 1302 /** 1303 * Checks nonce expiration on the New/Edit Post screen and refresh if needed. 1304 * 1305 * @since 3.6.0 1306 * 1307 * @param array $response The Heartbeat response. 1308 * @param array $data The $_POST data sent. 1309 * @param string $screen_id The screen ID. 1310 * @return array The Heartbeat response. 1311 */ 1312 function wp_refresh_post_nonces( $response, $data, $screen_id ) { 1313 if ( array_key_exists( 'wp-refresh-post-nonces', $data ) ) { 1314 $received = $data['wp-refresh-post-nonces']; 1315 1316 $response['wp-refresh-post-nonces'] = array( 'check' => 1 ); 1317 1318 $post_id = absint( $received['post_id'] ); 1319 1320 if ( ! $post_id ) { 1321 return $response; 1322 } 1323 1324 if ( ! current_user_can( 'edit_post', $post_id ) ) { 1325 return $response; 1326 } 1327 1328 $response['wp-refresh-post-nonces'] = array( 1329 'replace' => array( 1330 'getpermalinknonce' => wp_create_nonce( 'getpermalink' ), 1331 'samplepermalinknonce' => wp_create_nonce( 'samplepermalink' ), 1332 'closedpostboxesnonce' => wp_create_nonce( 'closedpostboxes' ), 1333 '_ajax_linking_nonce' => wp_create_nonce( 'internal-linking' ), 1334 '_wpnonce' => wp_create_nonce( 'update-post_' . $post_id ), 1335 ), 1336 ); 1337 } 1338 1339 return $response; 1340 } 1341 1342 /** 1343 * Refresh nonces used with meta boxes in the block editor. 1344 * 1345 * @since 6.1.0 1346 * 1347 * @param array $response The Heartbeat response. 1348 * @param array $data The $_POST data sent. 1349 * @return array The Heartbeat response. 1350 */ 1351 function wp_refresh_metabox_loader_nonces( $response, $data ) { 1352 if ( empty( $data['wp-refresh-metabox-loader-nonces'] ) ) { 1353 return $response; 1354 } 1355 1356 $received = $data['wp-refresh-metabox-loader-nonces']; 1357 $post_id = (int) $received['post_id']; 1358 1359 if ( ! $post_id ) { 1360 return $response; 1361 } 1362 1363 if ( ! current_user_can( 'edit_post', $post_id ) ) { 1364 return $response; 1365 } 1366 1367 $response['wp-refresh-metabox-loader-nonces'] = array( 1368 'replace' => array( 1369 'metabox_loader_nonce' => wp_create_nonce( 'meta-box-loader' ), 1370 '_wpnonce' => wp_create_nonce( 'update-post_' . $post_id ), 1371 ), 1372 ); 1373 1374 return $response; 1375 } 1376 1377 /** 1378 * Adds the latest Heartbeat and REST API nonce to the Heartbeat response. 1379 * 1380 * @since 5.0.0 1381 * 1382 * @param array $response The Heartbeat response. 1383 * @return array The Heartbeat response. 1384 */ 1385 function wp_refresh_heartbeat_nonces( $response ) { 1386 // Refresh the Rest API nonce. 1387 $response['rest_nonce'] = wp_create_nonce( 'wp_rest' ); 1388 1389 // Refresh the Heartbeat nonce. 1390 $response['heartbeat_nonce'] = wp_create_nonce( 'heartbeat-nonce' ); 1391 1392 return $response; 1393 } 1394 1395 /** 1396 * Disables suspension of Heartbeat on the Add/Edit Post screens. 1397 * 1398 * @since 3.8.0 1399 * 1400 * @global string $pagenow The filename of the current screen. 1401 * 1402 * @param array $settings An array of Heartbeat settings. 1403 * @return array Filtered Heartbeat settings. 1404 */ 1405 function wp_heartbeat_set_suspension( $settings ) { 1406 global $pagenow; 1407 1408 if ( 'post.php' === $pagenow || 'post-new.php' === $pagenow ) { 1409 $settings['suspension'] = 'disable'; 1410 } 1411 1412 return $settings; 1413 } 1414 1415 /** 1416 * Performs autosave with heartbeat. 1417 * 1418 * @since 3.9.0 1419 * 1420 * @param array $response The Heartbeat response. 1421 * @param array $data The $_POST data sent. 1422 * @return array The Heartbeat response. 1423 */ 1424 function heartbeat_autosave( $response, $data ) { 1425 if ( ! empty( $data['wp_autosave'] ) ) { 1426 $saved = wp_autosave( $data['wp_autosave'] ); 1427 1428 if ( is_wp_error( $saved ) ) { 1429 $response['wp_autosave'] = array( 1430 'success' => false, 1431 'message' => $saved->get_error_message(), 1432 ); 1433 } elseif ( empty( $saved ) ) { 1434 $response['wp_autosave'] = array( 1435 'success' => false, 1436 'message' => __( 'Error while saving.' ), 1437 ); 1438 } else { 1439 /* translators: Draft saved date format, see https://www.php.net/manual/datetime.format.php */ 1440 $draft_saved_date_format = __( 'g:i:s a' ); 1441 $response['wp_autosave'] = array( 1442 'success' => true, 1443 /* translators: %s: Date and time. */ 1444 'message' => sprintf( __( 'Draft saved at %s.' ), date_i18n( $draft_saved_date_format ) ), 1445 ); 1446 } 1447 } 1448 1449 return $response; 1450 } 1451 1452 /** 1453 * Removes single-use URL parameters and create canonical link based on new URL. 1454 * 1455 * Removes specific query string parameters from a URL, create the canonical link, 1456 * put it in the admin header, and change the current URL to match. 1457 * 1458 * @since 4.2.0 1459 */ 1460 function wp_admin_canonical_url() { 1461 $removable_query_args = wp_removable_query_args(); 1462 1463 if ( empty( $removable_query_args ) ) { 1464 return; 1465 } 1466 1467 // Ensure we're using an absolute URL. 1468 $current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ); 1469 $filtered_url = remove_query_arg( $removable_query_args, $current_url ); 1470 1471 /** 1472 * Filters the admin canonical URL value. 1473 * 1474 * @since 6.5.0 1475 * 1476 * @param string $filtered_url The admin canonical URL value. 1477 */ 1478 $filtered_url = apply_filters( 'wp_admin_canonical_url', $filtered_url ); 1479 ?> 1480 <link id="wp-admin-canonical" rel="canonical" href="<?php echo esc_url( $filtered_url ); ?>" /> 1481 <script> 1482 if ( window.history.replaceState ) { 1483 window.history.replaceState( null, null, document.getElementById( 'wp-admin-canonical' ).href + window.location.hash ); 1484 } 1485 </script> 1486 <?php 1487 } 1488 1489 /** 1490 * Outputs JS that reloads the page if the user navigated to it with the Back or Forward button. 1491 * 1492 * Used on the Edit Post and Add New Post screens. Needed to ensure the page is not loaded from browser cache, 1493 * so the post title and editor content are the last saved versions. Ideally this script should run first in the head. 1494 * 1495 * @since 4.6.0 1496 */ 1497 function wp_page_reload_on_back_button_js() { 1498 ?> 1499 <script> 1500 if ( typeof performance !== 'undefined' && performance.navigation && performance.navigation.type === 2 ) { 1501 document.location.reload( true ); 1502 } 1503 </script> 1504 <?php 1505 } 1506 1507 /** 1508 * Sends a confirmation request email when a change of site admin email address is attempted. 1509 * 1510 * The new site admin address will not become active until confirmed. 1511 * 1512 * @since 3.0.0 1513 * @since 4.9.0 This function was moved from wp-admin/includes/ms.php so it's no longer Multisite specific. 1514 * 1515 * @param string $old_value The old site admin email address. 1516 * @param string $value The proposed new site admin email address. 1517 */ 1518 function update_option_new_admin_email( $old_value, $value ) { 1519 if ( get_option( 'admin_email' ) === $value || ! is_email( $value ) ) { 1520 return; 1521 } 1522 1523 $hash = md5( $value . time() . wp_rand() ); 1524 $new_admin_email = array( 1525 'hash' => $hash, 1526 'newemail' => $value, 1527 ); 1528 update_option( 'adminhash', $new_admin_email, false ); 1529 1530 $switched_locale = switch_to_user_locale( get_current_user_id() ); 1531 1532 /* translators: Do not translate USERNAME, ADMIN_URL, EMAIL, SITENAME, SITEURL: those are placeholders. */ 1533 $email_text = __( 1534 'Howdy, 1535 1536 A site administrator (###USERNAME###) recently requested to have the 1537 administration email address changed on this site: 1538 ###SITEURL### 1539 1540 To confirm this change, please click on the following link: 1541 ###ADMIN_URL### 1542 1543 You can safely ignore and delete this email if you do not want to 1544 take this action. 1545 1546 This email has been sent to ###EMAIL### 1547 1548 Regards, 1549 All at ###SITENAME### 1550 ###SITEURL###' 1551 ); 1552 1553 /** 1554 * Filters the text of the email sent when a change of site admin email address is attempted. 1555 * 1556 * The following strings have a special meaning and will get replaced dynamically: 1557 * 1558 * - `###USERNAME###` The current user's username. 1559 * - `###ADMIN_URL###` The link to click on to confirm the email change. 1560 * - `###EMAIL###` The proposed new site admin email address. 1561 * - `###SITENAME###` The name of the site. 1562 * - `###SITEURL###` The URL to the site. 1563 * 1564 * @since MU (3.0.0) 1565 * @since 4.9.0 This filter is no longer Multisite specific. 1566 * 1567 * @param string $email_text Text in the email. 1568 * @param array $new_admin_email { 1569 * Data relating to the new site admin email address. 1570 * 1571 * @type string $hash The secure hash used in the confirmation link URL. 1572 * @type string $newemail The proposed new site admin email address. 1573 * } 1574 */ 1575 $content = apply_filters( 'new_admin_email_content', $email_text, $new_admin_email ); 1576 1577 $current_user = wp_get_current_user(); 1578 $content = str_replace( '###USERNAME###', $current_user->user_login, $content ); 1579 $content = str_replace( '###ADMIN_URL###', esc_url( self_admin_url( 'options.php?adminhash=' . $hash ) ), $content ); 1580 $content = str_replace( '###EMAIL###', $value, $content ); 1581 $content = str_replace( '###SITENAME###', wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ), $content ); 1582 $content = str_replace( '###SITEURL###', home_url(), $content ); 1583 1584 if ( '' !== get_option( 'blogname' ) ) { 1585 $site_title = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ); 1586 } else { 1587 $site_title = parse_url( home_url(), PHP_URL_HOST ); 1588 } 1589 1590 $subject = sprintf( 1591 /* translators: New admin email address notification email subject. %s: Site title. */ 1592 __( '[%s] New Admin Email Address' ), 1593 $site_title 1594 ); 1595 1596 /** 1597 * Filters the subject of the email sent when a change of site admin email address is attempted. 1598 * 1599 * @since 6.5.0 1600 * 1601 * @param string $subject Subject of the email. 1602 */ 1603 $subject = apply_filters( 'new_admin_email_subject', $subject ); 1604 1605 wp_mail( $value, $subject, $content ); 1606 1607 if ( $switched_locale ) { 1608 restore_previous_locale(); 1609 } 1610 } 1611 1612 /** 1613 * Appends '(Draft)' to draft page titles in the privacy page dropdown 1614 * so that unpublished content is obvious. 1615 * 1616 * @since 4.9.8 1617 * @access private 1618 * 1619 * @param string $title Page title. 1620 * @param WP_Post $page Page data object. 1621 * @return string Page title. 1622 */ 1623 function _wp_privacy_settings_filter_draft_page_titles( $title, $page ) { 1624 if ( 'draft' === $page->post_status && 'privacy' === get_current_screen()->id ) { 1625 /* translators: %s: Page title. */ 1626 $title = sprintf( __( '%s (Draft)' ), $title ); 1627 } 1628 1629 return $title; 1630 } 1631 1632 /** 1633 * Checks if the user needs to update PHP. 1634 * 1635 * @since 5.1.0 1636 * @since 5.1.1 Added the {@see 'wp_is_php_version_acceptable'} filter. 1637 * 1638 * @return array|false { 1639 * Array of PHP version data. False on failure. 1640 * 1641 * @type string $recommended_version The PHP version recommended by WordPress. 1642 * @type string $minimum_version The minimum required PHP version. 1643 * @type bool $is_supported Whether the PHP version is actively supported. 1644 * @type bool $is_secure Whether the PHP version receives security updates. 1645 * @type bool $is_acceptable Whether the PHP version is still acceptable or warnings 1646 * should be shown and an update recommended. 1647 * @type bool $is_lower_than_future_minimum Whether the PHP version is lower than the minimum PHP 1648 * version WordPress will require in a future release. 1649 * } 1650 */ 1651 function wp_check_php_version() { 1652 $version = PHP_VERSION; 1653 $key = md5( $version ); 1654 1655 $response = get_site_transient( 'php_check_' . $key ); 1656 1657 if ( false === $response ) { 1658 $url = 'http://api.wordpress.org/core/serve-happy/1.0/'; 1659 1660 if ( wp_http_supports( array( 'ssl' ) ) ) { 1661 $url = set_url_scheme( $url, 'https' ); 1662 } 1663 1664 $url = add_query_arg( 'php_version', $version, $url ); 1665 1666 $response = wp_remote_get( $url ); 1667 1668 if ( is_wp_error( $response ) || 200 !== wp_remote_retrieve_response_code( $response ) ) { 1669 return false; 1670 } 1671 1672 $response = json_decode( wp_remote_retrieve_body( $response ), true ); 1673 1674 if ( ! is_array( $response ) ) { 1675 return false; 1676 } 1677 1678 set_site_transient( 'php_check_' . $key, $response, WEEK_IN_SECONDS ); 1679 } 1680 1681 if ( isset( $response['is_acceptable'] ) && $response['is_acceptable'] ) { 1682 /** 1683 * Filters whether the active PHP version is considered acceptable by WordPress. 1684 * 1685 * Returning false will trigger a PHP version warning to show up in the admin dashboard to administrators. 1686 * 1687 * This filter is only run if the wordpress.org Serve Happy API considers the PHP version acceptable, ensuring 1688 * that this filter can only make this check stricter, but not loosen it. 1689 * 1690 * @since 5.1.1 1691 * 1692 * @param bool $is_acceptable Whether the PHP version is considered acceptable. Default true. 1693 * @param string $version PHP version checked. 1694 */ 1695 $response['is_acceptable'] = (bool) apply_filters( 'wp_is_php_version_acceptable', true, $version ); 1696 } 1697 1698 $response['is_lower_than_future_minimum'] = false; 1699 1700 // The minimum supported PHP version will be updated to at least 8.0 in the future. Check if the current version is lower. 1701 if ( version_compare( $version, '8.0', '<' ) ) { 1702 $response['is_lower_than_future_minimum'] = true; 1703 1704 // Force showing of warnings. 1705 $response['is_acceptable'] = false; 1706 } 1707 1708 return $response; 1709 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Mon Nov 2 08:20:36 2026 | Cross-referenced by PHPXref |