]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-admin/includes/misc.php
WordPress 4.1.2-scripts
[autoinstalls/wordpress.git] / wp-admin / includes / misc.php
index 5a3b9706c78dfa08fa52db613155255321bd5583..7b710cb047168c1a9a841702c87394ec8135410b 100644 (file)
@@ -22,12 +22,13 @@ 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.
         */
         * @param bool $got_rewrite Whether Apache and mod_rewrite are present.
         */
-       return apply_filters('got_rewrite', $got_rewrite);
+       return apply_filters( 'got_rewrite', $got_rewrite );
 }
 
 /**
 }
 
 /**
@@ -46,6 +47,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 +58,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 +94,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 ) {
@@ -161,8 +163,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() );
@@ -207,7 +211,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' );
@@ -247,7 +251,7 @@ 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
  *
- * @since 1.2.1
+ * @since 1.2.0
  *
  * @param string $url
  * @return string
  *
  * @param string $url
  * @return string
@@ -272,17 +276,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 +294,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) ){
@@ -314,11 +316,15 @@ function wp_doc_link_parse( $content ) {
                return array();
 
        $tokens = token_get_all( $content );
                return array();
 
        $tokens = token_get_all( $content );
+       $count = count( $tokens );
        $functions = array();
        $ignore_functions = array();
        $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 ] ) ) {
+       for ( $t = 0; $t < $count - 2; $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];
                        // 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];
@@ -330,7 +336,16 @@ function wp_doc_link_parse( $content ) {
 
        $functions = array_unique( $functions );
        sort( $functions );
 
        $functions = array_unique( $functions );
        sort( $functions );
+
+       /**
+        * Filter the list of functions and classes to be ignored from the documentation lookup.
+        *
+        * @since 2.8.0
+        *
+        * @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 );
+
        $ignore_functions = array_unique( $ignore_functions );
 
        $out = array();
        $ignore_functions = array_unique( $ignore_functions );
 
        $out = array();
@@ -346,8 +361,8 @@ function wp_doc_link_parse( $content ) {
 /**
  * Saves option for number of rows when listing posts, pages, comments, etc.
  *
 /**
  * Saves option for number of rows when listing posts, pages, comments, etc.
  *
- * @since 2.8
-**/
+ * @since 2.8.0
+ */
 function set_screen_options() {
 
        if ( isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options']) ) {
 function set_screen_options() {
 
        if ( isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options']) ) {
@@ -390,7 +405,25 @@ function set_screen_options() {
                                        return;
                                break;
                        default:
                                        return;
                                break;
                        default:
-                               $value = apply_filters('set-screen-option', false, $option, $value);
+
+                               /**
+                                * Filter a screen option value before it is set.
+                                *
+                                * The filter can also be used to modify non-standard [items]_per_page
+                                * settings. See the parent function for a full list of standard options.
+                                *
+                                * Returning false to the filter will skip saving the current option.
+                                *
+                                * @since 2.8.0
+                                *
+                                * @see set_screen_options()
+                                *
+                                * @param bool|int $value  Screen option value. Default false to skip.
+                                * @param string   $option The option name.
+                                * @param int      $value  The number of rows to use.
+                                */
+                               $value = apply_filters( 'set-screen-option', false, $option, $value );
+
                                if ( false === $value )
                                        return;
                                break;
                                if ( false === $value )
                                        return;
                                break;
@@ -561,29 +594,80 @@ function saveDomDocument($doc, $filename) {
  *
  * @since 3.0.0
  */
  *
  * @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 ); ?>">&nbsp;</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 admin_color_scheme_picker( $user_id ) {
+       global $_wp_admin_css_colors;
+
+       ksort( $_wp_admin_css_colors );
+
+       if ( isset( $_wp_admin_css_colors['fresh'] ) ) {
+               // Set Default ('fresh') and Light should go first.
+               $_wp_admin_css_colors = array_filter( array_merge( array( 'fresh' => '', 'light' => '' ), $_wp_admin_css_colors ) );
+       }
+
+       $current_color = get_user_option( 'admin_color', $user_id );
+
+       if ( empty( $current_color ) || ! isset( $_wp_admin_css_colors[ $current_color ] ) ) {
+               $current_color = 'fresh';
+       }
+
+       ?>
+       <fieldset id="color-picker" class="scheme-list">
+               <legend class="screen-reader-text"><span><?php _e( 'Admin Color Scheme' ); ?></span></legend>
+               <?php
+               wp_nonce_field( 'save-color-scheme', 'color-nonce', false );
+               foreach ( $_wp_admin_css_colors as $color => $color_info ) :
+
+                       ?>
+                       <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( 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>
+                                       <?php
+
+                                       foreach ( $color_info->colors as $html_color ) {
+                                               ?>
+                                               <td style="background-color: <?php echo esc_attr( $html_color ); ?>">&nbsp;</td>
+                                               <?php
+                                       }
+
+                                       ?>
+                                       </tr>
+                               </table>
+                       </div>
+                       <?php
+
+               endforeach;
+
+       ?>
+       </fieldset>
+       <?php
+}
+
+function wp_color_scheme_settings() {
+       global $_wp_admin_css_colors;
+
+       $color_scheme = get_user_option( 'admin_color' );
+
+       // It's possible to have a color scheme set that is no longer registered.
+       if ( empty( $_wp_admin_css_colors[ $color_scheme ] ) ) {
+               $color_scheme = 'fresh';
+       }
+
+       if ( ! empty( $_wp_admin_css_colors[ $color_scheme ]->icon_colors ) ) {
+               $icon_colors = $_wp_admin_css_colors[ $color_scheme ]->icon_colors;
+       } elseif ( ! empty( $_wp_admin_css_colors['fresh']->icon_colors ) ) {
+               $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' );
+       }
+
+       echo '<script type="text/javascript">var _wpColorScheme = ' . wp_json_encode( array( 'icons' => $icon_colors ) ) . ";</script>\n";
 }
 }
+add_action( 'admin_head', 'wp_color_scheme_settings' );
 
 function _ipad_meta() {
        if ( wp_is_mobile() ) {
 
 function _ipad_meta() {
        if ( wp_is_mobile() ) {
@@ -597,7 +681,7 @@ 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
  *
- * @since 3.6
+ * @since 3.6.0
  */
 function wp_check_locked_posts( $response, $data, $screen_id ) {
        $checked = array();
  */
 function wp_check_locked_posts( $response, $data, $screen_id ) {
        $checked = array();
@@ -628,7 +712,7 @@ 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
  *
- * @since 3.6
+ * @since 3.6.0
  */
 function wp_refresh_post_lock( $response, $data, $screen_id ) {
        if ( array_key_exists( 'wp-refresh-post-lock', $data ) ) {
  */
 function wp_refresh_post_lock( $response, $data, $screen_id ) {
        if ( array_key_exists( 'wp-refresh-post-lock', $data ) ) {
@@ -667,7 +751,7 @@ 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
  *
- * @since 3.6
+ * @since 3.6.0
  */
 function wp_refresh_post_nonces( $response, $data, $screen_id ) {
        if ( array_key_exists( 'wp-refresh-post-nonces', $data ) ) {
  */
 function wp_refresh_post_nonces( $response, $data, $screen_id ) {
        if ( array_key_exists( 'wp-refresh-post-nonces', $data ) ) {
@@ -683,7 +767,6 @@ function wp_refresh_post_nonces( $response, $data, $screen_id ) {
                if ( 2 === wp_verify_nonce( $received['post_nonce'], 'update-post_' . $post_id ) ) {
                        $response['wp-refresh-post-nonces'] = array(
                                'replace' => array(
                if ( 2 === wp_verify_nonce( $received['post_nonce'], 'update-post_' . $post_id ) ) {
                        $response['wp-refresh-post-nonces'] = array(
                                'replace' => array(
-                                       'autosavenonce' => wp_create_nonce('autosave'),
                                        'getpermalinknonce' => wp_create_nonce('getpermalink'),
                                        'samplepermalinknonce' => wp_create_nonce('samplepermalink'),
                                        'closedpostboxesnonce' => wp_create_nonce('closedpostboxes'),
                                        'getpermalinknonce' => wp_create_nonce('getpermalink'),
                                        'samplepermalinknonce' => wp_create_nonce('samplepermalink'),
                                        'closedpostboxesnonce' => wp_create_nonce('closedpostboxes'),
@@ -698,3 +781,65 @@ function wp_refresh_post_nonces( $response, $data, $screen_id ) {
        return $response;
 }
 add_filter( 'heartbeat_received', 'wp_refresh_post_nonces', 10, 3 );
        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
+ *
+ * @param array $settings An array of Heartbeat settings.
+ * @return array Filtered Heartbeat settings.
+ */
+function wp_heartbeat_set_suspension( $settings ) {
+       global $pagenow;
+
+       if ( 'post.php' === $pagenow || 'post-new.php' === $pagenow ) {
+               $settings['suspension'] = 'disable';
+       }
+
+       return $settings;
+}
+add_filter( 'heartbeat_settings', 'wp_heartbeat_set_suspension' );
+
+/**
+ * Autosave with heartbeat
+ *
+ * @since 3.9.0
+ */
+function heartbeat_autosave( $response, $data ) {
+       if ( ! empty( $data['wp_autosave'] ) ) {
+               $saved = wp_autosave( $data['wp_autosave'] );
+
+               if ( is_wp_error( $saved ) ) {
+                       $response['wp_autosave'] = array( 'success' => false, 'message' => $saved->get_error_message() );
+               } elseif ( empty( $saved ) ) {
+                       $response['wp_autosave'] = array( 'success' => false, 'message' => __( 'Error while saving.' ) );
+               } else {
+                       /* translators: draft saved date format, see http://php.net/date */
+                       $draft_saved_date_format = __( 'g:i:s a' );
+                       /* translators: %s: date and time */
+                       $response['wp_autosave'] = array( 'success' => true, 'message' => sprintf( __( 'Draft saved at %s.' ), date_i18n( $draft_saved_date_format ) ) );
+               }
+       }
+
+       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
+ */
+function post_form_autocomplete_off() {
+       global $is_safari, $is_chrome;
+
+       if ( $is_safari || $is_chrome ) {
+               echo ' autocomplete="off"';
+       }
+}
+
+add_action( 'post_edit_form_tag', 'post_form_autocomplete_off' );