WordPress 4.3
[autoinstalls/wordpress.git] / wp-admin / includes / misc.php
index 3680f8e5a954ec42eef6789d3c269306db1893da..3b6f0504162da8fbfc4ad75b561aa485c35afbc4 100644 (file)
@@ -22,9 +22,10 @@ function got_mod_rewrite() {
         * This filter was previously used to force URL rewriting for other servers,
         * like nginx. Use the got_url_rewrite filter in got_url_rewrite() instead.
         *
         * This filter was previously used to force URL rewriting for other servers,
         * like nginx. Use the got_url_rewrite filter in got_url_rewrite() instead.
         *
+        * @since 2.5.0
+        *
         * @see got_url_rewrite()
         *
         * @see got_url_rewrite()
         *
-        * @since 2.5.0
         * @param bool $got_rewrite Whether Apache and mod_rewrite are present.
         */
        return apply_filters( 'got_rewrite', $got_rewrite );
         * @param bool $got_rewrite Whether Apache and mod_rewrite are present.
         */
        return apply_filters( 'got_rewrite', $got_rewrite );
@@ -37,6 +38,8 @@ function got_mod_rewrite() {
  *
  * @since 3.7.0
  *
  *
  * @since 3.7.0
  *
+ * @global bool $is_nginx
+ *
  * @return bool Whether the server supports URL rewriting.
  */
 function got_url_rewrite() {
  * @return bool Whether the server supports URL rewriting.
  */
 function got_url_rewrite() {
@@ -46,6 +49,7 @@ function got_url_rewrite() {
         * Filter whether URL rewriting is available.
         *
         * @since 3.7.0
         * Filter whether URL rewriting is available.
         *
         * @since 3.7.0
+        *
         * @param bool $got_url_rewrite Whether URL rewriting is available.
         */
        return apply_filters( 'got_url_rewrite', $got_url_rewrite );
         * @param bool $got_url_rewrite Whether URL rewriting is available.
         */
        return apply_filters( 'got_url_rewrite', $got_url_rewrite );
@@ -56,8 +60,8 @@ function got_url_rewrite() {
  *
  * @since 1.5.0
  *
  *
  * @since 1.5.0
  *
- * @param unknown_type $filename
- * @param unknown_type $marker
+ * @param string $filename
+ * @param string $marker
  * @return array An array of strings from a file (.htaccess ) from between BEGIN and END markers.
  */
 function extract_from_markers( $filename, $marker ) {
  * @return array An array of strings from a file (.htaccess ) from between BEGIN and END markers.
  */
 function extract_from_markers( $filename, $marker ) {
@@ -92,9 +96,9 @@ function extract_from_markers( $filename, $marker ) {
  *
  * @since 1.5.0
  *
  *
  * @since 1.5.0
  *
- * @param unknown_type $filename
- * @param unknown_type $marker
- * @param unknown_type $insertion
+ * @param string $filename
+ * @param string $marker
+ * @param array  $insertion
  * @return bool True on write success, false on failure.
  */
 function insert_with_markers( $filename, $marker, $insertion ) {
  * @return bool True on write success, false on failure.
  */
 function insert_with_markers( $filename, $marker, $insertion ) {
@@ -151,6 +155,8 @@ function insert_with_markers( $filename, $marker, $insertion ) {
  * blank out old rules.
  *
  * @since 1.5.0
  * blank out old rules.
  *
  * @since 1.5.0
+ *
+ * @global WP_Rewrite $wp_rewrite
  */
 function save_mod_rewrite_rules() {
        if ( is_multisite() )
  */
 function save_mod_rewrite_rules() {
        if ( is_multisite() )
@@ -161,8 +167,10 @@ function save_mod_rewrite_rules() {
        $home_path = get_home_path();
        $htaccess_file = $home_path.'.htaccess';
 
        $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 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() );
        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() );
@@ -179,6 +187,8 @@ function save_mod_rewrite_rules() {
  *
  * @since 2.8.0
  *
  *
  * @since 2.8.0
  *
+ * @global WP_Rewrite $wp_rewrite
+ *
  * @return bool True if web.config was updated successfully
  */
 function iis7_save_url_rewrite_rules(){
  * @return bool True if web.config was updated successfully
  */
 function iis7_save_url_rewrite_rules(){
@@ -207,7 +217,7 @@ function iis7_save_url_rewrite_rules(){
  *
  * @since 1.5.0
  *
  *
  * @since 1.5.0
  *
- * @param unknown_type $file
+ * @param string $file
  */
 function update_recently_edited( $file ) {
        $oldfiles = (array ) get_option( 'recently_edited' );
  */
 function update_recently_edited( $file ) {
        $oldfiles = (array ) get_option( 'recently_edited' );
@@ -240,10 +250,6 @@ function update_home_siteurl( $old_value, $value ) {
        flush_rewrite_rules();
 }
 
        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
  *
 /**
  * Shorten an URL, to be used as link text
  *
@@ -272,17 +278,15 @@ function url_shorten( $url ) {
  * @param array $vars An array of globals to reset.
  */
 function wp_reset_vars( $vars ) {
  * @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];
+       foreach ( $vars as $var ) {
+               if ( empty( $_POST[ $var ] ) ) {
+                       if ( empty( $_GET[ $var ] ) ) {
+                               $GLOBALS[ $var ] = '';
+                       } else {
+                               $GLOBALS[ $var ] = $_GET[ $var ];
+                       }
                } else {
                } else {
-                       $$var = $_POST[$var];
+                       $GLOBALS[ $var ] = $_POST[ $var ];
                }
        }
 }
                }
        }
 }
@@ -292,7 +296,7 @@ function wp_reset_vars( $vars ) {
  *
  * @since 2.1.0
  *
  *
  * @since 2.1.0
  *
- * @param unknown_type $message
+ * @param string|WP_Error $message
  */
 function show_message($message) {
        if ( is_wp_error($message) ){
  */
 function show_message($message) {
        if ( is_wp_error($message) ){
@@ -306,6 +310,12 @@ function show_message($message) {
        flush();
 }
 
        flush();
 }
 
+/**
+ * @since 2.8.0
+ *
+ * @param string $content
+ * @return array
+ */
 function wp_doc_link_parse( $content ) {
        if ( !is_string( $content ) || empty( $content ) )
                return array();
 function wp_doc_link_parse( $content ) {
        if ( !is_string( $content ) || empty( $content ) )
                return array();
@@ -336,11 +346,11 @@ function wp_doc_link_parse( $content ) {
        sort( $functions );
 
        /**
        sort( $functions );
 
        /**
-        * Filter the list of functions/classes to be ignored from the documentation lookup.
+        * Filter the list of functions and classes to be ignored from the documentation lookup.
         *
         * @since 2.8.0
         *
         *
         * @since 2.8.0
         *
-        * @param array $ignore_functions Functions/Classes to be ignored.
+        * @param array $ignore_functions Functions and classes to be ignored.
         */
        $ignore_functions = apply_filters( 'documentation_ignore_functions', $ignore_functions );
 
         */
        $ignore_functions = apply_filters( 'documentation_ignore_functions', $ignore_functions );
 
@@ -591,6 +601,8 @@ function saveDomDocument($doc, $filename) {
  * Display the default admin color scheme picker (Used in user-edit.php)
  *
  * @since 3.0.0
  * Display the default admin color scheme picker (Used in user-edit.php)
  *
  * @since 3.0.0
+ *
+ * @global array $_wp_admin_css_colors
  */
 function admin_color_scheme_picker( $user_id ) {
        global $_wp_admin_css_colors;
  */
 function admin_color_scheme_picker( $user_id ) {
        global $_wp_admin_css_colors;
@@ -619,7 +631,7 @@ function admin_color_scheme_picker( $user_id ) {
                        <div class="color-option <?php echo ( $color == $current_color ) ? 'selected' : ''; ?>">
                                <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 ); ?> />
                                <input type="hidden" class="css_url" value="<?php echo esc_url( $color_info->url ); ?>" />
                        <div class="color-option <?php echo ( $color == $current_color ) ? 'selected' : ''; ?>">
                                <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 ); ?> />
                                <input type="hidden" class="css_url" value="<?php echo esc_url( $color_info->url ); ?>" />
-                               <input type="hidden" class="icon_colors" value="<?php echo esc_attr( json_encode( array( 'icons' => $color_info->icon_colors ) ) ); ?>" />
+                               <input type="hidden" class="icon_colors" value="<?php echo esc_attr( wp_json_encode( array( 'icons' => $color_info->icon_colors ) ) ); ?>" />
                                <label for="admin_color_<?php echo esc_attr( $color ); ?>"><?php echo esc_html( $color_info->name ); ?></label>
                                <table class="color-palette">
                                        <tr>
                                <label for="admin_color_<?php echo esc_attr( $color ); ?>"><?php echo esc_html( $color_info->name ); ?></label>
                                <table class="color-palette">
                                        <tr>
@@ -644,6 +656,10 @@ function admin_color_scheme_picker( $user_id ) {
        <?php
 }
 
        <?php
 }
 
+/**
+ *
+ * @global array $_wp_admin_css_colors
+ */
 function wp_color_scheme_settings() {
        global $_wp_admin_css_colors;
 
 function wp_color_scheme_settings() {
        global $_wp_admin_css_colors;
 
@@ -660,13 +676,15 @@ function wp_color_scheme_settings() {
                $icon_colors = $_wp_admin_css_colors['fresh']->icon_colors;
        } else {
                // Fall back to the default set of icon colors if the default scheme is missing.
                $icon_colors = $_wp_admin_css_colors['fresh']->icon_colors;
        } else {
                // Fall back to the default set of icon colors if the default scheme is missing.
-               $icon_colors = array( 'base' => '#999', 'focus' => '#2ea2cc', 'current' => '#fff' );
+               $icon_colors = array( 'base' => '#999', 'focus' => '#00a0d2', 'current' => '#fff' );
        }
 
        }
 
-       echo '<script type="text/javascript">var _wpColorScheme = ' . json_encode( array( 'icons' => $icon_colors ) ) . ";</script>\n";
+       echo '<script type="text/javascript">var _wpColorScheme = ' . wp_json_encode( array( 'icons' => $icon_colors ) ) . ";</script>\n";
 }
 }
-add_action( 'admin_head', 'wp_color_scheme_settings' );
 
 
+/**
+ * @since 3.3.0
+ */
 function _ipad_meta() {
        if ( wp_is_mobile() ) {
                ?>
 function _ipad_meta() {
        if ( wp_is_mobile() ) {
                ?>
@@ -674,7 +692,6 @@ function _ipad_meta() {
                <?php
        }
 }
                <?php
        }
 }
-add_action('admin_head', '_ipad_meta');
 
 /**
  * Check lock status for posts displayed on the Posts screen
 
 /**
  * Check lock status for posts displayed on the Posts screen
@@ -705,7 +722,6 @@ function wp_check_locked_posts( $response, $data, $screen_id ) {
 
        return $response;
 }
 
        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
 
 /**
  * Check lock status on the New/Edit Post screen and refresh the lock
@@ -744,7 +760,6 @@ function wp_refresh_post_lock( $response, $data, $screen_id ) {
 
        return $response;
 }
 
        return $response;
 }
-add_filter( 'heartbeat_received', 'wp_refresh_post_lock', 10, 3 );
 
 /**
  * Check nonce expiration on the New/Edit Post screen and refresh if needed
 
 /**
  * Check nonce expiration on the New/Edit Post screen and refresh if needed
@@ -756,35 +771,36 @@ function wp_refresh_post_nonces( $response, $data, $screen_id ) {
                $received = $data['wp-refresh-post-nonces'];
                $response['wp-refresh-post-nonces'] = array( 'check' => 1 );
 
                $received = $data['wp-refresh-post-nonces'];
                $response['wp-refresh-post-nonces'] = array( 'check' => 1 );
 
-               if ( ! $post_id = absint( $received['post_id'] ) )
+               if ( ! $post_id = absint( $received['post_id'] ) ) {
                        return $response;
                        return $response;
+               }
 
 
-               if ( ! current_user_can( 'edit_post', $post_id ) || empty( $received['post_nonce'] ) )
+               if ( ! current_user_can( 'edit_post', $post_id ) ) {
                        return $response;
                        return $response;
-
-               if ( 2 === wp_verify_nonce( $received['post_nonce'], 'update-post_' . $post_id ) ) {
-                       $response['wp-refresh-post-nonces'] = array(
-                               'replace' => array(
-                                       'getpermalinknonce' => wp_create_nonce('getpermalink'),
-                                       'samplepermalinknonce' => wp_create_nonce('samplepermalink'),
-                                       'closedpostboxesnonce' => wp_create_nonce('closedpostboxes'),
-                                       '_ajax_linking_nonce' => wp_create_nonce( 'internal-linking' ),
-                                       '_wpnonce' => wp_create_nonce( 'update-post_' . $post_id ),
-                               ),
-                               'heartbeatNonce' => wp_create_nonce( 'heartbeat-nonce' ),
-                       );
                }
                }
+
+               $response['wp-refresh-post-nonces'] = array(
+                       'replace' => array(
+                               'getpermalinknonce' => wp_create_nonce('getpermalink'),
+                               'samplepermalinknonce' => wp_create_nonce('samplepermalink'),
+                               'closedpostboxesnonce' => wp_create_nonce('closedpostboxes'),
+                               '_ajax_linking_nonce' => wp_create_nonce( 'internal-linking' ),
+                               '_wpnonce' => wp_create_nonce( 'update-post_' . $post_id ),
+                       ),
+                       'heartbeatNonce' => wp_create_nonce( 'heartbeat-nonce' ),
+               );
        }
 
        return $response;
 }
        }
 
        return $response;
 }
-add_filter( 'heartbeat_received', 'wp_refresh_post_nonces', 10, 3 );
 
 /**
  * Disable suspension of Heartbeat on the Add/Edit Post screens.
  *
  * @since 3.8.0
  *
 
 /**
  * Disable suspension of Heartbeat on the Add/Edit Post screens.
  *
  * @since 3.8.0
  *
+ * @global string $pagenow
+ *
  * @param array $settings An array of Heartbeat settings.
  * @return array Filtered Heartbeat settings.
  */
  * @param array $settings An array of Heartbeat settings.
  * @return array Filtered Heartbeat settings.
  */
@@ -797,12 +813,11 @@ function wp_heartbeat_set_suspension( $settings ) {
 
        return $settings;
 }
 
        return $settings;
 }
-add_filter( 'heartbeat_settings', 'wp_heartbeat_set_suspension' );
 
 /**
  * Autosave with heartbeat
  *
 
 /**
  * Autosave with heartbeat
  *
- * @since 3.9
+ * @since 3.9.0
  */
 function heartbeat_autosave( $response, $data ) {
        if ( ! empty( $data['wp_autosave'] ) ) {
  */
 function heartbeat_autosave( $response, $data ) {
        if ( ! empty( $data['wp_autosave'] ) ) {
@@ -822,5 +837,65 @@ function heartbeat_autosave( $response, $data ) {
 
        return $response;
 }
 
        return $response;
 }
-// Run later as we have to set DOING_AUTOSAVE for back-compat
-add_filter( 'heartbeat_received', 'heartbeat_autosave', 500, 2 );
+
+/**
+ * Disables autocomplete on the 'post' form (Add/Edit Post screens) for WebKit browsers,
+ * as they disregard the autocomplete setting on the editor textarea. That can break the editor
+ * when the user navigates to it with the browser's Back button. See #28037
+ *
+ * @since 4.0
+ *
+ * @global bool $is_safari
+ * @global bool $is_chrome
+ */
+function post_form_autocomplete_off() {
+       global $is_safari, $is_chrome;
+
+       if ( $is_safari || $is_chrome ) {
+               echo ' autocomplete="off"';
+       }
+}
+
+/**
+ * Remove single-use URL parameters and create canonical link based on new URL.
+ *
+ * Remove specific query string parameters from a URL, create the canonical link,
+ * put it in the admin header, and change the current URL to match.
+ *
+ * @since 4.2.0
+ */
+function wp_admin_canonical_url() {
+       $removable_query_args = array(
+               'message', 'settings-updated', 'saved',
+               'update', 'updated', 'activated',
+               'activate', 'deactivate', 'locked',
+               'deleted', 'trashed', 'untrashed',
+               'enabled', 'disabled', 'skipped',
+               'spammed', 'unspammed',
+       );
+
+       /**
+        * Filter the list of URL parameters to remove.
+        *
+        * @since 4.2.0
+        *
+        * @param array $removable_query_args An array of parameters to remove from the URL.
+        */
+       $removable_query_args = apply_filters( 'removable_query_args', $removable_query_args );
+
+       if ( empty( $removable_query_args ) ) {
+               return;
+       }
+
+       // Ensure we're using an absolute URL.
+       $current_url  = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
+       $filtered_url = remove_query_arg( $removable_query_args, $current_url );
+       ?>
+       <link id="wp-admin-canonical" rel="canonical" href="<?php echo esc_url( $filtered_url ); ?>" />
+       <script>
+               if ( window.history.replaceState ) {
+                       window.history.replaceState( null, null, document.getElementById( 'wp-admin-canonical' ).href + window.location.hash );
+               }
+       </script>
+<?php
+}