/wp-admin/includes/misc.php
PHP | 660 lines | 432 code | 70 blank | 158 comment | 107 complexity | 0c76b47946c53f02ef2ae635f99f21b2 MD5 | raw file
Possible License(s): GPL-2.0, AGPL-1.0, LGPL-2.1
- <?php
- /**
- * Misc WordPress Administration API.
- *
- * @package WordPress
- * @subpackage Administration
- */
- /**
- * {@internal Missing Short Description}}
- *
- * @since 2.0.0
- *
- * @return unknown
- */
- function got_mod_rewrite() {
- $got_rewrite = apache_mod_loaded('mod_rewrite', true);
- return apply_filters('got_rewrite', $got_rewrite);
- }
- /**
- * {@internal Missing Short Description}}
- *
- * @since 1.5.0
- *
- * @param unknown_type $filename
- * @param unknown_type $marker
- * @return array An array of strings from a file (.htaccess ) from between BEGIN and END markers.
- */
- function extract_from_markers( $filename, $marker ) {
- $result = array ();
- if (!file_exists( $filename ) ) {
- return $result;
- }
- if ( $markerdata = explode( "\n", implode( '', file( $filename ) ) ));
- {
- $state = false;
- foreach ( $markerdata as $markerline ) {
- if (strpos($markerline, '# END ' . $marker) !== false)
- $state = false;
- if ( $state )
- $result[] = $markerline;
- if (strpos($markerline, '# BEGIN ' . $marker) !== false)
- $state = true;
- }
- }
- return $result;
- }
- /**
- * {@internal Missing Short Description}}
- *
- * Inserts an array of strings into a file (.htaccess ), placing it between
- * BEGIN and END markers. Replaces existing marked info. Retains surrounding
- * data. Creates file if none exists.
- *
- * @since 1.5.0
- *
- * @param unknown_type $filename
- * @param unknown_type $marker
- * @param unknown_type $insertion
- * @return bool True on write success, false on failure.
- */
- function insert_with_markers( $filename, $marker, $insertion ) {
- if (!file_exists( $filename ) || is_writeable( $filename ) ) {
- if (!file_exists( $filename ) ) {
- $markerdata = '';
- } else {
- $markerdata = explode( "\n", implode( '', file( $filename ) ) );
- }
- if ( !$f = @fopen( $filename, 'w' ) )
- return false;
- $foundit = false;
- if ( $markerdata ) {
- $state = true;
- foreach ( $markerdata as $n => $markerline ) {
- if (strpos($markerline, '# BEGIN ' . $marker) !== false)
- $state = false;
- if ( $state ) {
- if ( $n + 1 < count( $markerdata ) )
- fwrite( $f, "{$markerline}\n" );
- else
- fwrite( $f, "{$markerline}" );
- }
- if (strpos($markerline, '# END ' . $marker) !== false) {
- fwrite( $f, "# BEGIN {$marker}\n" );
- if ( is_array( $insertion ))
- foreach ( $insertion as $insertline )
- fwrite( $f, "{$insertline}\n" );
- fwrite( $f, "# END {$marker}\n" );
- $state = true;
- $foundit = true;
- }
- }
- }
- if (!$foundit) {
- fwrite( $f, "\n# BEGIN {$marker}\n" );
- foreach ( $insertion as $insertline )
- fwrite( $f, "{$insertline}\n" );
- fwrite( $f, "# END {$marker}\n" );
- }
- fclose( $f );
- return true;
- } else {
- return false;
- }
- }
- /**
- * Updates the htaccess file with the current rules if it is writable.
- *
- * Always writes to the file if it exists and is writable to ensure that we
- * blank out old rules.
- *
- * @since 1.5.0
- */
- function save_mod_rewrite_rules() {
- if ( is_multisite() )
- return;
- global $wp_rewrite;
- $home_path = get_home_path();
- $htaccess_file = $home_path.'.htaccess';
- // If the file doesn't already exist check for write access to the directory and whether we have some rules.
- // else check for write access to the file.
- if ((!file_exists($htaccess_file) && is_writable($home_path) && $wp_rewrite->using_mod_rewrite_permalinks()) || is_writable($htaccess_file)) {
- if ( got_mod_rewrite() ) {
- $rules = explode( "\n", $wp_rewrite->mod_rewrite_rules() );
- return insert_with_markers( $htaccess_file, 'WordPress', $rules );
- }
- }
- return false;
- }
- /**
- * Updates the IIS web.config file with the current rules if it is writable.
- * If the permalinks do not require rewrite rules then the rules are deleted from the web.config file.
- *
- * @since 2.8.0
- *
- * @return bool True if web.config was updated successfully
- */
- function iis7_save_url_rewrite_rules(){
- if ( is_multisite() )
- return;
- global $wp_rewrite;
- $home_path = get_home_path();
- $web_config_file = $home_path . 'web.config';
- // Using win_is_writable() instead of is_writable() because of a bug in Windows PHP
- if ( iis7_supports_permalinks() && ( ( ! file_exists($web_config_file) && win_is_writable($home_path) && $wp_rewrite->using_mod_rewrite_permalinks() ) || win_is_writable($web_config_file) ) ) {
- $rule = $wp_rewrite->iis7_url_rewrite_rules(false, '', '');
- if ( ! empty($rule) ) {
- return iis7_add_rewrite_rule($web_config_file, $rule);
- } else {
- return iis7_delete_rewrite_rule($web_config_file);
- }
- }
- return false;
- }
- /**
- * {@internal Missing Short Description}}
- *
- * @since 1.5.0
- *
- * @param unknown_type $file
- */
- function update_recently_edited( $file ) {
- $oldfiles = (array ) get_option( 'recently_edited' );
- if ( $oldfiles ) {
- $oldfiles = array_reverse( $oldfiles );
- $oldfiles[] = $file;
- $oldfiles = array_reverse( $oldfiles );
- $oldfiles = array_unique( $oldfiles );
- if ( 5 < count( $oldfiles ))
- array_pop( $oldfiles );
- } else {
- $oldfiles[] = $file;
- }
- update_option( 'recently_edited', $oldfiles );
- }
- /**
- * If siteurl, home or page_on_front changed, flush rewrite rules.
- *
- * @since 2.1.0
- *
- * @param string $old_value
- * @param string $value
- */
- function update_home_siteurl( $old_value, $value ) {
- if ( defined( "WP_INSTALLING" ) )
- return;
- // If home changed, write rewrite rules to new location.
- flush_rewrite_rules();
- }
- add_action( 'update_option_home', 'update_home_siteurl', 10, 2 );
- add_action( 'update_option_siteurl', 'update_home_siteurl', 10, 2 );
- add_action( 'update_option_page_on_front', 'update_home_siteurl', 10, 2 );
- /**
- * Shorten an URL, to be used as link text
- *
- * @since 1.2.1
- *
- * @param string $url
- * @return string
- */
- function url_shorten( $url ) {
- $short_url = str_replace( array( 'http://', 'www.' ), '', $url );
- $short_url = untrailingslashit( $short_url );
- if ( strlen( $short_url ) > 35 )
- $short_url = substr( $short_url, 0, 32 ) . '...';
- return $short_url;
- }
- /**
- * Resets global variables based on $_GET and $_POST
- *
- * This function resets global variables based on the names passed
- * in the $vars array to the value of $_POST[$var] or $_GET[$var] or ''
- * if neither is defined.
- *
- * @since 2.0.0
- *
- * @param array $vars An array of globals to reset.
- */
- function wp_reset_vars( $vars ) {
- for ( $i=0; $i<count( $vars ); $i += 1 ) {
- $var = $vars[$i];
- global $$var;
- if ( empty( $_POST[$var] ) ) {
- if ( empty( $_GET[$var] ) )
- $$var = '';
- else
- $$var = $_GET[$var];
- } else {
- $$var = $_POST[$var];
- }
- }
- }
- /**
- * {@internal Missing Short Description}}
- *
- * @since 2.1.0
- *
- * @param unknown_type $message
- */
- function show_message($message) {
- if ( is_wp_error($message) ){
- if ( $message->get_error_data() )
- $message = $message->get_error_message() . ': ' . $message->get_error_data();
- else
- $message = $message->get_error_message();
- }
- echo "<p>$message</p>\n";
- wp_ob_end_flush_all();
- flush();
- }
- function wp_doc_link_parse( $content ) {
- if ( !is_string( $content ) || empty( $content ) )
- return array();
- if ( !function_exists('token_get_all') )
- return array();
- $tokens = token_get_all( $content );
- $functions = array();
- $ignore_functions = array();
- for ( $t = 0, $count = count( $tokens ); $t < $count; $t++ ) {
- if ( !is_array( $tokens[$t] ) ) continue;
- if ( T_STRING == $tokens[$t][0] && ( '(' == $tokens[ $t + 1 ] || '(' == $tokens[ $t + 2 ] ) ) {
- // If it's a function or class defined locally, there's not going to be any docs available
- if ( ( isset( $tokens[ $t - 2 ][1] ) && in_array( $tokens[ $t - 2 ][1], array( 'function', 'class' ) ) ) || ( isset( $tokens[ $t - 2 ][0] ) && T_OBJECT_OPERATOR == $tokens[ $t - 1 ][0] ) ) {
- $ignore_functions[] = $tokens[$t][1];
- }
- // Add this to our stack of unique references
- $functions[] = $tokens[$t][1];
- }
- }
- $functions = array_unique( $functions );
- sort( $functions );
- $ignore_functions = apply_filters( 'documentation_ignore_functions', $ignore_functions );
- $ignore_functions = array_unique( $ignore_functions );
- $out = array();
- foreach ( $functions as $function ) {
- if ( in_array( $function, $ignore_functions ) )
- continue;
- $out[] = $function;
- }
- return $out;
- }
- /**
- * Saves option for number of rows when listing posts, pages, comments, etc.
- *
- * @since 2.8
- **/
- function set_screen_options() {
- if ( isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options']) ) {
- check_admin_referer( 'screen-options-nonce', 'screenoptionnonce' );
- if ( !$user = wp_get_current_user() )
- return;
- $option = $_POST['wp_screen_options']['option'];
- $value = $_POST['wp_screen_options']['value'];
- if ( $option != sanitize_key( $option ) )
- return;
- $map_option = $option;
- $type = str_replace('edit_', '', $map_option);
- $type = str_replace('_per_page', '', $type);
- if ( in_array( $type, get_taxonomies() ) )
- $map_option = 'edit_tags_per_page';
- elseif ( in_array( $type, get_post_types() ) )
- $map_option = 'edit_per_page';
- else
- $option = str_replace('-', '_', $option);
- switch ( $map_option ) {
- case 'edit_per_page':
- case 'users_per_page':
- case 'edit_comments_per_page':
- case 'upload_per_page':
- case 'edit_tags_per_page':
- case 'plugins_per_page':
- // Network admin
- case 'sites_network_per_page':
- case 'users_network_per_page':
- case 'site_users_network_per_page':
- case 'plugins_network_per_page':
- case 'themes_network_per_page':
- case 'site_themes_network_per_page':
- $value = (int) $value;
- if ( $value < 1 || $value > 999 )
- return;
- break;
- default:
- $value = apply_filters('set-screen-option', false, $option, $value);
- if ( false === $value )
- return;
- break;
- }
- update_user_meta($user->ID, $option, $value);
- wp_safe_redirect( remove_query_arg( array('pagenum', 'apage', 'paged'), wp_get_referer() ) );
- exit;
- }
- }
- /**
- * Check if rewrite rule for WordPress already exists in the IIS 7 configuration file
- *
- * @since 2.8.0
- *
- * @return bool
- * @param string $filename The file path to the configuration file
- */
- function iis7_rewrite_rule_exists($filename) {
- if ( ! file_exists($filename) )
- return false;
- if ( ! class_exists('DOMDocument') )
- return false;
- $doc = new DOMDocument();
- if ( $doc->load($filename) === false )
- return false;
- $xpath = new DOMXPath($doc);
- $rules = $xpath->query('/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')]');
- if ( $rules->length == 0 )
- return false;
- else
- return true;
- }
- /**
- * Delete WordPress rewrite rule from web.config file if it exists there
- *
- * @since 2.8.0
- *
- * @param string $filename Name of the configuration file
- * @return bool
- */
- function iis7_delete_rewrite_rule($filename) {
- // If configuration file does not exist then rules also do not exist so there is nothing to delete
- if ( ! file_exists($filename) )
- return true;
- if ( ! class_exists('DOMDocument') )
- return false;
- $doc = new DOMDocument();
- $doc->preserveWhiteSpace = false;
- if ( $doc -> load($filename) === false )
- return false;
- $xpath = new DOMXPath($doc);
- $rules = $xpath->query('/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')]');
- if ( $rules->length > 0 ) {
- $child = $rules->item(0);
- $parent = $child->parentNode;
- $parent->removeChild($child);
- $doc->formatOutput = true;
- saveDomDocument($doc, $filename);
- }
- return true;
- }
- /**
- * Add WordPress rewrite rule to the IIS 7 configuration file.
- *
- * @since 2.8.0
- *
- * @param string $filename The file path to the configuration file
- * @param string $rewrite_rule The XML fragment with URL Rewrite rule
- * @return bool
- */
- function iis7_add_rewrite_rule($filename, $rewrite_rule) {
- if ( ! class_exists('DOMDocument') )
- return false;
- // If configuration file does not exist then we create one.
- if ( ! file_exists($filename) ) {
- $fp = fopen( $filename, 'w');
- fwrite($fp, '<configuration/>');
- fclose($fp);
- }
- $doc = new DOMDocument();
- $doc->preserveWhiteSpace = false;
- if ( $doc->load($filename) === false )
- return false;
- $xpath = new DOMXPath($doc);
- // First check if the rule already exists as in that case there is no need to re-add it
- $wordpress_rules = $xpath->query('/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')]');
- if ( $wordpress_rules->length > 0 )
- return true;
- // Check the XPath to the rewrite rule and create XML nodes if they do not exist
- $xmlnodes = $xpath->query('/configuration/system.webServer/rewrite/rules');
- if ( $xmlnodes->length > 0 ) {
- $rules_node = $xmlnodes->item(0);
- } else {
- $rules_node = $doc->createElement('rules');
- $xmlnodes = $xpath->query('/configuration/system.webServer/rewrite');
- if ( $xmlnodes->length > 0 ) {
- $rewrite_node = $xmlnodes->item(0);
- $rewrite_node->appendChild($rules_node);
- } else {
- $rewrite_node = $doc->createElement('rewrite');
- $rewrite_node->appendChild($rules_node);
- $xmlnodes = $xpath->query('/configuration/system.webServer');
- if ( $xmlnodes->length > 0 ) {
- $system_webServer_node = $xmlnodes->item(0);
- $system_webServer_node->appendChild($rewrite_node);
- } else {
- $system_webServer_node = $doc->createElement('system.webServer');
- $system_webServer_node->appendChild($rewrite_node);
- $xmlnodes = $xpath->query('/configuration');
- if ( $xmlnodes->length > 0 ) {
- $config_node = $xmlnodes->item(0);
- $config_node->appendChild($system_webServer_node);
- } else {
- $config_node = $doc->createElement('configuration');
- $doc->appendChild($config_node);
- $config_node->appendChild($system_webServer_node);
- }
- }
- }
- }
- $rule_fragment = $doc->createDocumentFragment();
- $rule_fragment->appendXML($rewrite_rule);
- $rules_node->appendChild($rule_fragment);
- $doc->encoding = "UTF-8";
- $doc->formatOutput = true;
- saveDomDocument($doc, $filename);
- return true;
- }
- /**
- * Saves the XML document into a file
- *
- * @since 2.8.0
- *
- * @param DOMDocument $doc
- * @param string $filename
- */
- function saveDomDocument($doc, $filename) {
- $config = $doc->saveXML();
- $config = preg_replace("/([^\r])\n/", "$1\r\n", $config);
- $fp = fopen($filename, 'w');
- fwrite($fp, $config);
- fclose($fp);
- }
- /**
- * Display the default admin color scheme picker (Used in user-edit.php)
- *
- * @since 3.0.0
- */
- function admin_color_scheme_picker() {
- global $_wp_admin_css_colors, $user_id; ?>
- <fieldset><legend class="screen-reader-text"><span><?php _e('Admin Color Scheme')?></span></legend>
- <?php
- $current_color = get_user_option('admin_color', $user_id);
- if ( empty($current_color) )
- $current_color = 'fresh';
- foreach ( $_wp_admin_css_colors as $color => $color_info ): ?>
- <div class="color-option"><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); ?> />
- <table class="color-palette">
- <tr>
- <?php foreach ( $color_info->colors as $html_color ): ?>
- <td style="background-color: <?php echo esc_attr( $html_color ); ?>" title="<?php echo esc_attr( $color ); ?>"> </td>
- <?php endforeach; ?>
- </tr>
- </table>
- <label for="admin_color_<?php echo esc_attr( $color ); ?>"><?php echo esc_html( $color_info->name ); ?></label>
- </div>
- <?php endforeach; ?>
- </fieldset>
- <?php
- }
- function _ipad_meta() {
- if ( wp_is_mobile() ) {
- ?>
- <meta name="viewport" id="viewport-meta" content="width=device-width, initial-scale=1">
- <?php
- }
- }
- add_action('admin_head', '_ipad_meta');
- /**
- * Check lock status for posts displayed on the Posts screen
- *
- * @since 3.6
- */
- function wp_check_locked_posts( $response, $data, $screen_id ) {
- $checked = array();
- if ( 'edit-post' == $screen_id && array_key_exists( 'wp-check-locked', $data ) && is_array( $data['wp-check-locked'] ) ) {
- foreach ( $data['wp-check-locked'] as $key ) {
- $post_id = (int) substr( $key, 5 );
- if ( current_user_can( 'edit_post', $post_id ) && ( $user_id = wp_check_post_lock( $post_id ) ) && ( $user = get_userdata( $user_id ) ) ) {
- $send = array();
- if ( ( $avatar = get_avatar( $user->ID, 18 ) ) && preg_match( "|src='([^']+)'|", $avatar, $matches ) )
- $send['avatar_src'] = $matches[1];
- $send['text'] = sprintf( __( '%s is currently editing' ), $user->display_name );
- $checked[$key] = $send;
- }
- }
- }
- if ( ! empty( $checked ) )
- $response['wp-check-locked'] = $checked;
- return $response;
- }
- add_filter( 'heartbeat_received', 'wp_check_locked_posts', 10, 3 );
- /**
- * Check lock status on the New/Edit Post screen and refresh the lock
- *
- * @since 3.6
- */
- function wp_refresh_post_lock( $response, $data, $screen_id ) {
- if ( 'post' == $screen_id && array_key_exists( 'wp-refresh-post-lock', $data ) ) {
- $received = $data['wp-refresh-post-lock'];
- $send = array();
- if ( !$post_id = absint( $received['post_id'] ) )
- return $response;
- if ( !current_user_can('edit_post', $post_id) )
- return $response;
- if ( $user_id = wp_check_post_lock( $post_id ) ) {
- $user = get_userdata( $user_id );
- $error = array(
- 'text' => sprintf( __( '%s has taken over and is currently editing.' ), $user->display_name )
- );
-
- if ( $avatar = get_avatar( $user->ID, 64 ) ) {
- if ( preg_match( "|src='([^']+)'|", $avatar, $matches ) )
- $error['avatar_src'] = $matches[1];
- }
- $send['lock_error'] = $error;
- } else {
- if ( $new_lock = wp_set_post_lock( $post_id ) )
- $send['new_lock'] = implode( ':', $new_lock );
- }
- $response['wp-refresh-post-lock'] = $send;
- }
- return $response;
- }
- add_filter( 'heartbeat_received', 'wp_refresh_post_lock', 10, 3 );
- /**
- * Output the HTML for restoring the post data from DOM storage
- *
- * @since 3.6
- * @access private
- */
- function _local_storage_notice() {
- $screen = get_current_screen();
- if ( ! $screen || 'post' != $screen->id )
- return;
- ?>
- <div id="local-storage-notice" class="hidden">
- <p class="local-restore">
- <?php _e('The backup of this post in your browser is different from the version below.'); ?>
- <a class="restore-backup" href="#"><?php _e('Restore the backup.'); ?></a>
- </p>
- <p class="undo-restore hidden">
- <?php _e('Post restored successfully.'); ?>
- <a class="undo-restore-backup" href="#"><?php _e('Undo.'); ?></a>
- </p>
- </div>
- <?php
- }
- add_action( 'admin_footer', '_local_storage_notice' );