| [ 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_marker && $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; 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; 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 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 * @param array|string $tree List of file/folder paths, or filename. 496 * @param string $label Name of file or folder to print. 497 * @param int $level The aria-level for the current iteration. 498 * @param int $size The aria-setsize for the current iteration. 499 * @param int $index The aria-posinset for the current iteration. 500 */ 501 function wp_print_plugin_file_tree( $tree, $label = '', $level = 2, $size = 1, $index = 1 ) { 502 global $file, $plugin; 503 504 if ( is_array( $tree ) ) { 505 $index = 0; 506 $size = count( $tree ); 507 508 foreach ( $tree as $label => $plugin_file ) : 509 ++$index; 510 511 if ( ! is_array( $plugin_file ) ) { 512 wp_print_plugin_file_tree( $plugin_file, $label, $level, $index, $size ); 513 continue; 514 } 515 ?> 516 <li role="treeitem" aria-expanded="true" tabindex="-1" 517 aria-level="<?php echo esc_attr( $level ); ?>" 518 aria-setsize="<?php echo esc_attr( $size ); ?>" 519 aria-posinset="<?php echo esc_attr( $index ); ?>"> 520 <span class="folder-label"><?php echo esc_html( $label ); ?> <span class="screen-reader-text"> 521 <?php 522 /* translators: Hidden accessibility text. */ 523 _e( 'folder' ); 524 ?> 525 </span><span aria-hidden="true" class="icon"></span></span> 526 <ul role="group" class="tree-folder"><?php wp_print_plugin_file_tree( $plugin_file, '', $level + 1, $index, $size ); ?></ul> 527 </li> 528 <?php 529 endforeach; 530 } else { 531 $url = add_query_arg( 532 array( 533 'file' => rawurlencode( $tree ), 534 'plugin' => rawurlencode( $plugin ), 535 ), 536 self_admin_url( 'plugin-editor.php' ) 537 ); 538 ?> 539 <li role="none" class="<?php echo esc_attr( $file === $tree ? 'current-file' : '' ); ?>"> 540 <a role="treeitem" tabindex="<?php echo esc_attr( $file === $tree ? '0' : '-1' ); ?>" 541 href="<?php echo esc_url( $url ); ?>" 542 aria-level="<?php echo esc_attr( $level ); ?>" 543 aria-setsize="<?php echo esc_attr( $size ); ?>" 544 aria-posinset="<?php echo esc_attr( $index ); ?>"> 545 <?php 546 if ( $file === $tree ) { 547 echo '<span class="notice notice-info">' . esc_html( $label ) . '</span>'; 548 } else { 549 echo esc_html( $label ); 550 } 551 ?> 552 </a> 553 </li> 554 <?php 555 } 556 } 557 558 /** 559 * Flushes rewrite rules if `siteurl`, `home` or `page_on_front` changed. 560 * 561 * @since 2.1.0 562 * 563 * @param string $old_value 564 * @param string $value 565 */ 566 function update_home_siteurl( $old_value, $value ) { 567 if ( wp_installing() ) { 568 return; 569 } 570 571 if ( is_multisite() && ms_is_switched() ) { 572 delete_option( 'rewrite_rules' ); 573 } else { 574 flush_rewrite_rules(); 575 } 576 } 577 578 /** 579 * Resets global variables based on `$_GET` and `$_POST`. 580 * 581 * This function resets global variables based on the names passed 582 * in the `$vars` array to the value of `$_POST[$var]` or `$_GET[$var]` or an 583 * empty string if neither is defined. 584 * 585 * @since 2.0.0 586 * 587 * @param array $vars An array of globals to reset. 588 */ 589 function wp_reset_vars( $vars ) { 590 foreach ( $vars as $var ) { 591 if ( empty( $_POST[ $var ] ) ) { 592 if ( empty( $_GET[ $var ] ) ) { 593 $GLOBALS[ $var ] = ''; 594 } else { 595 $GLOBALS[ $var ] = $_GET[ $var ]; 596 } 597 } else { 598 $GLOBALS[ $var ] = $_POST[ $var ]; 599 } 600 } 601 } 602 603 /** 604 * Displays the given administration message. 605 * 606 * @since 2.1.0 607 * 608 * @param string|WP_Error $message 609 */ 610 function show_message( $message ) { 611 if ( is_wp_error( $message ) ) { 612 if ( $message->get_error_data() && is_string( $message->get_error_data() ) ) { 613 $message = $message->get_error_message() . ': ' . $message->get_error_data(); 614 } else { 615 $message = $message->get_error_message(); 616 } 617 } 618 619 echo "<p>$message</p>\n"; 620 wp_ob_end_flush_all(); 621 flush(); 622 } 623 624 /** 625 * @since 2.8.0 626 * 627 * @param string $content 628 * @return array 629 */ 630 function wp_doc_link_parse( $content ) { 631 if ( ! is_string( $content ) || empty( $content ) ) { 632 return array(); 633 } 634 635 if ( ! function_exists( 'token_get_all' ) ) { 636 return array(); 637 } 638 639 $tokens = token_get_all( $content ); 640 $count = count( $tokens ); 641 $functions = array(); 642 $ignore_functions = array(); 643 644 for ( $t = 0; $t < $count - 2; $t++ ) { 645 if ( ! is_array( $tokens[ $t ] ) ) { 646 continue; 647 } 648 649 if ( T_STRING === $tokens[ $t ][0] && ( '(' === $tokens[ $t + 1 ] || '(' === $tokens[ $t + 2 ] ) ) { 650 // If it's a function or class defined locally, there's not going to be any docs available. 651 if ( ( isset( $tokens[ $t - 2 ][1] ) && in_array( $tokens[ $t - 2 ][1], array( 'function', 'class' ), true ) ) 652 || ( isset( $tokens[ $t - 2 ][0] ) && T_OBJECT_OPERATOR === $tokens[ $t - 1 ][0] ) 653 ) { 654 $ignore_functions[] = $tokens[ $t ][1]; 655 } 656 657 // Add this to our stack of unique references. 658 $functions[] = $tokens[ $t ][1]; 659 } 660 } 661 662 $functions = array_unique( $functions ); 663 sort( $functions ); 664 665 /** 666 * Filters the list of functions and classes to be ignored from the documentation lookup. 667 * 668 * @since 2.8.0 669 * 670 * @param string[] $ignore_functions Array of names of functions and classes to be ignored. 671 */ 672 $ignore_functions = apply_filters( 'documentation_ignore_functions', $ignore_functions ); 673 674 $ignore_functions = array_unique( $ignore_functions ); 675 676 $output = array(); 677 678 foreach ( $functions as $function ) { 679 if ( in_array( $function, $ignore_functions, true ) ) { 680 continue; 681 } 682 683 $output[] = $function; 684 } 685 686 return $output; 687 } 688 689 /** 690 * Saves option for number of rows when listing posts, pages, comments, etc. 691 * 692 * @since 2.8.0 693 */ 694 function set_screen_options() { 695 if ( ! isset( $_POST['wp_screen_options'] ) || ! is_array( $_POST['wp_screen_options'] ) ) { 696 return; 697 } 698 699 check_admin_referer( 'screen-options-nonce', 'screenoptionnonce' ); 700 701 $user = wp_get_current_user(); 702 703 if ( ! $user ) { 704 return; 705 } 706 707 $option = $_POST['wp_screen_options']['option']; 708 $value = $_POST['wp_screen_options']['value']; 709 710 if ( sanitize_key( $option ) !== $option ) { 711 return; 712 } 713 714 $map_option = $option; 715 $type = str_replace( 'edit_', '', $map_option ); 716 $type = str_replace( '_per_page', '', $type ); 717 718 if ( in_array( $type, get_taxonomies(), true ) ) { 719 $map_option = 'edit_tags_per_page'; 720 } elseif ( in_array( $type, get_post_types(), true ) ) { 721 $map_option = 'edit_per_page'; 722 } else { 723 $option = str_replace( '-', '_', $option ); 724 } 725 726 switch ( $map_option ) { 727 case 'edit_per_page': 728 case 'users_per_page': 729 case 'edit_comments_per_page': 730 case 'upload_per_page': 731 case 'edit_tags_per_page': 732 case 'plugins_per_page': 733 case 'export_personal_data_requests_per_page': 734 case 'remove_personal_data_requests_per_page': 735 // Network admin. 736 case 'sites_network_per_page': 737 case 'users_network_per_page': 738 case 'site_users_network_per_page': 739 case 'plugins_network_per_page': 740 case 'themes_network_per_page': 741 case 'site_themes_network_per_page': 742 $value = (int) $value; 743 744 if ( $value < 1 || $value > 999 ) { 745 return; 746 } 747 748 break; 749 750 default: 751 $screen_option = false; 752 753 if ( str_ends_with( $option, '_page' ) || 'layout_columns' === $option ) { 754 /** 755 * Filters a screen option value before it is set. 756 * 757 * The filter can also be used to modify non-standard `[items]_per_page` 758 * settings. See the parent function for a full list of standard options. 759 * 760 * Returning false from the filter will skip saving the current option. 761 * 762 * @since 2.8.0 763 * @since 5.4.2 Only applied to options ending with '_page', 764 * or the 'layout_columns' option. 765 * 766 * @see set_screen_options() 767 * 768 * @param mixed $screen_option The value to save instead of the option value. 769 * Default false (to skip saving the current option). 770 * @param string $option The option name. 771 * @param int $value The option value. 772 */ 773 $screen_option = apply_filters( 'set-screen-option', $screen_option, $option, $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores 774 } 775 776 /** 777 * Filters a screen option value before it is set. 778 * 779 * The dynamic portion of the hook name, `$option`, refers to the option name. 780 * 781 * Returning false from the filter will skip saving the current option. 782 * 783 * @since 5.4.2 784 * 785 * @see set_screen_options() 786 * 787 * @param mixed $screen_option The value to save instead of the option value. 788 * Default false (to skip saving the current option). 789 * @param string $option The option name. 790 * @param int $value The option value. 791 */ 792 $value = apply_filters( "set_screen_option_{$option}", $screen_option, $option, $value ); 793 794 if ( false === $value ) { 795 return; 796 } 797 798 break; 799 } 800 801 update_user_meta( $user->ID, $option, $value ); 802 803 $url = remove_query_arg( array( 'pagenum', 'apage', 'paged' ), wp_get_referer() ); 804 805 if ( isset( $_POST['mode'] ) ) { 806 $url = add_query_arg( array( 'mode' => $_POST['mode'] ), $url ); 807 } 808 809 wp_safe_redirect( $url ); 810 exit; 811 } 812 813 /** 814 * Checks if rewrite rule for WordPress already exists in the IIS 7+ configuration file. 815 * 816 * @since 2.8.0 817 * 818 * @param string $filename The file path to the configuration file. 819 * @return bool 820 */ 821 function iis7_rewrite_rule_exists( $filename ) { 822 if ( ! file_exists( $filename ) ) { 823 return false; 824 } 825 826 if ( ! class_exists( 'DOMDocument', false ) ) { 827 return false; 828 } 829 830 $doc = new DOMDocument(); 831 832 if ( $doc->load( $filename ) === false ) { 833 return false; 834 } 835 836 $xpath = new DOMXPath( $doc ); 837 $rules = $xpath->query( '/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')] | /configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'WordPress\')]' ); 838 839 if ( 0 === $rules->length ) { 840 return false; 841 } 842 843 return true; 844 } 845 846 /** 847 * Deletes WordPress rewrite rule from web.config file if it exists there. 848 * 849 * @since 2.8.0 850 * 851 * @param string $filename Name of the configuration file. 852 * @return bool 853 */ 854 function iis7_delete_rewrite_rule( $filename ) { 855 // If configuration file does not exist then rules also do not exist, so there is nothing to delete. 856 if ( ! file_exists( $filename ) ) { 857 return true; 858 } 859 860 if ( ! class_exists( 'DOMDocument', false ) ) { 861 return false; 862 } 863 864 $doc = new DOMDocument(); 865 $doc->preserveWhiteSpace = false; 866 867 if ( $doc->load( $filename ) === false ) { 868 return false; 869 } 870 871 $xpath = new DOMXPath( $doc ); 872 $rules = $xpath->query( '/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')] | /configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'WordPress\')]' ); 873 874 if ( $rules->length > 0 ) { 875 $child = $rules->item( 0 ); 876 $parent = $child->parentNode; 877 $parent->removeChild( $child ); 878 $doc->formatOutput = true; 879 saveDomDocument( $doc, $filename ); 880 } 881 882 return true; 883 } 884 885 /** 886 * Adds WordPress rewrite rule to the IIS 7+ configuration file. 887 * 888 * @since 2.8.0 889 * 890 * @param string $filename The file path to the configuration file. 891 * @param string $rewrite_rule The XML fragment with URL Rewrite rule. 892 * @return bool 893 */ 894 function iis7_add_rewrite_rule( $filename, $rewrite_rule ) { 895 if ( ! class_exists( 'DOMDocument', false ) ) { 896 return false; 897 } 898 899 // If configuration file does not exist then we create one. 900 if ( ! file_exists( $filename ) ) { 901 $fp = fopen( $filename, 'w' ); 902 fwrite( $fp, '<configuration/>' ); 903 fclose( $fp ); 904 } 905 906 $doc = new DOMDocument(); 907 $doc->preserveWhiteSpace = false; 908 909 if ( $doc->load( $filename ) === false ) { 910 return false; 911 } 912 913 $xpath = new DOMXPath( $doc ); 914 915 // First check if the rule already exists as in that case there is no need to re-add it. 916 $wordpress_rules = $xpath->query( '/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')] | /configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'WordPress\')]' ); 917 918 if ( $wordpress_rules->length > 0 ) { 919 return true; 920 } 921 922 // Check the XPath to the rewrite rule and create XML nodes if they do not exist. 923 $xml_nodes = $xpath->query( '/configuration/system.webServer/rewrite/rules' ); 924 925 if ( $xml_nodes->length > 0 ) { 926 $rules_node = $xml_nodes->item( 0 ); 927 } else { 928 $rules_node = $doc->createElement( 'rules' ); 929 930 $xml_nodes = $xpath->query( '/configuration/system.webServer/rewrite' ); 931 932 if ( $xml_nodes->length > 0 ) { 933 $rewrite_node = $xml_nodes->item( 0 ); 934 $rewrite_node->appendChild( $rules_node ); 935 } else { 936 $rewrite_node = $doc->createElement( 'rewrite' ); 937 $rewrite_node->appendChild( $rules_node ); 938 939 $xml_nodes = $xpath->query( '/configuration/system.webServer' ); 940 941 if ( $xml_nodes->length > 0 ) { 942 $system_web_server_node = $xml_nodes->item( 0 ); 943 $system_web_server_node->appendChild( $rewrite_node ); 944 } else { 945 $system_web_server_node = $doc->createElement( 'system.webServer' ); 946 $system_web_server_node->appendChild( $rewrite_node ); 947 948 $xml_nodes = $xpath->query( '/configuration' ); 949 950 if ( $xml_nodes->length > 0 ) { 951 $config_node = $xml_nodes->item( 0 ); 952 $config_node->appendChild( $system_web_server_node ); 953 } else { 954 $config_node = $doc->createElement( 'configuration' ); 955 $doc->appendChild( $config_node ); 956 $config_node->appendChild( $system_web_server_node ); 957 } 958 } 959 } 960 } 961 962 $rule_fragment = $doc->createDocumentFragment(); 963 $rule_fragment->appendXML( $rewrite_rule ); 964 $rules_node->appendChild( $rule_fragment ); 965 966 $doc->encoding = 'UTF-8'; 967 $doc->formatOutput = true; 968 saveDomDocument( $doc, $filename ); 969 970 return true; 971 } 972 973 /** 974 * Saves the XML document into a file. 975 * 976 * @since 2.8.0 977 * 978 * @param DOMDocument $doc 979 * @param string $filename 980 */ 981 function saveDomDocument( $doc, $filename ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid 982 $config = $doc->saveXML(); 983 $config = preg_replace( "/([^\r])\n/", "$1\r\n", $config ); 984 985 $fp = fopen( $filename, 'w' ); 986 fwrite( $fp, $config ); 987 fclose( $fp ); 988 } 989 990 /** 991 * Displays the default admin color scheme picker (Used in user-edit.php). 992 * 993 * @since 3.0.0 994 * 995 * @global array $_wp_admin_css_colors 996 * 997 * @param int $user_id User ID. 998 */ 999 function admin_color_scheme_picker( $user_id ) { 1000 global $_wp_admin_css_colors; 1001 1002 ksort( $_wp_admin_css_colors ); 1003 1004 if ( isset( $_wp_admin_css_colors['fresh'] ) ) { 1005 // Set Default ('fresh') and Light should go first. 1006 $_wp_admin_css_colors = array_filter( 1007 array_merge( 1008 array( 1009 'fresh' => '', 1010 'light' => '', 1011 'modern' => '', 1012 ), 1013 $_wp_admin_css_colors 1014 ) 1015 ); 1016 } 1017 1018 $current_color = get_user_option( 'admin_color', $user_id ); 1019 1020 if ( empty( $current_color ) || ! isset( $_wp_admin_css_colors[ $current_color ] ) ) { 1021 $current_color = 'fresh'; 1022 } 1023 ?> 1024 <fieldset id="color-picker" class="scheme-list"> 1025 <legend class="screen-reader-text"><span> 1026 <?php 1027 /* translators: Hidden accessibility text. */ 1028 _e( 'Admin Color Scheme' ); 1029 ?> 1030 </span></legend> 1031 <?php 1032 wp_nonce_field( 'save-color-scheme', 'color-nonce', false ); 1033 foreach ( $_wp_admin_css_colors as $color => $color_info ) : 1034 1035 ?> 1036 <div class="color-option <?php echo ( $color === $current_color ) ? 'selected' : ''; ?>"> 1037 <input name="admin_color" id="admin_color_<?php echo esc_attr( $color ); ?>" type="radio" value="<?php echo esc_attr( $color ); ?>" class="tog" <?php checked( $color, $current_color ); ?> /> 1038 <input type="hidden" class="css_url" value="<?php echo esc_url( $color_info->url ); ?>" /> 1039 <input type="hidden" class="icon_colors" value="<?php echo esc_attr( wp_json_encode( array( 'icons' => $color_info->icon_colors ) ) ); ?>" /> 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 * 1061 * @global array $_wp_admin_css_colors 1062 */ 1063 function wp_color_scheme_settings() { 1064 global $_wp_admin_css_colors; 1065 1066 $color_scheme = get_user_option( 'admin_color' ); 1067 1068 // It's possible to have a color scheme set that is no longer registered. 1069 if ( empty( $_wp_admin_css_colors[ $color_scheme ] ) ) { 1070 $color_scheme = 'fresh'; 1071 } 1072 1073 if ( ! empty( $_wp_admin_css_colors[ $color_scheme ]->icon_colors ) ) { 1074 $icon_colors = $_wp_admin_css_colors[ $color_scheme ]->icon_colors; 1075 } elseif ( ! empty( $_wp_admin_css_colors['fresh']->icon_colors ) ) { 1076 $icon_colors = $_wp_admin_css_colors['fresh']->icon_colors; 1077 } else { 1078 // Fall back to the default set of icon colors if the default scheme is missing. 1079 $icon_colors = array( 1080 'base' => '#a7aaad', 1081 'focus' => '#72aee6', 1082 'current' => '#fff', 1083 ); 1084 } 1085 1086 echo '<script type="text/javascript">var _wpColorScheme = ' . wp_json_encode( array( 'icons' => $icon_colors ) ) . ";</script>\n"; 1087 } 1088 1089 /** 1090 * Displays the viewport meta in the admin. 1091 * 1092 * @since 5.5.0 1093 */ 1094 function wp_admin_viewport_meta() { 1095 /** 1096 * Filters the viewport meta in the admin. 1097 * 1098 * @since 5.5.0 1099 * 1100 * @param string $viewport_meta The viewport meta. 1101 */ 1102 $viewport_meta = apply_filters( 'admin_viewport_meta', 'width=device-width,initial-scale=1.0' ); 1103 1104 if ( empty( $viewport_meta ) ) { 1105 return; 1106 } 1107 1108 echo '<meta name="viewport" content="' . esc_attr( $viewport_meta ) . '">'; 1109 } 1110 1111 /** 1112 * Adds viewport meta for mobile in Customizer. 1113 * 1114 * Hooked to the {@see 'admin_viewport_meta'} filter. 1115 * 1116 * @since 5.5.0 1117 * 1118 * @param string $viewport_meta The viewport meta. 1119 * @return string Filtered viewport meta. 1120 */ 1121 function _customizer_mobile_viewport_meta( $viewport_meta ) { 1122 return trim( $viewport_meta, ',' ) . ',minimum-scale=0.5,maximum-scale=1.2'; 1123 } 1124 1125 /** 1126 * Checks lock status for posts displayed on the Posts screen. 1127 * 1128 * @since 3.6.0 1129 * 1130 * @param array $response The Heartbeat response. 1131 * @param array $data The $_POST data sent. 1132 * @param string $screen_id The screen ID. 1133 * @return array The Heartbeat response. 1134 */ 1135 function wp_check_locked_posts( $response, $data, $screen_id ) { 1136 $checked = array(); 1137 1138 if ( array_key_exists( 'wp-check-locked-posts', $data ) && is_array( $data['wp-check-locked-posts'] ) ) { 1139 foreach ( $data['wp-check-locked-posts'] as $key ) { 1140 $post_id = absint( substr( $key, 5 ) ); 1141 1142 if ( ! $post_id ) { 1143 continue; 1144 } 1145 1146 $user_id = wp_check_post_lock( $post_id ); 1147 1148 if ( $user_id ) { 1149 $user = get_userdata( $user_id ); 1150 1151 if ( $user && current_user_can( 'edit_post', $post_id ) ) { 1152 $send = array( 1153 'name' => $user->display_name, 1154 /* translators: %s: User's display name. */ 1155 'text' => sprintf( __( '%s is currently editing' ), $user->display_name ), 1156 ); 1157 1158 if ( get_option( 'show_avatars' ) ) { 1159 $send['avatar_src'] = get_avatar_url( $user->ID, array( 'size' => 18 ) ); 1160 $send['avatar_src_2x'] = get_avatar_url( $user->ID, array( 'size' => 36 ) ); 1161 } 1162 1163 $checked[ $key ] = $send; 1164 } 1165 } 1166 } 1167 } 1168 1169 if ( ! empty( $checked ) ) { 1170 $response['wp-check-locked-posts'] = $checked; 1171 } 1172 1173 return $response; 1174 } 1175 1176 /** 1177 * Checks lock status on the New/Edit Post screen and refresh the lock. 1178 * 1179 * @since 3.6.0 1180 * 1181 * @param array $response The Heartbeat response. 1182 * @param array $data The $_POST data sent. 1183 * @param string $screen_id The screen ID. 1184 * @return array The Heartbeat response. 1185 */ 1186 function wp_refresh_post_lock( $response, $data, $screen_id ) { 1187 if ( array_key_exists( 'wp-refresh-post-lock', $data ) ) { 1188 $received = $data['wp-refresh-post-lock']; 1189 $send = array(); 1190 1191 $post_id = absint( $received['post_id'] ); 1192 1193 if ( ! $post_id ) { 1194 return $response; 1195 } 1196 1197 if ( ! current_user_can( 'edit_post', $post_id ) ) { 1198 return $response; 1199 } 1200 1201 $user_id = wp_check_post_lock( $post_id ); 1202 $user = get_userdata( $user_id ); 1203 1204 if ( $user ) { 1205 $error = array( 1206 'name' => $user->display_name, 1207 /* translators: %s: User's display name. */ 1208 'text' => sprintf( __( '%s has taken over and is currently editing.' ), $user->display_name ), 1209 ); 1210 1211 if ( get_option( 'show_avatars' ) ) { 1212 $error['avatar_src'] = get_avatar_url( $user->ID, array( 'size' => 64 ) ); 1213 $error['avatar_src_2x'] = get_avatar_url( $user->ID, array( 'size' => 128 ) ); 1214 } 1215 1216 $send['lock_error'] = $error; 1217 } else { 1218 $new_lock = wp_set_post_lock( $post_id ); 1219 1220 if ( $new_lock ) { 1221 $send['new_lock'] = implode( ':', $new_lock ); 1222 } 1223 } 1224 1225 $response['wp-refresh-post-lock'] = $send; 1226 } 1227 1228 return $response; 1229 } 1230 1231 /** 1232 * Checks nonce expiration on the New/Edit Post screen and refresh if needed. 1233 * 1234 * @since 3.6.0 1235 * 1236 * @param array $response The Heartbeat response. 1237 * @param array $data The $_POST data sent. 1238 * @param string $screen_id The screen ID. 1239 * @return array The Heartbeat response. 1240 */ 1241 function wp_refresh_post_nonces( $response, $data, $screen_id ) { 1242 if ( array_key_exists( 'wp-refresh-post-nonces', $data ) ) { 1243 $received = $data['wp-refresh-post-nonces']; 1244 1245 $response['wp-refresh-post-nonces'] = array( 'check' => 1 ); 1246 1247 $post_id = absint( $received['post_id'] ); 1248 1249 if ( ! $post_id ) { 1250 return $response; 1251 } 1252 1253 if ( ! current_user_can( 'edit_post', $post_id ) ) { 1254 return $response; 1255 } 1256 1257 $response['wp-refresh-post-nonces'] = array( 1258 'replace' => array( 1259 'getpermalinknonce' => wp_create_nonce( 'getpermalink' ), 1260 'samplepermalinknonce' => wp_create_nonce( 'samplepermalink' ), 1261 'closedpostboxesnonce' => wp_create_nonce( 'closedpostboxes' ), 1262 '_ajax_linking_nonce' => wp_create_nonce( 'internal-linking' ), 1263 '_wpnonce' => wp_create_nonce( 'update-post_' . $post_id ), 1264 ), 1265 ); 1266 } 1267 1268 return $response; 1269 } 1270 1271 /** 1272 * Refresh nonces used with meta boxes in the block editor. 1273 * 1274 * @since 6.1.0 1275 * 1276 * @param array $response The Heartbeat response. 1277 * @param array $data The $_POST data sent. 1278 * @return array The Heartbeat response. 1279 */ 1280 function wp_refresh_metabox_loader_nonces( $response, $data ) { 1281 if ( empty( $data['wp-refresh-metabox-loader-nonces'] ) ) { 1282 return $response; 1283 } 1284 1285 $received = $data['wp-refresh-metabox-loader-nonces']; 1286 $post_id = (int) $received['post_id']; 1287 1288 if ( ! $post_id ) { 1289 return $response; 1290 } 1291 1292 if ( ! current_user_can( 'edit_post', $post_id ) ) { 1293 return $response; 1294 } 1295 1296 $response['wp-refresh-metabox-loader-nonces'] = array( 1297 'replace' => array( 1298 'metabox_loader_nonce' => wp_create_nonce( 'meta-box-loader' ), 1299 '_wpnonce' => wp_create_nonce( 'update-post_' . $post_id ), 1300 ), 1301 ); 1302 1303 return $response; 1304 } 1305 1306 /** 1307 * Adds the latest Heartbeat and REST API nonce to the Heartbeat response. 1308 * 1309 * @since 5.0.0 1310 * 1311 * @param array $response The Heartbeat response. 1312 * @return array The Heartbeat response. 1313 */ 1314 function wp_refresh_heartbeat_nonces( $response ) { 1315 // Refresh the Rest API nonce. 1316 $response['rest_nonce'] = wp_create_nonce( 'wp_rest' ); 1317 1318 // Refresh the Heartbeat nonce. 1319 $response['heartbeat_nonce'] = wp_create_nonce( 'heartbeat-nonce' ); 1320 1321 return $response; 1322 } 1323 1324 /** 1325 * Disables suspension of Heartbeat on the Add/Edit Post screens. 1326 * 1327 * @since 3.8.0 1328 * 1329 * @global string $pagenow The filename of the current screen. 1330 * 1331 * @param array $settings An array of Heartbeat settings. 1332 * @return array Filtered Heartbeat settings. 1333 */ 1334 function wp_heartbeat_set_suspension( $settings ) { 1335 global $pagenow; 1336 1337 if ( 'post.php' === $pagenow || 'post-new.php' === $pagenow ) { 1338 $settings['suspension'] = 'disable'; 1339 } 1340 1341 return $settings; 1342 } 1343 1344 /** 1345 * Performs autosave with heartbeat. 1346 * 1347 * @since 3.9.0 1348 * 1349 * @param array $response The Heartbeat response. 1350 * @param array $data The $_POST data sent. 1351 * @return array The Heartbeat response. 1352 */ 1353 function heartbeat_autosave( $response, $data ) { 1354 if ( ! empty( $data['wp_autosave'] ) ) { 1355 $saved = wp_autosave( $data['wp_autosave'] ); 1356 1357 if ( is_wp_error( $saved ) ) { 1358 $response['wp_autosave'] = array( 1359 'success' => false, 1360 'message' => $saved->get_error_message(), 1361 ); 1362 } elseif ( empty( $saved ) ) { 1363 $response['wp_autosave'] = array( 1364 'success' => false, 1365 'message' => __( 'Error while saving.' ), 1366 ); 1367 } else { 1368 /* translators: Draft saved date format, see https://www.php.net/manual/datetime.format.php */ 1369 $draft_saved_date_format = __( 'g:i:s a' ); 1370 $response['wp_autosave'] = array( 1371 'success' => true, 1372 /* translators: %s: Date and time. */ 1373 'message' => sprintf( __( 'Draft saved at %s.' ), date_i18n( $draft_saved_date_format ) ), 1374 ); 1375 } 1376 } 1377 1378 return $response; 1379 } 1380 1381 /** 1382 * Removes single-use URL parameters and create canonical link based on new URL. 1383 * 1384 * Removes specific query string parameters from a URL, create the canonical link, 1385 * put it in the admin header, and change the current URL to match. 1386 * 1387 * @since 4.2.0 1388 */ 1389 function wp_admin_canonical_url() { 1390 $removable_query_args = wp_removable_query_args(); 1391 1392 if ( empty( $removable_query_args ) ) { 1393 return; 1394 } 1395 1396 // Ensure we're using an absolute URL. 1397 $current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ); 1398 $filtered_url = remove_query_arg( $removable_query_args, $current_url ); 1399 1400 /** 1401 * Filters the admin canonical URL value. 1402 * 1403 * @since 6.5.0 1404 * 1405 * @param string $filtered_url The admin canonical URL value. 1406 */ 1407 $filtered_url = apply_filters( 'wp_admin_canonical_url', $filtered_url ); 1408 ?> 1409 <link id="wp-admin-canonical" rel="canonical" href="<?php echo esc_url( $filtered_url ); ?>" /> 1410 <script> 1411 if ( window.history.replaceState ) { 1412 window.history.replaceState( null, null, document.getElementById( 'wp-admin-canonical' ).href + window.location.hash ); 1413 } 1414 </script> 1415 <?php 1416 } 1417 1418 /** 1419 * Sends a referrer policy header so referrers are not sent externally from administration screens. 1420 * 1421 * @since 4.9.0 1422 */ 1423 function wp_admin_headers() { 1424 $policy = 'strict-origin-when-cross-origin'; 1425 1426 /** 1427 * Filters the admin referrer policy header value. 1428 * 1429 * @since 4.9.0 1430 * @since 4.9.5 The default value was changed to 'strict-origin-when-cross-origin'. 1431 * 1432 * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy 1433 * 1434 * @param string $policy The admin referrer policy header value. Default 'strict-origin-when-cross-origin'. 1435 */ 1436 $policy = apply_filters( 'admin_referrer_policy', $policy ); 1437 1438 header( sprintf( 'Referrer-Policy: %s', $policy ) ); 1439 } 1440 1441 /** 1442 * Outputs JS that reloads the page if the user navigated to it with the Back or Forward button. 1443 * 1444 * Used on the Edit Post and Add New Post screens. Needed to ensure the page is not loaded from browser cache, 1445 * so the post title and editor content are the last saved versions. Ideally this script should run first in the head. 1446 * 1447 * @since 4.6.0 1448 */ 1449 function wp_page_reload_on_back_button_js() { 1450 ?> 1451 <script> 1452 if ( typeof performance !== 'undefined' && performance.navigation && performance.navigation.type === 2 ) { 1453 document.location.reload( true ); 1454 } 1455 </script> 1456 <?php 1457 } 1458 1459 /** 1460 * Sends a confirmation request email when a change of site admin email address is attempted. 1461 * 1462 * The new site admin address will not become active until confirmed. 1463 * 1464 * @since 3.0.0 1465 * @since 4.9.0 This function was moved from wp-admin/includes/ms.php so it's no longer Multisite specific. 1466 * 1467 * @param string $old_value The old site admin email address. 1468 * @param string $value The proposed new site admin email address. 1469 */ 1470 function update_option_new_admin_email( $old_value, $value ) { 1471 if ( get_option( 'admin_email' ) === $value || ! is_email( $value ) ) { 1472 return; 1473 } 1474 1475 $hash = md5( $value . time() . wp_rand() ); 1476 $new_admin_email = array( 1477 'hash' => $hash, 1478 'newemail' => $value, 1479 ); 1480 update_option( 'adminhash', $new_admin_email, false ); 1481 1482 $switched_locale = switch_to_user_locale( get_current_user_id() ); 1483 1484 /* translators: Do not translate USERNAME, ADMIN_URL, EMAIL, SITENAME, SITEURL: those are placeholders. */ 1485 $email_text = __( 1486 'Howdy ###USERNAME###, 1487 1488 Someone with administrator capabilities recently requested to have the 1489 administration email address changed on this site: 1490 ###SITEURL### 1491 1492 To confirm this change, please click on the following link: 1493 ###ADMIN_URL### 1494 1495 You can safely ignore and delete this email if you do not want to 1496 take this action. 1497 1498 This email has been sent to ###EMAIL### 1499 1500 Regards, 1501 All at ###SITENAME### 1502 ###SITEURL###' 1503 ); 1504 1505 /** 1506 * Filters the text of the email sent when a change of site admin email address is attempted. 1507 * 1508 * The following strings have a special meaning and will get replaced dynamically: 1509 * - ###USERNAME### The current user's username. 1510 * - ###ADMIN_URL### The link to click on to confirm the email change. 1511 * - ###EMAIL### The proposed new site admin email address. 1512 * - ###SITENAME### The name of the site. 1513 * - ###SITEURL### The URL to the site. 1514 * 1515 * @since MU (3.0.0) 1516 * @since 4.9.0 This filter is no longer Multisite specific. 1517 * 1518 * @param string $email_text Text in the email. 1519 * @param array $new_admin_email { 1520 * Data relating to the new site admin email address. 1521 * 1522 * @type string $hash The secure hash used in the confirmation link URL. 1523 * @type string $newemail The proposed new site admin email address. 1524 * } 1525 */ 1526 $content = apply_filters( 'new_admin_email_content', $email_text, $new_admin_email ); 1527 1528 $current_user = wp_get_current_user(); 1529 $content = str_replace( '###USERNAME###', $current_user->user_login, $content ); 1530 $content = str_replace( '###ADMIN_URL###', esc_url( self_admin_url( 'options.php?adminhash=' . $hash ) ), $content ); 1531 $content = str_replace( '###EMAIL###', $value, $content ); 1532 $content = str_replace( '###SITENAME###', wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ), $content ); 1533 $content = str_replace( '###SITEURL###', home_url(), $content ); 1534 1535 if ( '' !== get_option( 'blogname' ) ) { 1536 $site_title = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ); 1537 } else { 1538 $site_title = parse_url( home_url(), PHP_URL_HOST ); 1539 } 1540 1541 $subject = sprintf( 1542 /* translators: New admin email address notification email subject. %s: Site title. */ 1543 __( '[%s] New Admin Email Address' ), 1544 $site_title 1545 ); 1546 1547 /** 1548 * Filters the subject of the email sent when a change of site admin email address is attempted. 1549 * 1550 * @since 6.5.0 1551 * 1552 * @param string $subject Subject of the email. 1553 */ 1554 $subject = apply_filters( 'new_admin_email_subject', $subject ); 1555 1556 wp_mail( $value, $subject, $content ); 1557 1558 if ( $switched_locale ) { 1559 restore_previous_locale(); 1560 } 1561 } 1562 1563 /** 1564 * Appends '(Draft)' to draft page titles in the privacy page dropdown 1565 * so that unpublished content is obvious. 1566 * 1567 * @since 4.9.8 1568 * @access private 1569 * 1570 * @param string $title Page title. 1571 * @param WP_Post $page Page data object. 1572 * @return string Page title. 1573 */ 1574 function _wp_privacy_settings_filter_draft_page_titles( $title, $page ) { 1575 if ( 'draft' === $page->post_status && 'privacy' === get_current_screen()->id ) { 1576 /* translators: %s: Page title. */ 1577 $title = sprintf( __( '%s (Draft)' ), $title ); 1578 } 1579 1580 return $title; 1581 } 1582 1583 /** 1584 * Checks if the user needs to update PHP. 1585 * 1586 * @since 5.1.0 1587 * @since 5.1.1 Added the {@see 'wp_is_php_version_acceptable'} filter. 1588 * 1589 * @return array|false { 1590 * Array of PHP version data. False on failure. 1591 * 1592 * @type string $recommended_version The PHP version recommended by WordPress. 1593 * @type string $minimum_version The minimum required PHP version. 1594 * @type bool $is_supported Whether the PHP version is actively supported. 1595 * @type bool $is_secure Whether the PHP version receives security updates. 1596 * @type bool $is_acceptable Whether the PHP version is still acceptable or warnings 1597 * should be shown and an update recommended. 1598 * } 1599 */ 1600 function wp_check_php_version() { 1601 $version = PHP_VERSION; 1602 $key = md5( $version ); 1603 1604 $response = get_site_transient( 'php_check_' . $key ); 1605 1606 if ( false === $response ) { 1607 $url = 'http://api.wordpress.org/core/serve-happy/1.0/'; 1608 1609 if ( wp_http_supports( array( 'ssl' ) ) ) { 1610 $url = set_url_scheme( $url, 'https' ); 1611 } 1612 1613 $url = add_query_arg( 'php_version', $version, $url ); 1614 1615 $response = wp_remote_get( $url ); 1616 1617 if ( is_wp_error( $response ) || 200 !== wp_remote_retrieve_response_code( $response ) ) { 1618 return false; 1619 } 1620 1621 $response = json_decode( wp_remote_retrieve_body( $response ), true ); 1622 1623 if ( ! is_array( $response ) ) { 1624 return false; 1625 } 1626 1627 set_site_transient( 'php_check_' . $key, $response, WEEK_IN_SECONDS ); 1628 } 1629 1630 if ( isset( $response['is_acceptable'] ) && $response['is_acceptable'] ) { 1631 /** 1632 * Filters whether the active PHP version is considered acceptable by WordPress. 1633 * 1634 * Returning false will trigger a PHP version warning to show up in the admin dashboard to administrators. 1635 * 1636 * This filter is only run if the wordpress.org Serve Happy API considers the PHP version acceptable, ensuring 1637 * that this filter can only make this check stricter, but not loosen it. 1638 * 1639 * @since 5.1.1 1640 * 1641 * @param bool $is_acceptable Whether the PHP version is considered acceptable. Default true. 1642 * @param string $version PHP version checked. 1643 */ 1644 $response['is_acceptable'] = (bool) apply_filters( 'wp_is_php_version_acceptable', true, $version ); 1645 } 1646 1647 $response['is_lower_than_future_minimum'] = false; 1648 1649 // The minimum supported PHP version will be updated to 7.4 in the future. Check if the current version is lower. 1650 if ( version_compare( $version, '7.4', '<' ) ) { 1651 $response['is_lower_than_future_minimum'] = true; 1652 1653 // Force showing of warnings. 1654 $response['is_acceptable'] = false; 1655 } 1656 1657 return $response; 1658 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Thu Nov 21 08:20:01 2024 | Cross-referenced by PHPXref |