* 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()
*
- * @since 2.5.0
* @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 );
}
/**
*
* @since 3.7.0
*
+ * @global bool $is_nginx
+ *
* @return bool Whether the server supports URL rewriting.
*/
function got_url_rewrite() {
* 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 );
}
/**
- * {@internal Missing Short Description}}
+ * Extracts strings from between the BEGIN and END markers in the .htaccess file.
*
* @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 ) {
}
/**
- * {@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
+ * 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
+ * @param string $filename Filename to alter.
+ * @param string $marker The marker to alter.
+ * @param array|string $insertion The new content to insert.
* @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 ( ! file_exists( $filename ) ) {
+ if ( ! is_writable( dirname( $filename ) ) ) {
+ return false;
}
-
- if ( !$f = @fopen( $filename, 'w' ) )
+ if ( ! touch( $filename ) ) {
return false;
+ }
+ } elseif ( ! is_writeable( $filename ) ) {
+ 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 ( ! is_array( $insertion ) ) {
+ $insertion = explode( "\n", $insertion );
+ }
+
+ $start_marker = "# BEGIN {$marker}";
+ $end_marker = "# END {$marker}";
+
+ $fp = fopen( $filename, 'r+' );
+ if ( ! $fp ) {
+ return false;
+ }
+
+ // Attempt to get a lock. If the filesystem supports locking, this will block until the lock is acquired.
+ flock( $fp, LOCK_EX );
+
+ $lines = array();
+ while ( ! feof( $fp ) ) {
+ $lines[] = rtrim( fgets( $fp ), "\r\n" );
+ }
+
+ // Split out the existing file into the preceeding lines, and those that appear after the marker
+ $pre_lines = $post_lines = $existing_lines = array();
+ $found_marker = $found_end_marker = false;
+ foreach ( $lines as $line ) {
+ if ( ! $found_marker && false !== strpos( $line, $start_marker ) ) {
+ $found_marker = true;
+ continue;
+ } elseif ( ! $found_end_marker && false !== strpos( $line, $end_marker ) ) {
+ $found_end_marker = true;
+ continue;
}
- if (!$foundit) {
- fwrite( $f, "\n# BEGIN {$marker}\n" );
- foreach ( $insertion as $insertline )
- fwrite( $f, "{$insertline}\n" );
- fwrite( $f, "# END {$marker}\n" );
+ if ( ! $found_marker ) {
+ $pre_lines[] = $line;
+ } elseif ( $found_marker && $found_end_marker ) {
+ $post_lines[] = $line;
+ } else {
+ $existing_lines[] = $line;
}
- fclose( $f );
+ }
+
+ // Check to see if there was a change
+ if ( $existing_lines === $insertion ) {
+ flock( $fp, LOCK_UN );
+ fclose( $fp );
+
return true;
- } else {
- return false;
}
+
+ // Generate the new file data
+ $new_file_data = implode( "\n", array_merge(
+ $pre_lines,
+ array( $start_marker ),
+ $insertion,
+ array( $end_marker ),
+ $post_lines
+ ) );
+
+ // Write to the start of the file, and truncate it to that length
+ fseek( $fp, 0 );
+ $bytes = fwrite( $fp, $new_file_data );
+ if ( $bytes ) {
+ ftruncate( $fp, ftell( $fp ) );
+ }
+ fflush( $fp );
+ flock( $fp, LOCK_UN );
+ fclose( $fp );
+
+ return (bool) $bytes;
}
/**
* blank out old rules.
*
* @since 1.5.0
+ *
+ * @global WP_Rewrite $wp_rewrite
*/
function save_mod_rewrite_rules() {
if ( is_multisite() )
$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() );
*
* @since 2.8.0
*
+ * @global WP_Rewrite $wp_rewrite
+ *
* @return bool True if web.config was updated successfully
*/
function iis7_save_url_rewrite_rules(){
}
/**
- * {@internal Missing Short Description}}
+ * Update the "recently-edited" file for the plugin or theme editor.
*
* @since 1.5.0
*
- * @param unknown_type $file
+ * @param string $file
*/
function update_recently_edited( $file ) {
$oldfiles = (array ) get_option( 'recently_edited' );
}
/**
- * If siteurl, home or page_on_front changed, flush rewrite rules.
+ * Flushes rewrite rules if siteurl, home or page_on_front changed.
*
* @since 2.1.0
*
* @param string $value
*/
function update_home_siteurl( $old_value, $value ) {
- if ( defined( "WP_INSTALLING" ) )
+ if ( wp_installing() )
return;
- // If home changed, write rewrite rules to new location.
- flush_rewrite_rules();
+ if ( is_multisite() && ms_is_switched() ) {
+ delete_option( 'rewrite_rules' );
+ } else {
+ 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.0
- *
- * @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
* @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 {
- $$var = $_POST[$var];
+ $GLOBALS[ $var ] = $_POST[ $var ];
}
}
}
/**
- * {@internal Missing Short Description}}
+ * Displays the given administration message.
*
* @since 2.1.0
*
- * @param unknown_type $message
+ * @param string|WP_Error $message
*/
function show_message($message) {
if ( is_wp_error($message) ){
flush();
}
+/**
+ * @since 2.8.0
+ *
+ * @param string $content
+ * @return array
+ */
function wp_doc_link_parse( $content ) {
if ( !is_string( $content ) || empty( $content ) )
return array();
return array();
$tokens = token_get_all( $content );
+ $count = count( $tokens );
$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];
$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 = array_unique( $ignore_functions );
$out = array();
/**
* 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']) ) {
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;
}
update_user_meta($user->ID, $option, $value);
- wp_safe_redirect( remove_query_arg( array('pagenum', 'apage', 'paged'), wp_get_referer() ) );
+
+ $url = remove_query_arg( array( 'pagenum', 'apage', 'paged' ), wp_get_referer() );
+ if ( isset( $_POST['mode'] ) ) {
+ $url = add_query_arg( array( 'mode' => $_POST['mode'] ), $url );
+ }
+
+ wp_safe_redirect( $url );
exit;
}
}
function iis7_rewrite_rule_exists($filename) {
if ( ! file_exists($filename) )
return false;
- if ( ! class_exists('DOMDocument') )
+ if ( ! class_exists( 'DOMDocument', false ) ) {
return false;
+ }
$doc = new DOMDocument();
if ( $doc->load($filename) === false )
if ( ! file_exists($filename) )
return true;
- if ( ! class_exists('DOMDocument') )
+ if ( ! class_exists( 'DOMDocument', false ) ) {
return false;
+ }
$doc = new DOMDocument();
$doc->preserveWhiteSpace = false;
* @return bool
*/
function iis7_add_rewrite_rule($filename, $rewrite_rule) {
- if ( ! class_exists('DOMDocument') )
+ if ( ! class_exists( 'DOMDocument', false ) ) {
return false;
+ }
// If configuration file does not exist then we create one.
if ( ! file_exists($filename) ) {
* 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;
<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>
<?php
}
+/**
+ *
+ * @global array $_wp_admin_css_colors
+ */
function wp_color_scheme_settings() {
global $_wp_admin_css_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' );
+ $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() ) {
?>
<?php
}
}
-add_action('admin_head', '_ipad_meta');
/**
* 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();
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
+ * @since 3.6.0
*/
function wp_refresh_post_lock( $response, $data, $screen_id ) {
if ( array_key_exists( 'wp-refresh-post-lock', $data ) ) {
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
*
- * @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 ) ) {
$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;
+ }
- if ( ! current_user_can( 'edit_post', $post_id ) || empty( $received['post_nonce'] ) )
+ if ( ! current_user_can( 'edit_post', $post_id ) ) {
return $response;
-
- 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'),
- '_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;
}
-add_filter( 'heartbeat_received', 'wp_refresh_post_nonces', 10, 3 );
/**
* 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.
*/
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;
+}
+
+/**
+ * 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.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 = wp_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
+}