enmi-conf.org: comparison wp/wp-includes/functions.php

equal deleted inserted replaced

-:346c88efed21
+:5e2f62d02dcd
 */
 require( ABSPATH . WPINC . '/option.php' );
 /**
-* Converts given date string into a different format.
+* Convert given date string into a different format.
 *
 * $format should be either a PHP date format string, e.g. 'U' for a Unix
 * timestamp, or 'G' for a Unix timestamp assuming that $date is GMT.
 *
 * If $translate is true then the given date and format string will
 * be passed to date_i18n() for translation.
 *
 * @since 0.71
 *
-* @param string $format Format of the date to return.
+* @param string $format    Format of the date to return.
-* @param string $date Date string to convert.
+* @param string $date      Date string to convert.
-* @param bool $translate Whether the return date should be translated. Default is true.
+* @param bool   $translate Whether the return date should be translated. Default true.
-* @return string|int Formatted date string, or Unix timestamp.
+* @return string|int|bool Formatted date string or Unix timestamp. False if $date is empty.
 */
 function mysql2date( $format, $date, $translate = true ) {
 	if ( empty( $date ) )
 		return false;
 /**
 * Retrieve the current time based on specified type.
 *
 * The 'mysql' type will return the time in the format for MySQL DATETIME field.
 * The 'timestamp' type will return the current timestamp.
+* Other strings will be interpreted as PHP date formats (e.g. 'Y-m-d').
 *
 * If $gmt is set to either '1' or 'true', then both types will use GMT time.
 * if $gmt is false, the output is adjusted with the GMT offset in the WordPress option.
 *
 * @since 1.0.0
 *
-* @param string $type Either 'mysql' or 'timestamp'.
+* @param string   $type Type of time to retrieve. Accepts 'mysql', 'timestamp', or PHP date
-* @param int|bool $gmt Optional. Whether to use GMT timezone. Default is false.
+*                       format string (e.g. 'Y-m-d').
-* @return int|string String if $type is 'gmt', int if $type is 'timestamp'.
+* @param int|bool $gmt  Optional. Whether to use GMT timezone. Default false.
+* @return int|string Integer if $type is 'timestamp', string otherwise.
 */
 function current_time( $type, $gmt = 0 ) {
 	switch ( $type ) {
 		case 'mysql':
 			return ( $gmt ) ? gmdate( 'Y-m-d H:i:s' ) : gmdate( 'Y-m-d H:i:s', ( time() + ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ) ) );
-			break;
 		case 'timestamp':
 			return ( $gmt ) ? time() : time() + ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
-			break;
+		default:
+			return ( $gmt ) ? date( $type ) : date( $type, time() + ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ) );
 	}
 }
 /**
 * Retrieve the date in localized format, based on timestamp.
 * take over the format for the date. If it isn't, then the date format string
 * will be used instead.
 *
 * @since 0.71
 *
-* @param string $dateformatstring Format to display the date.
+* @param string   $dateformatstring Format to display the date.
-* @param int $unixtimestamp Optional. Unix timestamp.
+* @param bool|int $unixtimestamp    Optional. Unix timestamp. Default false.
-* @param bool $gmt Optional, default is false. Whether to convert to GMT for time.
+* @param bool     $gmt              Optional. Whether to use GMT timezone. Default false.
+*
 * @return string The date, translated if locale specifies it.
 */
 function date_i18n( $dateformatstring, $unixtimestamp = false, $gmt = false ) {
 	global $wp_locale;
 	$i = $unixtimestamp;
 		// we should not let date() interfere with our
 		// specially computed timestamp
 		$gmt = true;
 	}
-	// store original value for language with untypical grammars
+	/*
-	// see http://core.trac.wordpress.org/ticket/9396
+	 * Store original value for language with untypical grammars.
+	 * See https://core.trac.wordpress.org/ticket/9396
+	 */
 	$req_format = $dateformatstring;
 	$datefunc = $gmt? 'gmdate' : 'date';
 	if ( ( !empty( $wp_locale->month ) ) && ( !empty( $wp_locale->weekday ) ) ) {
 				}
 			}
 		}
 	}
 	$j = @$datefunc( $dateformatstring, $i );
-	// allow plugins to redo this entirely for languages with untypical grammars
-	$j = apply_filters('date_i18n', $j, $req_format, $i, $gmt);
+	/**
+	 * Filter the date formatted based on the locale.
+	 *
+	 * @since 2.8.0
+	 *
+	 * @param string $j          Formatted date string.
+	 * @param string $req_format Format to display the date.
+	 * @param int    $i          Unix timestamp.
+	 * @param bool   $gmt        Whether to convert to GMT for time. Default false.
+	 */
+	$j = apply_filters( 'date_i18n', $j, $req_format, $i, $gmt );
 	return $j;
 }
 /**
 * Convert integer number to format based on the locale.
 *
 * @since 2.3.0
 *
-* @param int $number The number to convert based on locale.
+* @param int $number   The number to convert based on locale.
-* @param int $decimals Precision of the number of decimal places.
+* @param int $decimals Optional. Precision of the number of decimal places. Default 0.
 * @return string Converted number in string format.
 */
 function number_format_i18n( $number, $decimals = 0 ) {
 	global $wp_locale;
 	$formatted = number_format( $number, absint( $decimals ), $wp_locale->number_format['decimal_point'], $wp_locale->number_format['thousands_sep'] );
+	/**
+	 * Filter the number formatted based on the locale.
+	 *
+	 * @since  2.8.0
+	 *
+	 * @param string $formatted Converted number in string format.
+	 */
 	return apply_filters( 'number_format_i18n', $formatted );
 }
 /**
 * Convert number of bytes largest unit bytes will fit into.
 *
-* It is easier to read 1kB than 1024 bytes and 1MB than 1048576 bytes. Converts
+* It is easier to read 1 kB than 1024 bytes and 1 MB than 1048576 bytes. Converts
 * number of bytes to human readable number by taking the number of that unit
 * that the bytes will go into it. Supports TB value.
 *
 * Please note that integers in PHP are limited to 32 bits, unless they are on
 * 64 bit architecture, then they have 64 bit size. If you need to place the
 * larger size then what PHP integer type will hold, then use a string. It will
 * be converted to a double, which should always have 64 bit length.
 *
 * Technically the correct unit names for powers of 1024 are KiB, MiB etc.
-* @link http://en.wikipedia.org/wiki/Byte
 *
 * @since 2.3.0
 *
-* @param int|string $bytes Number of bytes. Note max integer size for integers.
+* @param int|string $bytes    Number of bytes. Note max integer size for integers.
-* @param int $decimals Precision of number of decimal places. Deprecated.
+* @param int        $decimals Optional. Precision of number of decimal places. Default 0.
-* @return bool|string False on failure. Number string on success.
+* @return string|false False on failure. Number string on success.
 */
 function size_format( $bytes, $decimals = 0 ) {
 	$quant = array(
 		// ========================= Origin ====
 		'TB' => 1099511627776,  // pow( 1024, 4)
 		'GB' => 1073741824,     // pow( 1024, 3)
 		'MB' => 1048576,        // pow( 1024, 2)
 		'kB' => 1024,           // pow( 1024, 1)
-		'B ' => 1,              // pow( 1024, 0)
+		'B'  => 1,              // pow( 1024, 0)
 	);
-	foreach ( $quant as $unit => $mag )
-		if ( doubleval($bytes) >= $mag )
+	foreach ( $quant as $unit => $mag ) {
+		if ( doubleval( $bytes ) >= $mag ) {
 			return number_format_i18n( $bytes / $mag, $decimals ) . ' ' . $unit;
+		}
+	}
 	return false;
 }
 /**
-* Get the week start and end from the datetime or date string from mysql.
+* Get the week start and end from the datetime or date string from MySQL.
 *
 * @since 0.71
 *
-* @param string $mysqlstring Date or datetime field type from mysql.
+* @param string     $mysqlstring   Date or datetime field type from MySQL.
-* @param int $start_of_week Optional. Start of the week as an integer.
+* @param int|string $start_of_week Optional. Start of the week as an integer. Default empty string.
 * @return array Keys are 'start' and 'end'.
 */
 function get_weekstartend( $mysqlstring, $start_of_week = '' ) {
-	$my = substr( $mysqlstring, 0, 4 ); // Mysql string Year
+	// MySQL string year.
-	$mm = substr( $mysqlstring, 8, 2 ); // Mysql string Month
+	$my = substr( $mysqlstring, 0, 4 );
-	$md = substr( $mysqlstring, 5, 2 ); // Mysql string day
-	$day = mktime( 0, 0, 0, $md, $mm, $my ); // The timestamp for mysqlstring day.
+	// MySQL string month.
-	$weekday = date( 'w', $day ); // The day of the week from the timestamp
+	$mm = substr( $mysqlstring, 8, 2 );
+	// MySQL string day.
+	$md = substr( $mysqlstring, 5, 2 );
+	// The timestamp for MySQL string day.
+	$day = mktime( 0, 0, 0, $md, $mm, $my );
+	// The day of the week from the timestamp.
+	$weekday = date( 'w', $day );
 	if ( !is_numeric($start_of_week) )
 		$start_of_week = get_option( 'start_of_week' );
 	if ( $weekday < $start_of_week )
 		$weekday += 7;
-	$start = $day - DAY_IN_SECONDS * ( $weekday - $start_of_week ); // The most recent week start day on or before $day
+	// The most recent week start day on or before $day.
-	$end = $start + 7 * DAY_IN_SECONDS - 1; // $start + 7 days - 1 second
+	$start = $day - DAY_IN_SECONDS * ( $weekday - $start_of_week );
+	// $start + 7 days - 1 second.
+	$end = $start + 7 * DAY_IN_SECONDS - 1;
 	return compact( 'start', 'end' );
 }
 /**
 * Unserialize value only if it was serialized.
 * If $data is not an string, then returned value will always be false.
 * Serialized data is always a string.
 *
 * @since 2.0.5
 *
-* @param mixed $data Value to check to see if was serialized.
+* @param string $data   Value to check to see if was serialized.
-* @param bool $strict Optional. Whether to be strict about the end of the string. Defaults true.
+* @param bool   $strict Optional. Whether to be strict about the end of the string. Default true.
 * @return bool False if not serialized and true if it was.
 */
 function is_serialized( $data, $strict = true ) {
-	// if it isn't a string, it isn't serialized
+	// if it isn't a string, it isn't serialized.
-	if ( ! is_string( $data ) )
+	if ( ! is_string( $data ) ) {
 		return false;
+	}
 	$data = trim( $data );
-	if ( 'N;' == $data )
+	if ( 'N;' == $data ) {
 		return true;
-	$length = strlen( $data );
+	}
-	if ( $length < 4 )
+	if ( strlen( $data ) < 4 ) {
 		return false;
-	if ( ':' !== $data[1] )
+	}
+	if ( ':' !== $data[1] ) {
 		return false;
+	}
 	if ( $strict ) {
-		$lastc = $data[ $length - 1 ];
+		$lastc = substr( $data, -1 );
-		if ( ';' !== $lastc && '}' !== $lastc )
+		if ( ';' !== $lastc && '}' !== $lastc ) {
 			return false;
+		}
 	} else {
 		$semicolon = strpos( $data, ';' );
 		$brace     = strpos( $data, '}' );
 		// Either ; or } must exist.
 		if ( false === $semicolon && false === $brace )
 	}
 	$token = $data[0];
 	switch ( $token ) {
 		case 's' :
 			if ( $strict ) {
-				if ( '"' !== $data[ $length - 2 ] )
+				if ( '"' !== substr( $data, -2, 1 ) ) {
 					return false;
+				}
 			} elseif ( false === strpos( $data, '"' ) ) {
 				return false;
 			}
 			// or else fall through
 		case 'a' :
 /**
 * Check whether serialized data is of string type.
 *
 * @since 2.0.5
 *
-* @param mixed $data Serialized data
+* @param string $data Serialized data.
 * @return bool False if not a serialized string, true if it is.
 */
 function is_serialized_string( $data ) {
-	// if it isn't a string, it isn't a serialized string
+	// if it isn't a string, it isn't a serialized string.
-	if ( !is_string( $data ) )
+	if ( ! is_string( $data ) ) {
 		return false;
+	}
 	$data = trim( $data );
-	$length = strlen( $data );
+	if ( strlen( $data ) < 4 ) {
-	if ( $length < 4 )
 		return false;
-	elseif ( ':' !== $data[1] )
+	} elseif ( ':' !== $data[1] ) {
 		return false;
-	elseif ( ';' !== $data[$length-1] )
+	} elseif ( ';' !== substr( $data, -1 ) ) {
 		return false;
-	elseif ( $data[0] !== 's' )
+	} elseif ( $data[0] !== 's' ) {
 		return false;
-	elseif ( '"' !== $data[$length-2] )
+	} elseif ( '"' !== substr( $data, -2, 1 ) ) {
 		return false;
-	else
+	} else {
 		return true;
+	}
 }
 /**
 * Serialize data, if needed.
 *
 * @since 2.0.5
 *
-* @param mixed $data Data that might be serialized.
+* @param string|array|object $data Data that might be serialized.
 * @return mixed A scalar data
 */
 function maybe_serialize( $data ) {
 	if ( is_array( $data ) || is_object( $data ) )
 		return serialize( $data );
 	// Double serialization is required for backward compatibility.
-	// See http://core.trac.wordpress.org/ticket/12930
+	// See https://core.trac.wordpress.org/ticket/12930
 	if ( is_serialized( $data, false ) )
 		return serialize( $data );
 	return $data;
 }
 * Retrieve post title from XMLRPC XML.
 *
 * If the title element is not part of the XML, then the default post title from
 * the $post_default_title will be used instead.
 *
-* @package WordPress
-* @subpackage XMLRPC
 * @since 0.71
 *
-* @global string $post_default_title Default XMLRPC post title.
+* @global string $post_default_title Default XML-RPC post title.
 *
 * @param string $content XMLRPC XML Request content
 * @return string Post title
 */
 function xmlrpc_getposttitle( $content ) {
 *
 * If the category element is not found, then the default post category will be
 * used. The return type then would be what $post_default_category. If the
 * category is found, then it will always be an array.
 *
-* @package WordPress
-* @subpackage XMLRPC
 * @since 0.71
 *
-* @global string $post_default_category Default XMLRPC post category.
+* @global string $post_default_category Default XML-RPC post category.
 *
 * @param string $content XMLRPC XML Request content
 * @return string|array List of categories or category name.
 */
 function xmlrpc_getpostcategory( $content ) {
 }
 /**
 * XMLRPC XML content without title and category elements.
 *
-* @package WordPress
-* @subpackage XMLRPC
 * @since 0.71
 *
-* @param string $content XMLRPC XML Request content
+* @param string $content XML-RPC XML Request content.
 * @return string XMLRPC XML Request content without title and category elements.
 */
 function xmlrpc_removepostdata( $content ) {
 	$content = preg_replace( '/<title>(.+?)<\/title>/si', '', $content );
 	$content = preg_replace( '/<category>(.+?)<\/category>/si', '', $content );
 	$content = trim( $content );
 	return $content;
 }
 /**
-* Use RegEx to extract URLs from arbitrary content
+* Use RegEx to extract URLs from arbitrary content.
 *
 * @since 3.7.0
 *
-* @param string $content
+* @param string $content Content to extract URLs from.
-* @return array URLs found in passed string
+* @return array URLs found in passed string.
 */
 function wp_extract_urls( $content ) {
 	preg_match_all(
-		"#((?:[\w-]+://?|[\w\d]+[.])[^\s()<>]+[.](?:\([\w\d]+\)|(?:[^`!()\[\]{};:'\".,<>?«»“”‘’\s]|(?:[:]\d+)?/?)+))#",
+		"#([\"']?)("
+			. "(?:([\w-]+:)?//?)"
+			. "[^\s()<>]+"
+			. "[.]"
+			. "(?:"
+				. "\([\w\d]+\)|"
+				. "(?:"
+					. "[^`!()\[\]{};:'\".,<>«»“”‘’\s]|"
+					. "(?:[:]\d+)?/?"
+				. ")+"
+			. ")"
+		. ")\\1#",
 		$content,
 		$post_links
 	);
-	$post_links = array_unique( array_map( 'html_entity_decode', $post_links[0] ) );
+	$post_links = array_unique( array_map( 'html_entity_decode', $post_links[2] ) );
 	return array_values( $post_links );
 }
 /**
 *
 * Will not add enclosures that have already been added and will
 * remove enclosures that are no longer in the post. This is called as
 * pingbacks and trackbacks.
 *
-* @package WordPress
 * @since 1.5.0
 *
-* @uses $wpdb
+* @see $wpdb
 *
-* @param string $content Post Content
+* @param string $content Post Content.
-* @param int $post_ID Post ID
+* @param int $post_ID Post ID.
 */
 function do_enclose( $content, $post_ID ) {
 	global $wpdb;
 	//TODO: Tidy this ghetto code up and make the debug code optional
 	$post_links_temp = wp_extract_urls( $content );
 	foreach ( $pung as $link_test ) {
 		if ( ! in_array( $link_test, $post_links_temp ) ) { // link no longer in post
-			$mids = $wpdb->get_col( $wpdb->prepare("SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = 'enclosure' AND meta_value LIKE (%s)", $post_ID, like_escape( $link_test ) . '%') );
+			$mids = $wpdb->get_col( $wpdb->prepare("SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = 'enclosure' AND meta_value LIKE %s", $post_ID, $wpdb->esc_like( $link_test ) . '%') );
 			foreach ( $mids as $mid )
 				delete_metadata_by_mid( 'post', $mid );
 		}
 	}
 				$post_links[] = $link_test;
 		}
 	}
 	foreach ( (array) $post_links as $url ) {
-		if ( $url != '' && !$wpdb->get_var( $wpdb->prepare( "SELECT post_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = 'enclosure' AND meta_value LIKE (%s)", $post_ID, like_escape( $url ) . '%' ) ) ) {
+		if ( $url != '' && !$wpdb->get_var( $wpdb->prepare( "SELECT post_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = 'enclosure' AND meta_value LIKE %s", $post_ID, $wpdb->esc_like( $url ) . '%' ) ) ) {
 			if ( $headers = wp_get_http_headers( $url) ) {
 				$len = isset( $headers['content-length'] ) ? (int) $headers['content-length'] : 0;
 				$type = isset( $headers['content-type'] ) ? $headers['content-type'] : '';
 				$allowed_types = array( 'video', 'audio' );
 * If $file_path is a writable filename, this will do a GET request and write
 * the file to that path.
 *
 * @since 2.5.0
 *
-* @param string $url URL to fetch.
+* @param string      $url       URL to fetch.
-* @param string|bool $file_path Optional. File path to write request to.
+* @param string|bool $file_path Optional. File path to write request to. Default false.
-* @param int $red (private) The number of Redirects followed, Upon 5 being hit, returns false.
+* @param int         $red       Optional. The number of Redirects followed, Upon 5 being hit,
+*                               returns false. Default 1.
 * @return bool|string False on failure and string of headers if HEAD request.
 */
 function wp_get_http( $url, $file_path = false, $red = 1 ) {
 	@set_time_limit( 60 );
 /**
 * Retrieve HTTP Headers from URL.
 *
 * @since 1.5.1
 *
-* @param string $url
+* @param string $url        URL to retrieve HTTP headers from.
-* @param bool $deprecated Not Used.
+* @param bool   $deprecated Not Used.
 * @return bool|string False on failure, headers on success.
 */
 function wp_get_http_headers( $url, $deprecated = false ) {
 	if ( !empty( $deprecated ) )
 		_deprecated_argument( __FUNCTION__, '2.7' );
 	return wp_remote_retrieve_headers( $response );
 }
 /**
-* Whether today is a new day.
+* Whether the publish date of the current post in the loop is different from the
+* publish date of the previous post in the loop.
 *
 * @since 0.71
-* @uses $day Today
+*
-* @uses $previousday Previous day
+* @global string $currentday  The day of the current post in the loop.
+* @global string $previousday The day of the previous post in the loop.
 *
 * @return int 1 when new day, 0 if not a new day.
 */
 function is_new_day() {
 	global $currentday, $previousday;
 * Build URL query based on an associative and, or indexed array.
 *
 * This is a convenient function for easily building url queries. It sets the
 * separator to '&' and uses _http_build_query() function.
 *
+* @since 2.3.0
+*
 * @see _http_build_query() Used to build the query
-* @link http://us2.php.net/manual/en/function.http-build-query.php more on what
+* @see http://us2.php.net/manual/en/function.http-build-query.php for more on what
 *		http_build_query() does.
 *
-* @since 2.3.0
-*
 * @param array $data URL-encode key/value pairs.
-* @return string URL encoded string
+* @return string URL-encoded string.
 */
 function build_query( $data ) {
 	return _http_build_query( $data, null, '&', '', false );
 }
-// from php.net (modified by Mark Jaquith to behave like the native PHP5 function)
+/**
-function _http_build_query($data, $prefix=null, $sep=null, $key='', $urlencode=true) {
+* From php.net (modified by Mark Jaquith to behave like the native PHP5 function).
+*
+* @since 3.2.0
+* @access private
+*
+* @see http://us1.php.net/manual/en/function.http-build-query.php
+*
+* @param array|object  $data       An array or object of data. Converted to array.
+* @param string        $prefix     Optional. Numeric index. If set, start parameter numbering with it.
+*                                  Default null.
+* @param string        $sep        Optional. Argument separator; defaults to 'arg_separator.output'.
+*                                  Default null.
+* @param string        $key        Optional. Used to prefix key name. Default empty.
+* @param bool          $urlencode  Optional. Whether to use urlencode() in the result. Default true.
+*
+* @return string The query string.
+*/
+function _http_build_query( $data, $prefix = null, $sep = null, $key = '', $urlencode = true ) {
 	$ret = array();
 	foreach ( (array) $data as $k => $v ) {
 		if ( $urlencode)
 			$k = urlencode($k);
 			$k = $prefix.$k;
 		if ( !empty($key) )
 			$k = $key . '%5B' . $k . '%5D';
 		if ( $v === null )
 			continue;
-		elseif ( $v === FALSE )
+		elseif ( $v === false )
 			$v = '0';
 		if ( is_array($v) || is_object($v) )
 			array_push($ret,_http_build_query($v, '', $sep, $k, $urlencode));
 		elseif ( $urlencode )
 * value. Additional values provided are expected to be encoded appropriately
 * with urlencode() or rawurlencode().
 *
 * @since 1.5.0
 *
-* @param mixed $param1 Either newkey or an associative_array
+* @param string|array $param1 Either newkey or an associative_array.
-* @param mixed $param2 Either newvalue or oldquery or uri
+* @param string       $param2 Either newvalue or oldquery or URI.
-* @param mixed $param3 Optional. Old query or uri
+* @param string       $param3 Optional. Old query or URI.
 * @return string New URL query string.
 */
 function add_query_arg() {
-	$ret = '';
 	$args = func_get_args();
 	if ( is_array( $args[0] ) ) {
 		if ( count( $args ) < 2 || false === $args[1] )
 			$uri = $_SERVER['REQUEST_URI'];
 		else
 	}
 	wp_parse_str( $query, $qs );
 	$qs = urlencode_deep( $qs ); // this re-URL-encodes things that were already in the query string
 	if ( is_array( $args[0] ) ) {
-		$kayvees = $args[0];
+		foreach ( $args[0] as $k => $v ) {
-		$qs = array_merge( $qs, $kayvees );
+			$qs[ $k ] = $v;
+		}
 	} else {
 		$qs[ $args[0] ] = $args[1];
 	}
 	foreach ( $qs as $k => $v ) {
 /**
 * Removes an item or list from the query string.
 *
 * @since 1.5.0
 *
-* @param string|array $key Query key or keys to remove.
+* @param string|array $key   Query key or keys to remove.
-* @param bool $query When false uses the $_SERVER value.
+* @param bool|string  $query Optional. When false uses the $_SERVER value. Default false.
 * @return string New URL query string.
 */
-function remove_query_arg( $key, $query=false ) {
+function remove_query_arg( $key, $query = false ) {
 	if ( is_array( $key ) ) { // removing multiple keys
 		foreach ( $key as $k )
 			$query = add_query_arg( $k, false, $query );
 		return $query;
 	}
 /**
 * HTTP request for URI to retrieve content.
 *
 * @since 1.5.1
-* @uses wp_remote_get()
+*
+* @see wp_safe_remote_get()
 *
 * @param string $uri URI/URL of web page to retrieve.
-* @return bool|string HTTP content. False on failure.
+* @return false|string HTTP content. False on failure.
 */
 function wp_remote_fopen( $uri ) {
 	$parsed_url = @parse_url( $uri );
 	if ( !$parsed_url || !is_array( $parsed_url ) )
 /**
 * Set up the WordPress query.
 *
 * @since 2.0.0
 *
-* @param string $query_vars Default WP_Query arguments.
+* @param string|array $query_vars Default WP_Query arguments.
 */
 function wp( $query_vars = '' ) {
 	global $wp, $wp_query, $wp_the_query;
 	$wp->main( $query_vars );
 			413 => 'Request Entity Too Large',
 			414 => 'Request-URI Too Long',
 			415 => 'Unsupported Media Type',
 			416 => 'Requested Range Not Satisfiable',
 			417 => 'Expectation Failed',
+			418 => 'I\'m a teapot',
 			422 => 'Unprocessable Entity',
 			423 => 'Locked',
 			424 => 'Failed Dependency',
 			426 => 'Upgrade Required',
+			428 => 'Precondition Required',
+			429 => 'Too Many Requests',
+			431 => 'Request Header Fields Too Large',
 			500 => 'Internal Server Error',
 			501 => 'Not Implemented',
 			502 => 'Bad Gateway',
 			503 => 'Service Unavailable',
 			504 => 'Gateway Timeout',
 			505 => 'HTTP Version Not Supported',
 			506 => 'Variant Also Negotiates',
 			507 => 'Insufficient Storage',
-			510 => 'Not Extended'
+			510 => 'Not Extended',
+			511 => 'Network Authentication Required',
 		);
 	}
 	if ( isset( $wp_header_to_desc[$code] ) )
 		return $wp_header_to_desc[$code];
 /**
 * Set HTTP status header.
 *
 * @since 2.0.0
-* @uses apply_filters() Calls 'status_header' on status header string, HTTP
+*
-*		HTTP code, HTTP code description, and protocol string as separate
+* @see get_status_header_desc()
-*		parameters.
+*
-*
+* @param int $code HTTP status code.
-* @param int $header HTTP status code
+*/
-* @return unknown
+function status_header( $code ) {
-*/
+	$description = get_status_header_desc( $code );
-function status_header( $header ) {
-	$text = get_status_header_desc( $header );
+	if ( empty( $description ) )
+		return;
-	if ( empty( $text ) )
-		return false;
+	$protocol = $_SERVER['SERVER_PROTOCOL'];
-	$protocol = $_SERVER["SERVER_PROTOCOL"];
 	if ( 'HTTP/1.1' != $protocol && 'HTTP/1.0' != $protocol )
 		$protocol = 'HTTP/1.0';
-	$status_header = "$protocol $header $text";
+	$status_header = "$protocol $code $description";
 	if ( function_exists( 'apply_filters' ) )
-		$status_header = apply_filters( 'status_header', $status_header, $header, $text, $protocol );
+		/**
-	return @header( $status_header, true, $header );
+		 * Filter an HTTP status header.
-}
+		 *
+		 * @since 2.2.0
-/**
+		 *
-* Gets the header information to prevent caching.
+		 * @param string $status_header HTTP status header.
-*
+		 * @param int    $code          HTTP status code.
-* The several different headers cover the different ways cache prevention is handled
+		 * @param string $description   Description for the status code.
-* by different browsers
+		 * @param string $protocol      Server protocol.
+		 */
+		$status_header = apply_filters( 'status_header', $status_header, $code, $description, $protocol );
+	@header( $status_header, true, $code );
+}
+/**
+* Get the header information to prevent caching.
+*
+* The several different headers cover the different ways cache prevention
+* is handled by different browsers
 *
 * @since 2.8.0
 *
-* @uses apply_filters()
 * @return array The associative array of header names and field values.
 */
 function wp_get_nocache_headers() {
 	$headers = array(
 		'Expires' => 'Wed, 11 Jan 1984 05:00:00 GMT',
 		'Cache-Control' => 'no-cache, must-revalidate, max-age=0',
 		'Pragma' => 'no-cache',
 	);
 	if ( function_exists('apply_filters') ) {
-		$headers = (array) apply_filters('nocache_headers', $headers);
+		/**
+		 * Filter the cache-controlling headers.
+		 *
+		 * @since 2.8.0
+		 *
+		 * @see wp_get_nocache_headers()
+		 *
+		 * @param array $headers {
+		 *     Header names and field values.
+		 *
+		 *     @type string $Expires       Expires header.
+		 *     @type string $Cache-Control Cache-Control header.
+		 *     @type string $Pragma        Pragma header.
+		 * }
+		 */
+		$headers = (array) apply_filters( 'nocache_headers', $headers );
 	}
 	$headers['Last-Modified'] = false;
 	return $headers;
 }
 /**
-* Sets the headers to prevent caching for the different browsers.
+* Set the headers to prevent caching for the different browsers.
 *
-* Different browsers support different nocache headers, so several headers must
+* Different browsers support different nocache headers, so several
-* be sent so that all of them get the point that no caching should occur.
+* headers must be sent so that all of them get the point that no
+* caching should occur.
 *
 * @since 2.0.0
-* @uses wp_get_nocache_headers()
+*
+* @see wp_get_nocache_headers()
 */
 function nocache_headers() {
 	$headers = wp_get_nocache_headers();
 	unset( $headers['Last-Modified'] );
 *
 * @since 2.1.0
 */
 function cache_javascript_headers() {
 	$expiresOffset = 10 * DAY_IN_SECONDS;
 	header( "Content-Type: text/javascript; charset=" . get_bloginfo( 'charset' ) );
 	header( "Vary: Accept-Encoding" ); // Handle proxies
 	header( "Expires: " . gmdate( "D, d M Y H:i:s", time() + $expiresOffset ) . " GMT" );
 }
 /**
 * Retrieve the number of database queries during the WordPress execution.
 *
 * @since 2.0.0
 *
-* @return int Number of database queries
+* @global wpdb $wpdb WordPress database abstraction object.
+*
+* @return int Number of database queries.
 */
 function get_num_queries() {
 	global $wpdb;
 	return $wpdb->num_queries;
 }
 /**
-* Whether input is yes or no. Must be 'y' to be true.
+* Whether input is yes or no.
+*
+* Must be 'y' to be true.
 *
 * @since 1.0.0
 *
-* @param string $yn Character string containing either 'y' or 'n'
+* @param string $yn Character string containing either 'y' (yes) or 'n' (no).
-* @return bool True if yes, false on anything else
+* @return bool True if yes, false on anything else.
 */
 function bool_from_yn( $yn ) {
 	return ( strtolower( $yn ) == 'y' );
 }
 /**
-* Loads the feed template from the use of an action hook.
+* Load the feed template from the use of an action hook.
 *
 * If the feed action does not have a hook, then the function will die with a
 * message telling the visitor that the feed is not valid.
 *
 * It is better to only have one hook for each feed.
 *
 * @since 2.1.0
+*
 * @uses $wp_query Used to tell if the use a comment feed.
-* @uses do_action() Calls 'do_feed_$feed' hook, if a hook exists for the feed.
 */
 function do_feed() {
 	global $wp_query;
 	$feed = get_query_var( 'feed' );
 	$hook = 'do_feed_' . $feed;
 	if ( ! has_action( $hook ) )
 		wp_die( __( 'ERROR: This is not a valid feed template.' ), '', array( 'response' => 404 ) );
+	/**
+	 * Fires once the given feed is loaded.
+	 *
+	 * The dynamic hook name, $hook, refers to the feed name.
+	 *
+	 * @since 2.1.0
+	 *
+	 * @param bool $is_comment_feed Whether the feed is a comment feed.
+	 */
 	do_action( $hook, $wp_query->is_comment_feed );
 }
 /**
 * Load the RDF RSS 0.91 Feed template.
 *
 * @since 2.1.0
+*
+* @see load_template()
 */
 function do_feed_rdf() {
 	load_template( ABSPATH . WPINC . '/feed-rdf.php' );
 }
 /**
 * Load the RSS 1.0 Feed Template.
 *
 * @since 2.1.0
+*
+* @see load_template()
 */
 function do_feed_rss() {
 	load_template( ABSPATH . WPINC . '/feed-rss.php' );
 }
 /**
 * Load either the RSS2 comment feed or the RSS2 posts feed.
 *
 * @since 2.1.0
+*
+* @see load_template()
 *
 * @param bool $for_comments True for the comment feed, false for normal feed.
 */
 function do_feed_rss2( $for_comments ) {
 	if ( $for_comments )
 /**
 * Load either Atom comment feed or Atom posts feed.
 *
 * @since 2.1.0
 *
+* @see load_template()
+*
 * @param bool $for_comments True for the comment feed, false for normal feed.
 */
 function do_feed_atom( $for_comments ) {
 	if ($for_comments)
 		load_template( ABSPATH . WPINC . '/feed-atom-comments.php');
 *
 * The echo content should be with usage of the permalinks or for creating the
 * robots.txt file.
 *
 * @since 2.1.0
-* @uses do_action() Calls 'do_robotstxt' hook for displaying robots.txt rules.
 */
 function do_robots() {
 	header( 'Content-Type: text/plain; charset=utf-8' );
+	/**
+	 * Fires when displaying the robots.txt file.
+	 *
+	 * @since 2.1.0
+	 */
 	do_action( 'do_robotstxt' );
 	$output = "User-agent: *\n";
 	$public = get_option( 'blog_public' );
 	if ( '0' == $public ) {
 		$output .= "Disallow: /\n";
 	} else {
 		$site_url = parse_url( site_url() );
 		$path = ( !empty( $site_url['path'] ) ) ? $site_url['path'] : '';
 		$output .= "Disallow: $path/wp-admin/\n";
-		$output .= "Disallow: $path/wp-includes/\n";
+	}
-	}
+	/**
-	echo apply_filters('robots_txt', $output, $public);
+	 * Filter the robots.txt output.
+	 *
+	 * @since 3.0.0
+	 *
+	 * @param string $output Robots.txt output.
+	 * @param bool   $public Whether the site is considered "public".
+	 */
+	echo apply_filters( 'robots_txt', $output, $public );
 }
 /**
 * Test whether blog is already installed.
 *
-* The cache will be checked first. If you have a cache plugin, which saves the
+* The cache will be checked first. If you have a cache plugin, which saves
-* cache values, then this will work. If you use the default WordPress cache,
+* the cache values, then this will work. If you use the default WordPress
-* and the database goes away, then you might have problems.
+* cache, and the database goes away, then you might have problems.
 *
-* Checks for the option siteurl for whether WordPress is installed.
+* Checks for the 'siteurl' option for whether WordPress is installed.
 *
 * @since 2.1.0
-* @uses $wpdb
+*
-*
+* @global wpdb $wpdb WordPress database abstraction object.
-* @return bool Whether blog is already installed.
+*
+* @return bool Whether the blog is already installed.
 */
 function is_blog_installed() {
 	global $wpdb;
-	// Check cache first. If options table goes away and we have true cached, oh well.
+	/*
+	 * Check cache first. If options table goes away and we have true
+	 * cached, oh well.
+	 */
 	if ( wp_cache_get( 'is_blog_installed' ) )
 		return true;
 	$suppress = $wpdb->suppress_errors();
 	if ( ! defined( 'WP_INSTALLING' ) ) {
 	if ( defined( 'WP_REPAIRING' ) )
 		return true;
 	$suppress = $wpdb->suppress_errors();
-	// Loop over the WP tables. If none exist, then scratch install is allowed.
+	/*
-	// If one or more exist, suggest table repair since we got here because the options
+	 * Loop over the WP tables. If none exist, then scratch install is allowed.
-	// table could not be accessed.
+	 * If one or more exist, suggest table repair since we got here because the
+	 * options table could not be accessed.
+	 */
 	$wp_tables = $wpdb->tables();
 	foreach ( $wp_tables as $table ) {
 		// The existence of custom user tables shouldn't suggest an insane state or prevent a clean install.
 		if ( defined( 'CUSTOM_USER_TABLE' ) && CUSTOM_USER_TABLE == $table )
 			continue;
 }
 /**
 * Retrieve URL with nonce added to URL query.
 *
-* @package WordPress
-* @subpackage Security
 * @since 2.0.4
 *
-* @param string $actionurl URL to add nonce action.
+* @param string     $actionurl URL to add nonce action.
-* @param string $action Optional. Nonce action name.
+* @param int|string $action    Optional. Nonce action name. Default -1.
-* @param string $name Optional. Nonce name.
+* @param string     $name      Optional. Nonce name. Default '_wpnonce'.
-* @return string URL with nonce action added.
+* @return string Escaped URL with nonce action added.
 */
 function wp_nonce_url( $actionurl, $action = -1, $name = '_wpnonce' ) {
 	$actionurl = str_replace( '&amp;', '&', $actionurl );
 	return esc_html( add_query_arg( $name, wp_create_nonce( $action ), $actionurl ) );
 }
 * damage.
 *
 * The input name will be whatever $name value you gave. The input value will be
 * the nonce creation value.
 *
-* @package WordPress
-* @subpackage Security
 * @since 2.0.4
 *
-* @param string $action Optional. Action name.
+* @param int|string $action  Optional. Action name. Default -1.
-* @param string $name Optional. Nonce name.
+* @param string     $name    Optional. Nonce name. Default '_wpnonce'.
-* @param bool $referer Optional, default true. Whether to set the referer field for validation.
+* @param bool       $referer Optional. Whether to set the referer field for validation. Default true.
-* @param bool $echo Optional, default true. Whether to display or return hidden form field.
+* @param bool       $echo    Optional. Whether to display or return hidden form field. Default true.
-* @return string Nonce field.
+* @return string Nonce field HTML markup.
 */
 function wp_nonce_field( $action = -1, $name = "_wpnonce", $referer = true , $echo = true ) {
 	$name = esc_attr( $name );
 	$nonce_field = '<input type="hidden" id="' . $name . '" name="' . $name . '" value="' . wp_create_nonce( $action ) . '" />';
 * Retrieve or display referer hidden field for forms.
 *
 * The referer link is the current Request URI from the server super global. The
 * input name is '_wp_http_referer', in case you wanted to check manually.
 *
-* @package WordPress
-* @subpackage Security
 * @since 2.0.4
 *
-* @param bool $echo Whether to echo or return the referer field.
+* @param bool $echo Optional. Whether to echo or return the referer field. Default true.
-* @return string Referer field.
+* @return string Referer field HTML markup.
 */
 function wp_referer_field( $echo = true ) {
 	$referer_field = '<input type="hidden" name="_wp_http_referer" value="'. esc_attr( wp_unslash( $_SERVER['REQUEST_URI'] ) ) . '" />';
 	if ( $echo )
 /**
 * Retrieve or display original referer hidden field for forms.
 *
 * The input name is '_wp_original_http_referer' and will be either the same
-* value of {@link wp_referer_field()}, if that was posted already or it will
+* value of wp_referer_field(), if that was posted already or it will be the
-* be the current page, if it doesn't exist.
+* current page, if it doesn't exist.
 *
-* @package WordPress
-* @subpackage Security
 * @since 2.0.4
 *
-* @param bool $echo Whether to echo the original http referer
+* @param bool   $echo         Optional. Whether to echo the original http referer. Default true.
-* @param string $jump_back_to Optional, default is 'current'. Can be 'previous' or page you want to jump back to.
+* @param string $jump_back_to Optional. Can be 'previous' or page you want to jump back to.
+*                             Default 'current'.
 * @return string Original referer field.
 */
 function wp_original_referer_field( $echo = true, $jump_back_to = 'current' ) {
 	if ( ! $ref = wp_get_original_referer() ) {
 		$ref = 'previous' == $jump_back_to ? wp_get_referer() : wp_unslash( $_SERVER['REQUEST_URI'] );
 		echo $orig_referer_field;
 	return $orig_referer_field;
 }
 /**
-* Retrieve referer from '_wp_http_referer' or HTTP referer. If it's the same
+* Retrieve referer from '_wp_http_referer' or HTTP referer.
-* as the current request URL, will return false.
+*
-*
+* If it's the same as the current request URL, will return false.
-* @package WordPress
+*
-* @subpackage Security
 * @since 2.0.4
 *
-* @return string|bool False on failure. Referer URL on success.
+* @return false|string False on failure. Referer URL on success.
 */
 function wp_get_referer() {
 	if ( ! function_exists( 'wp_validate_redirect' ) )
 		return false;
 	$ref = false;
 	if ( ! empty( $_REQUEST['_wp_http_referer'] ) )
 		$ref = wp_unslash( $_REQUEST['_wp_http_referer'] );
-	else if ( ! empty( $_SERVER['HTTP_REFERER'] ) )
+	elseif ( ! empty( $_SERVER['HTTP_REFERER'] ) )
 		$ref = wp_unslash( $_SERVER['HTTP_REFERER'] );
 	if ( $ref && $ref !== wp_unslash( $_SERVER['REQUEST_URI'] ) )
 		return wp_validate_redirect( $ref, false );
 	return false;
 }
 /**
 * Retrieve original referer that was posted, if it exists.
 *
-* @package WordPress
-* @subpackage Security
 * @since 2.0.4
 *
-* @return string|bool False if no original referer or original referer if set.
+* @return string|false False if no original referer or original referer if set.
 */
 function wp_get_original_referer() {
 	if ( ! empty( $_REQUEST['_wp_original_http_referer'] ) && function_exists( 'wp_validate_redirect' ) )
 		return wp_validate_redirect( wp_unslash( $_REQUEST['_wp_original_http_referer'] ), false );
 	return false;
 * @return bool Whether the path was created. True if path already exists.
 */
 function wp_mkdir_p( $target ) {
 	$wrapper = null;
-	// strip the protocol
+	// Strip the protocol.
 	if( wp_is_stream( $target ) ) {
 		list( $wrapper, $target ) = explode( '://', $target, 2 );
 	}
-	// from php.net/mkdir user contributed notes
+	// From php.net/mkdir user contributed notes.
 	$target = str_replace( '//', '/', $target );
-	// put the wrapper back on the target
+	// Put the wrapper back on the target.
 	if( $wrapper !== null ) {
 		$target = $wrapper . '://' . $target;
 	}
-	// safe mode fails with a trailing slash under certain PHP versions.
+	/*
-	$target = rtrim($target, '/'); // Use rtrim() instead of untrailingslashit to avoid formatting.php dependency.
+	 * Safe mode fails with a trailing slash under certain PHP versions.
+	 * Use rtrim() instead of untrailingslashit to avoid formatting.php dependency.
+	 */
+	$target = rtrim($target, '/');
 	if ( empty($target) )
 		$target = '/';
 	if ( file_exists( $target ) )
 		return @is_dir( $target );
 	while ( '.' != $target_parent && ! is_dir( $target_parent ) ) {
 		$target_parent = dirname( $target_parent );
 	}
 	// Get the permission bits.
-	if ( $target_parent && '.' != $target_parent ) {
+	if ( $stat = @stat( $target_parent ) ) {
-		$stat = @stat( $target_parent );
 		$dir_perms = $stat['mode'] & 0007777;
 	} else {
 		$dir_perms = 0777;
 	}
 	if ( @mkdir( $target, $dir_perms, true ) ) {
+		/*
+		 * If a umask is set that modifies $dir_perms, we'll have to re-set
+		 * the $dir_perms correctly with chmod()
+		 */
+		if ( $dir_perms != ( $dir_perms & ~umask() ) ) {
+			$folder_parts = explode( '/', substr( $target, strlen( $target_parent ) + 1 ) );
+			for ( $i = 1, $c = count( $folder_parts ); $i <= $c; $i++ ) {
+				@chmod( $target_parent . '/' . implode( '/', array_slice( $folder_parts, 0, $i ) ), $dir_perms );
+			}
+		}
 		return true;
 	}
 	return false;
 }
 /**
-* Test if a give filesystem path is absolute ('/foo/bar', 'c:\windows').
+* Test if a give filesystem path is absolute.
+*
+* For example, '/foo/bar', or 'c:\windows'.
 *
 * @since 2.5.0
 *
-* @param string $path File path
+* @param string $path File path.
 * @return bool True if path is absolute, false is not absolute.
 */
 function path_is_absolute( $path ) {
-	// this is definitive if true but fails if $path does not exist or contains a symbolic link
+	/*
+	 * This is definitive if true but fails if $path does not exist or contains
+	 * a symbolic link.
+	 */
 	if ( realpath($path) == $path )
 		return true;
 	if ( strlen($path) == 0 || $path[0] == '.' )
 		return false;
-	// windows allows absolute paths like this
+	// Windows allows absolute paths like this.
 	if ( preg_match('#^[a-zA-Z]:\\\\#', $path) )
 		return true;
-	// a path starting with / or \ is absolute; anything else is relative
+	// A path starting with / or \ is absolute; anything else is relative.
 	return ( $path[0] == '/' || $path[0] == '\\' );
 }
 /**
-* Join two filesystem paths together (e.g. 'give me $path relative to $base').
+* Join two filesystem paths together.
 *
-* If the $path is absolute, then it the full path is returned.
+* For example, 'give me $path relative to $base'. If the $path is absolute,
+* then it the full path is returned.
 *
 * @since 2.5.0
 *
-* @param string $base
+* @param string $base Base path.
-* @param string $path
+* @param string $path Path relative to $base.
 * @return string The path with the base or absolute path.
 */
 function path_join( $base, $path ) {
 	if ( path_is_absolute($path) )
 		return $path;
 	return rtrim($base, '/') . '/' . ltrim($path, '/');
 }
 /**
-* Determines a writable directory for temporary files.
+* Normalize a filesystem path.
-* Function's preference is the return value of <code>sys_get_temp_dir()</code>,
+*
+* Replaces backslashes with forward slashes for Windows systems, and ensures
+* no duplicate slashes exist.
+*
+* @since 3.9.0
+*
+* @param string $path Path to normalize.
+* @return string Normalized path.
+*/
+function wp_normalize_path( $path ) {
+	$path = str_replace( '\\', '/', $path );
+	$path = preg_replace( '|/+|','/', $path );
+	return $path;
+}
+/**
+* Determine a writable directory for temporary files.
+*
+* Function's preference is the return value of sys_get_temp_dir(),
 * followed by your PHP temporary upload directory, followed by WP_CONTENT_DIR,
 * before finally defaulting to /tmp/
 *
 * In the event that this function does not find a writable location,
-* It may be overridden by the <code>WP_TEMP_DIR</code> constant in
+* It may be overridden by the WP_TEMP_DIR constant in your wp-config.php file.
-* your <code>wp-config.php</code> file.
 *
 * @since 2.5.0
 *
-* @return string Writable temporary directory
+* @return string Writable temporary directory.
 */
 function get_temp_dir() {
 	static $temp;
 	if ( defined('WP_TEMP_DIR') )
 		return trailingslashit(WP_TEMP_DIR);
 	if ( $temp )
-		return trailingslashit( rtrim( $temp, '\\' ) );
+		return trailingslashit( $temp );
 	if ( function_exists('sys_get_temp_dir') ) {
 		$temp = sys_get_temp_dir();
 		if ( @is_dir( $temp ) && wp_is_writable( $temp ) )
-			return trailingslashit( rtrim( $temp, '\\' ) );
+			return trailingslashit( $temp );
 	}
 	$temp = ini_get('upload_tmp_dir');
 	if ( @is_dir( $temp ) && wp_is_writable( $temp ) )
-		return trailingslashit( rtrim( $temp, '\\' ) );
+		return trailingslashit( $temp );
 	$temp = WP_CONTENT_DIR . '/';
 	if ( is_dir( $temp ) && wp_is_writable( $temp ) )
 		return $temp;
 }
 /**
 * Determine if a directory is writable.
 *
-* This function is used to work around certain ACL issues
+* This function is used to work around certain ACL issues in PHP primarily
-* in PHP primarily affecting Windows Servers.
+* affecting Windows Servers.
+*
+* @since 3.6.0
 *
 * @see win_is_writable()
 *
-* @since 3.6.0
+* @param string $path Path to check for write-ability.
-*
+* @return bool Whether the path is writable.
-* @param string $path
-* @return bool
 */
 function wp_is_writable( $path ) {
 	if ( 'WIN' === strtoupper( substr( PHP_OS, 0, 3 ) ) )
 		return win_is_writable( $path );
 	else
 * PHP has issues with Windows ACL's for determine if a
 * directory is writable or not, this works around them by
 * checking the ability to open files rather than relying
 * upon PHP to interprate the OS ACL.
 *
-* @link http://bugs.php.net/bug.php?id=27609
-* @link http://bugs.php.net/bug.php?id=30931
-*
 * @since 2.8.0
 *
-* @param string $path
+* @see http://bugs.php.net/bug.php?id=27609
-* @return bool
+* @see http://bugs.php.net/bug.php?id=30931
+*
+* @param string $path Windows path to check for write-ability.
+* @return bool Whether the path is writable.
 */
 function win_is_writable( $path ) {
-	if ( $path[strlen( $path ) - 1] == '/' ) // if it looks like a directory, check a random file within the directory
+	if ( $path[strlen( $path ) - 1] == '/' ) { // if it looks like a directory, check a random file within the directory
 		return win_is_writable( $path . uniqid( mt_rand() ) . '.tmp');
-	else if ( is_dir( $path ) ) // If it's a directory (and not a file) check a random file within the directory
+	} elseif ( is_dir( $path ) ) { // If it's a directory (and not a file) check a random file within the directory
 		return win_is_writable( $path . '/' . uniqid( mt_rand() ) . '.tmp' );
+	}
 	// check tmp file for read/write capabilities
 	$should_delete_tmp_file = !file_exists( $path );
 	$f = @fopen( $path, 'a' );
 	if ( $f === false )
 		return false;
 * 'basedir' - path without subdir.
 * 'baseurl' - URL path without subdir.
 * 'error' - set to false.
 *
 * @since 2.0.0
-* @uses apply_filters() Calls 'upload_dir' on returned array.
+*
-*
+* @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
-* @param string $time Optional. Time formatted in 'yyyy/mm'.
 * @return array See above for description.
 */
 function wp_upload_dir( $time = null ) {
 	$siteurl = get_option( 'siteurl' );
 	$upload_path = trim( get_option( 'upload_path' ) );
 			$url = WP_CONTENT_URL . '/uploads';
 		else
 			$url = trailingslashit( $siteurl ) . $upload_path;
 	}
-	// Obey the value of UPLOADS. This happens as long as ms-files rewriting is disabled.
+	/*
-	// We also sometimes obey UPLOADS when rewriting is enabled -- see the next block.
+	 * Honor the value of UPLOADS. This happens as long as ms-files rewriting is disabled.
+	 * We also sometimes obey UPLOADS when rewriting is enabled -- see the next block.
+	 */
 	if ( defined( 'UPLOADS' ) && ! ( is_multisite() && get_site_option( 'ms_files_rewriting' ) ) ) {
 		$dir = ABSPATH . UPLOADS;
 		$url = trailingslashit( $siteurl ) . UPLOADS;
 	}
 	// If multisite (and if not the main site in a post-MU network)
 	if ( is_multisite() && ! ( is_main_network() && is_main_site() && defined( 'MULTISITE' ) ) ) {
 		if ( ! get_site_option( 'ms_files_rewriting' ) ) {
-			// If ms-files rewriting is disabled (networks created post-3.5), it is fairly straightforward:
+			/*
-			// Append sites/%d if we're not on the main site (for post-MU networks). (The extra directory
+			 * If ms-files rewriting is disabled (networks created post-3.5), it is fairly
-			// prevents a four-digit ID from conflicting with a year-based directory for the main site.
+			 * straightforward: Append sites/%d if we're not on the main site (for post-MU
-			// But if a MU-era network has disabled ms-files rewriting manually, they don't need the extra
+			 * networks). (The extra directory prevents a four-digit ID from conflicting with
-			// directory, as they never had wp-content/uploads for the main site.)
+			 * a year-based directory for the main site. But if a MU-era network has disabled
+			 * ms-files rewriting manually, they don't need the extra directory, as they never
+			 * had wp-content/uploads for the main site.)
+			 */
 			if ( defined( 'MULTISITE' ) )
 				$ms_dir = '/sites/' . get_current_blog_id();
 			else
 				$ms_dir = '/' . get_current_blog_id();
 			$dir .= $ms_dir;
 			$url .= $ms_dir;
 		} elseif ( defined( 'UPLOADS' ) && ! ms_is_switched() ) {
-			// Handle the old-form ms-files.php rewriting if the network still has that enabled.
+			/*
-			// When ms-files rewriting is enabled, then we only listen to UPLOADS when:
+			 * Handle the old-form ms-files.php rewriting if the network still has that enabled.
-			//   1) we are not on the main site in a post-MU network,
+			 * When ms-files rewriting is enabled, then we only listen to UPLOADS when:
-			//      as wp-content/uploads is used there, and
+			 * 1) We are not on the main site in a post-MU network, as wp-content/uploads is used
-			//   2) we are not switched, as ms_upload_constants() hardcodes
+			 *    there, and
-			//      these constants to reflect the original blog ID.
+			 * 2) We are not switched, as ms_upload_constants() hardcodes these constants to reflect
-			//
+			 *    the original blog ID.
-			// Rather than UPLOADS, we actually use BLOGUPLOADDIR if it is set, as it is absolute.
+			 *
-			// (And it will be set, see ms_upload_constants().) Otherwise, UPLOADS can be used, as
+			 * Rather than UPLOADS, we actually use BLOGUPLOADDIR if it is set, as it is absolute.
-			// as it is relative to ABSPATH. For the final piece: when UPLOADS is used with ms-files
+			 * (And it will be set, see ms_upload_constants().) Otherwise, UPLOADS can be used, as
-			// rewriting in multisite, the resulting URL is /files. (#WP22702 for background.)
+			 * as it is relative to ABSPATH. For the final piece: when UPLOADS is used with ms-files
+			 * rewriting in multisite, the resulting URL is /files. (#WP22702 for background.)
+			 */
 			if ( defined( 'BLOGUPLOADDIR' ) )
 				$dir = untrailingslashit( BLOGUPLOADDIR );
 			else
 				$dir = ABSPATH . UPLOADS;
 	}
 	$dir .= $subdir;
 	$url .= $subdir;
+	/**
+	 * Filter the uploads directory data.
+	 *
+	 * @since 2.0.0
+	 *
+	 * @param array $uploads Array of upload directory data with keys of 'path',
+	 *                       'url', 'subdir, 'basedir', and 'error'.
+	 */
 	$uploads = apply_filters( 'upload_dir',
 		array(
 			'path'    => $dir,
 			'url'     => $url,
 			'subdir'  => $subdir,
 			'basedir' => $basedir,
 			'baseurl' => $baseurl,
 			'error'   => false,
 		) );
-	// Make sure we have an uploads dir
+	// Make sure we have an uploads directory.
 	if ( ! wp_mkdir_p( $uploads['path'] ) ) {
 		if ( 0 === strpos( $uploads['basedir'], ABSPATH ) )
 			$error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
 		else
 			$error_path = basename( $uploads['basedir'] ) . $uploads['subdir'];
 * The callback is passed three parameters, the first one is the directory, the
 * second is the filename, and the third is the extension.
 *
 * @since 2.5.0
 *
-* @param string $dir
+* @param string   $dir                      Directory.
-* @param string $filename
+* @param string   $filename                 File name.
-* @param mixed $unique_filename_callback Callback.
+* @param callback $unique_filename_callback Callback. Default null.
 * @return string New filename, if given wasn't unique.
 */
 function wp_unique_filename( $dir, $filename, $unique_filename_callback = null ) {
-	// sanitize the file name before we begin processing
+	// Sanitize the file name before we begin processing.
 	$filename = sanitize_file_name($filename);
-	// separate the filename into a name and extension
+	// Separate the filename into a name and extension.
 	$info = pathinfo($filename);
 	$ext = !empty($info['extension']) ? '.' . $info['extension'] : '';
 	$name = basename($filename, $ext);
-	// edge case: if file is named '.ext', treat as an empty name
+	// Edge case: if file is named '.ext', treat as an empty name.
 	if ( $name === $ext )
 		$name = '';
-	// Increment the file number until we have a unique file to save in $dir. Use callback if supplied.
+	/*
+	 * Increment the file number until we have a unique file to save in $dir.
+	 * Use callback if supplied.
+	 */
 	if ( $unique_filename_callback && is_callable( $unique_filename_callback ) ) {
 		$filename = call_user_func( $unique_filename_callback, $dir, $name, $ext );
 	} else {
 		$number = '';
-		// change '.ext' to lower case
+		// Change '.ext' to lower case.
 		if ( $ext && strtolower($ext) != $ext ) {
 			$ext2 = strtolower($ext);
 			$filename2 = preg_replace( '|' . preg_quote($ext) . '$|', $ext2, $filename );
-			// check for both lower and upper case extension or image sub-sizes may be overwritten
+			// Check for both lower and upper case extension or image sub-sizes may be overwritten.
 			while ( file_exists($dir . "/$filename") || file_exists($dir . "/$filename2") ) {
 				$new_number = $number + 1;
 				$filename = str_replace( "$number$ext", "$new_number$ext", $filename );
 				$filename2 = str_replace( "$number$ext2", "$new_number$ext2", $filename2 );
 				$number = $new_number;
 *
 * The permissions will be set on the new file automatically by this function.
 *
 * @since 2.0.0
 *
-* @param string $name
+* @param string       $name       Filename.
-* @param null $deprecated Never used. Set to null.
+* @param null|string  $deprecated Never used. Set to null.
-* @param mixed $bits File content
+* @param mixed        $bits       File content
-* @param string $time Optional. Time formatted in 'yyyy/mm'.
+* @param string       $time       Optional. Time formatted in 'yyyy/mm'. Default null.
 * @return array
 */
 function wp_upload_bits( $name, $deprecated, $bits, $time = null ) {
 	if ( !empty( $deprecated ) )
 		_deprecated_argument( __FUNCTION__, '2.0' );
 	$upload = wp_upload_dir( $time );
 	if ( $upload['error'] !== false )
 		return $upload;
+	/**
+	 * Filter whether to treat the upload bits as an error.
+	 *
+	 * Passing a non-array to the filter will effectively short-circuit preparing
+	 * the upload bits, returning that value instead.
+	 *
+	 * @since 3.0.0
+	 *
+	 * @param mixed $upload_bits_error An array of upload bits data, or a non-array error to return.
+	 */
 	$upload_bits_error = apply_filters( 'wp_upload_bits', array( 'name' => $name, 'bits' => $bits, 'time' => $time ) );
 	if ( !is_array( $upload_bits_error ) ) {
 		$upload[ 'error' ] = $upload_bits_error;
 		return $upload;
 	}
 }
 /**
 * Retrieve the file type based on the extension name.
 *
-* @package WordPress
 * @since 2.5.0
-* @uses apply_filters() Calls 'ext2type' hook on default supported types.
 *
 * @param string $ext The extension to search.
-* @return string|null The file type, example: audio, video, document, spreadsheet, etc. Null if not found.
+* @return string|null The file type, example: audio, video, document, spreadsheet, etc.
+*                     Null if not found.
 */
 function wp_ext2type( $ext ) {
 	$ext = strtolower( $ext );
+	/**
+	 * Filter file type based on the extension name.
+	 *
+	 * @since 2.5.0
+	 *
+	 * @see wp_ext2type()
+	 *
+	 * @param array $ext2type Multi-dimensional array with extensions for a default set
+	 *                        of file types.
+	 */
 	$ext2type = apply_filters( 'ext2type', array(
 		'image'       => array( 'jpg', 'jpeg', 'jpe',  'gif',  'png',  'bmp',   'tif',  'tiff', 'ico' ),
 		'audio'       => array( 'aac', 'ac3',  'aif',  'aiff', 'm3a',  'm4a',   'm4b',  'mka',  'mp1',  'mp2',  'mp3', 'ogg', 'oga', 'ram', 'wav', 'wma' ),
-		'video'       => array( 'asf', 'avi',  'divx', 'dv',   'flv',  'm4v',   'mkv',  'mov',  'mp4',  'mpeg', 'mpg', 'mpv', 'ogm', 'ogv', 'qt',  'rm', 'vob', 'wmv' ),
+		'video'       => array( '3g2',  '3gp', '3gpp', 'asf', 'avi',  'divx', 'dv',   'flv',  'm4v',   'mkv',  'mov',  'mp4',  'mpeg', 'mpg', 'mpv', 'ogm', 'ogv', 'qt',  'rm', 'vob', 'wmv' ),
-		'document'    => array( 'doc', 'docx', 'docm', 'dotm', 'odt',  'pages', 'pdf',  'rtf',  'wp',   'wpd' ),
+		'document'    => array( 'doc', 'docx', 'docm', 'dotm', 'odt',  'pages', 'pdf',  'xps',  'oxps', 'rtf',  'wp', 'wpd', 'psd', 'xcf' ),
 		'spreadsheet' => array( 'numbers',     'ods',  'xls',  'xlsx', 'xlsm',  'xlsb' ),
 		'interactive' => array( 'swf', 'key',  'ppt',  'pptx', 'pptm', 'pps',   'ppsx', 'ppsm', 'sldx', 'sldm', 'odp' ),
 		'text'        => array( 'asc', 'csv',  'tsv',  'txt' ),
 		'archive'     => array( 'bz2', 'cab',  'dmg',  'gz',   'rar',  'sea',   'sit',  'sqx',  'tar',  'tgz',  'zip', '7z' ),
 		'code'        => array( 'css', 'htm',  'html', 'php',  'js' ),
 * You can optionally define the mime array, if needed.
 *
 * @since 2.0.4
 *
 * @param string $filename File name or path.
-* @param array $mimes Optional. Key is the file extension with value as the mime type.
+* @param array  $mimes    Optional. Key is the file extension with value as the mime type.
 * @return array Values with extension first and mime type.
 */
 function wp_check_filetype( $filename, $mimes = null ) {
 	if ( empty($mimes) )
 		$mimes = get_allowed_mime_types();
 	return compact( 'ext', 'type' );
 }
 /**
 * Attempt to determine the real file type of a file.
+*
 * If unable to, the file name extension will be used to determine type.
 *
 * If it's determined that the extension does not match the file's real type,
 * then the "proper_filename" value will be set with a proper filename and extension.
 *
 * Currently this function only supports validating images known to getimagesize().
 *
 * @since 3.0.0
 *
-* @param string $file Full path to the file.
+* @param string $file     Full path to the file.
-* @param string $filename The name of the file (may differ from $file due to $file being in a tmp directory)
+* @param string $filename The name of the file (may differ from $file due to $file being
-* @param array $mimes Optional. Key is the file extension with value as the mime type.
+*                         in a tmp directory).
-* @return array Values for the extension, MIME, and either a corrected filename or false if original $filename is valid
+* @param array   $mimes   Optional. Key is the file extension with value as the mime type.
+* @return array Values for the extension, MIME, and either a corrected filename or false
+*               if original $filename is valid.
 */
 function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
 	$proper_filename = false;
 	// Do basic extension validation and MIME mapping
 	$wp_filetype = wp_check_filetype( $filename, $mimes );
-	extract( $wp_filetype );
+	$ext = $wp_filetype['ext'];
+	$type = $wp_filetype['type'];
 	// We can't do any further validation without a file to work with
-	if ( ! file_exists( $file ) )
+	if ( ! file_exists( $file ) ) {
 		return compact( 'ext', 'type', 'proper_filename' );
+	}
 	// We're able to validate images using GD
 	if ( $type && 0 === strpos( $type, 'image/' ) && function_exists('getimagesize') ) {
 		// Attempt to figure out what type of image it actually is
 		$imgstats = @getimagesize( $file );
 		// If getimagesize() knows what kind of image it really is and if the real MIME doesn't match the claimed MIME
 		if ( !empty($imgstats['mime']) && $imgstats['mime'] != $type ) {
-			// This is a simplified array of MIMEs that getimagesize() can detect and their extensions
+			/**
-			// You shouldn't need to use this filter, but it's here just in case
+			 * Filter the list mapping image mime types to their respective extensions.
+			 *
+			 * @since 3.0.0
+			 *
+			 * @param  array $mime_to_ext Array of image mime types and their matching extensions.
+			 */
 			$mime_to_ext = apply_filters( 'getimagesize_mimes_to_exts', array(
 				'image/jpeg' => 'jpg',
 				'image/png'  => 'png',
 				'image/gif'  => 'gif',
 				'image/bmp'  => 'bmp',
 				$filename_parts = explode( '.', $filename );
 				array_pop( $filename_parts );
 				$filename_parts[] = $mime_to_ext[ $imgstats['mime'] ];
 				$new_filename = implode( '.', $filename_parts );
-				if ( $new_filename != $filename )
+				if ( $new_filename != $filename ) {
 					$proper_filename = $new_filename; // Mark that it changed
+				}
 				// Redefine the extension / MIME
 				$wp_filetype = wp_check_filetype( $new_filename, $mimes );
-				extract( $wp_filetype );
+				$ext = $wp_filetype['ext'];
+				$type = $wp_filetype['type'];
 			}
 		}
 	}
-	// Let plugins try and validate other types of files
+	/**
-	// Should return an array in the style of array( 'ext' => $ext, 'type' => $type, 'proper_filename' => $proper_filename )
+	 * Filter the "real" file type of the given file.
+	 *
+	 * @since 3.0.0
+	 *
+	 * @param array  $wp_check_filetype_and_ext File data array containing 'ext', 'type', and
+	 *                                          'proper_filename' keys.
+	 * @param string $file                      Full path to the file.
+	 * @param string $filename                  The name of the file (may differ from $file due to
+	 *                                          $file being in a tmp directory).
+	 * @param array  $mimes                     Key is the file extension with value as the mime type.
+	 */
 	return apply_filters( 'wp_check_filetype_and_ext', compact( 'ext', 'type', 'proper_filename' ), $file, $filename, $mimes );
 }
 /**
 * Retrieve list of mime types and file extensions.
 *
 * @since 3.5.0
-*
+* @since 4.2.0 Support was added for GIMP (xcf) files.
-* @uses apply_filters() Calls 'mime_types' on returned array. This filter should
-* be used to add types, not remove them. To remove types use the upload_mimes filter.
 *
 * @return array Array of mime types keyed by the file extension regex corresponding to those types.
 */
 function wp_get_mime_types() {
-	// Accepted MIME types are set here as PCRE unless provided.
+	/**
+	 * Filter the list of mime types and file extensions.
+	 *
+	 * This filter should be used to add, not remove, mime types. To remove
+	 * mime types, use the 'upload_mimes' filter.
+	 *
+	 * @since 3.5.0
+	 *
+	 * @param array $wp_get_mime_types Mime types keyed by the file extension regex
+	 *                                 corresponding to those types.
+	 */
 	return apply_filters( 'mime_types', array(
-	// Image formats
+	// Image formats.
 	'jpg|jpeg|jpe' => 'image/jpeg',
 	'gif' => 'image/gif',
 	'png' => 'image/png',
 	'bmp' => 'image/bmp',
-	'tif|tiff' => 'image/tiff',
+	'tiff|tif' => 'image/tiff',
 	'ico' => 'image/x-icon',
-	// Video formats
+	// Video formats.
 	'asf|asx' => 'video/x-ms-asf',
 	'wmv' => 'video/x-ms-wmv',
 	'wmx' => 'video/x-ms-wmx',
 	'wm' => 'video/x-ms-wm',
 	'avi' => 'video/avi',
 	'mpeg|mpg|mpe' => 'video/mpeg',
 	'mp4|m4v' => 'video/mp4',
 	'ogv' => 'video/ogg',
 	'webm' => 'video/webm',
 	'mkv' => 'video/x-matroska',
-	// Text formats
+	'3gp|3gpp' => 'video/3gpp', // Can also be audio
-	'txt|asc|c|cc|h' => 'text/plain',
+	'3g2|3gp2' => 'video/3gpp2', // Can also be audio
+	// Text formats.
+	'txt|asc|c|cc|h|srt' => 'text/plain',
 	'csv' => 'text/csv',
 	'tsv' => 'text/tab-separated-values',
 	'ics' => 'text/calendar',
 	'rtx' => 'text/richtext',
 	'css' => 'text/css',
 	'htm|html' => 'text/html',
-	// Audio formats
+	'vtt' => 'text/vtt',
+	'dfxp' => 'application/ttaf+xml',
+	// Audio formats.
 	'mp3|m4a|m4b' => 'audio/mpeg',
 	'ra|ram' => 'audio/x-realaudio',
 	'wav' => 'audio/wav',
 	'ogg|oga' => 'audio/ogg',
 	'mid|midi' => 'audio/midi',
 	'wma' => 'audio/x-ms-wma',
 	'wax' => 'audio/x-ms-wax',
 	'mka' => 'audio/x-matroska',
-	// Misc application formats
+	// Misc application formats.
 	'rtf' => 'application/rtf',
 	'js' => 'application/javascript',
 	'pdf' => 'application/pdf',
 	'swf' => 'application/x-shockwave-flash',
 	'class' => 'application/java',
 	'zip' => 'application/zip',
 	'gz|gzip' => 'application/x-gzip',
 	'rar' => 'application/rar',
 	'7z' => 'application/x-7z-compressed',
 	'exe' => 'application/x-msdownload',
-	// MS Office formats
+	'psd' => 'application/octet-stream',
+	'xcf' => 'application/octet-stream',
+	// MS Office formats.
 	'doc' => 'application/msword',
 	'pot|pps|ppt' => 'application/vnd.ms-powerpoint',
 	'wri' => 'application/vnd.ms-write',
 	'xla|xls|xlt|xlw' => 'application/vnd.ms-excel',
 	'mdb' => 'application/vnd.ms-access',
 	'potm' => 'application/vnd.ms-powerpoint.template.macroEnabled.12',
 	'ppam' => 'application/vnd.ms-powerpoint.addin.macroEnabled.12',
 	'sldx' => 'application/vnd.openxmlformats-officedocument.presentationml.slide',
 	'sldm' => 'application/vnd.ms-powerpoint.slide.macroEnabled.12',
 	'onetoc|onetoc2|onetmp|onepkg' => 'application/onenote',
-	// OpenOffice formats
+	'oxps' => 'application/oxps',
+	'xps' => 'application/vnd.ms-xpsdocument',
+	// OpenOffice formats.
 	'odt' => 'application/vnd.oasis.opendocument.text',
 	'odp' => 'application/vnd.oasis.opendocument.presentation',
 	'ods' => 'application/vnd.oasis.opendocument.spreadsheet',
 	'odg' => 'application/vnd.oasis.opendocument.graphics',
 	'odc' => 'application/vnd.oasis.opendocument.chart',
 	'odb' => 'application/vnd.oasis.opendocument.database',
 	'odf' => 'application/vnd.oasis.opendocument.formula',
-	// WordPerfect formats
+	// WordPerfect formats.
 	'wp|wpd' => 'application/wordperfect',
-	// iWork formats
+	// iWork formats.
 	'key' => 'application/vnd.apple.keynote',
 	'numbers' => 'application/vnd.apple.numbers',
 	'pages' => 'application/vnd.apple.pages',
 	) );
 }
 /**
 * Retrieve list of allowed mime types and file extensions.
 *
 * @since 2.8.6
 *
-* @uses apply_filters() Calls 'upload_mimes' on returned array
-* @uses wp_get_upload_mime_types() to fetch the list of mime types
-*
 * @param int|WP_User $user Optional. User to check. Defaults to current user.
-* @return array Array of mime types keyed by the file extension regex corresponding to those types.
+* @return array Array of mime types keyed by the file extension regex corresponding
+*               to those types.
 */
 function get_allowed_mime_types( $user = null ) {
 	$t = wp_get_mime_types();
 	unset( $t['swf'], $t['exe'] );
 		$unfiltered = $user ? user_can( $user, 'unfiltered_html' ) : current_user_can( 'unfiltered_html' );
 	if ( empty( $unfiltered ) )
 		unset( $t['htm|html'] );
+	/**
+	 * Filter list of allowed mime types and file extensions.
+	 *
+	 * @since 2.0.0
+	 *
+	 * @param array            $t    Mime types keyed by the file extension regex corresponding to
+	 *                               those types. 'swf' and 'exe' removed from full list. 'htm|html' also
+	 *                               removed depending on '$user' capabilities.
+	 * @param int|WP_User|null $user User ID, User object or null if not provided (indicates current user).
+	 */
 	return apply_filters( 'upload_mimes', $t, $user );
 }
 /**
 * Display "Are You Sure" message to confirm the action being taken.
 *
-* If the action has the nonce explain message, then it will be displayed along
+* If the action has the nonce explain message, then it will be displayed
-* with the "Are you sure?" message.
+* along with the "Are you sure?" message.
 *
-* @package WordPress
-* @subpackage Security
 * @since 2.0.4
 *
 * @param string $action The nonce action.
 */
 function wp_nonce_ays( $action ) {
-	$title = __( 'WordPress Failure Notice' );
 	if ( 'log-out' == $action ) {
 		$html = sprintf( __( 'You are attempting to log out of %s' ), get_bloginfo( 'name' ) ) . '</p><p>';
-		$html .= sprintf( __( "Do you really want to <a href='%s'>log out</a>?"), wp_logout_url() );
+		$redirect_to = isset( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '';
+		$html .= sprintf( __( "Do you really want to <a href='%s'>log out</a>?"), wp_logout_url( $redirect_to ) );
 	} else {
 		$html = __( 'Are you sure you want to do this?' );
 		if ( wp_get_referer() )
 			$html .= "</p><p><a href='" . esc_url( remove_query_arg( 'updated', wp_get_referer() ) ) . "'>" . __( 'Please try again.' ) . "</a>";
 	}
-	wp_die( $html, $title, array('response' => 403) );
+	wp_die( $html, __( 'WordPress Failure Notice' ), 403 );
 }
 /**
 * Kill WordPress execution and display HTML message with error message.
 *
-* This function complements the die() PHP function. The difference is that
+* This function complements the `die()` PHP function. The difference is that
 * HTML will be displayed to the user. It is recommended to use this function
-* only, when the execution should not continue any further. It is not
+* only when the execution should not continue any further. It is not recommended
-* recommended to call this function very often and try to handle as many errors
+* to call this function very often, and try to handle as many errors as possible
-* as possible silently.
+* silently or more gracefully.
+*
+* As a shorthand, the desired HTTP response code may be passed as an integer to
+* the `$title` parameter (the default title would apply) or the `$args` parameter.
 *
 * @since 2.0.4
-*
+* @since 4.1.0 The `$title` and `$args` parameters were changed to optionally accept
-* @param string $message Error message.
+*              an integer to be used as the response code.
-* @param string $title Error title.
+*
-* @param string|array $args Optional arguments to control behavior.
+* @param string|WP_Error  $message Optional. Error message. If this is a {@see WP_Error} object,
+*                                  the error's messages are used. Default empty.
+* @param string|int       $title   Optional. Error title. If `$message` is a `WP_Error` object,
+*                                  error data with the key 'title' may be used to specify the title.
+*                                  If `$title` is an integer, then it is treated as the response
+*                                  code. Default empty.
+* @param string|array|int $args {
+*     Optional. Arguments to control behavior. If `$args` is an integer, then it is treated
+*     as the response code. Default empty array.
+*
+*     @type int    $response       The HTTP response code. Default 500.
+*     @type bool   $back_link      Whether to include a link to go back. Default false.
+*     @type string $text_direction The text direction. This is only useful internally, when WordPress
+*                                  is still loading and the site's locale is not set up yet. Accepts 'rtl'.
+*                                  Default is the value of {@see is_rtl()}.
+* }
 */
 function wp_die( $message = '', $title = '', $args = array() ) {
-	if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
+	if ( is_int( $args ) ) {
+		$args = array( 'response' => $args );
+	} elseif ( is_int( $title ) ) {
+		$args  = array( 'response' => $title );
+		$title = '';
+	}
+	if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
+		/**
+		 * Filter callback for killing WordPress execution for AJAX requests.
+		 *
+		 * @since 3.4.0
+		 *
+		 * @param callback $function Callback function name.
+		 */
 		$function = apply_filters( 'wp_die_ajax_handler', '_ajax_wp_die_handler' );
-	elseif ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
+	} elseif ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) {
+		/**
+		 * Filter callback for killing WordPress execution for XML-RPC requests.
+		 *
+		 * @since 3.4.0
+		 *
+		 * @param callback $function Callback function name.
+		 */
 		$function = apply_filters( 'wp_die_xmlrpc_handler', '_xmlrpc_wp_die_handler' );
-	else
+	} else {
+		/**
+		 * Filter callback for killing WordPress execution for all non-AJAX, non-XML-RPC requests.
+		 *
+		 * @since 3.0.0
+		 *
+		 * @param callback $function Callback function name.
+		 */
 		$function = apply_filters( 'wp_die_handler', '_default_wp_die_handler' );
+	}
 	call_user_func( $function, $message, $title, $args );
 }
 /**
 * site then you can overload using the wp_die_handler filter in wp_die
 *
 * @since 3.0.0
 * @access private
 *
-* @param string $message Error message.
+* @param string       $message Error message.
-* @param string $title Error title.
+* @param string       $title   Optional. Error title. Default empty.
-* @param string|array $args Optional arguments to control behavior.
+* @param string|array $args    Optional. Arguments to control behavior. Default empty array.
 */
 function _default_wp_die_handler( $message, $title = '', $args = array() ) {
 	$defaults = array( 'response' => 500 );
 	$r = wp_parse_args($args, $defaults);
 			$error_data = $message->get_error_data();
 			if ( is_array( $error_data ) && isset( $error_data['title'] ) )
 				$title = $error_data['title'];
 		}
 		$errors = $message->get_error_messages();
-		switch ( count( $errors ) ) :
+		switch ( count( $errors ) ) {
 		case 0 :
 			$message = '';
 			break;
 		case 1 :
 			$message = "<p>{$errors[0]}</p>";
 			break;
 		default :
 			$message = "<ul>\n\t\t<li>" . join( "</li>\n\t\t<li>", $errors ) . "</li>\n\t</ul>";
 			break;
-		endswitch;
+		}
 	} elseif ( is_string( $message ) ) {
 		$message = "<p>$message</p>";
 	}
 	if ( isset( $r['back_link'] ) && $r['back_link'] ) {
 <head>
 	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 	<title><?php echo $title ?></title>
 	<style type="text/css">
 		html {
-			background: #f9f9f9;
+			background: #f1f1f1;
 		}
 		body {
 			background: #fff;
-			color: #333;
+			color: #444;
-			font-family: sans-serif;
+			font-family: "Open Sans", sans-serif;
 			margin: 2em auto;
 			padding: 1em 2em;
-			-webkit-border-radius: 3px;
-			border-radius: 3px;
-			border: 1px solid #dfdfdf;
 			max-width: 700px;
+			-webkit-box-shadow: 0 1px 3px rgba(0,0,0,0.13);
+			box-shadow: 0 1px 3px rgba(0,0,0,0.13);
 		}
 		h1 {
 			border-bottom: 1px solid #dadada;
 			clear: both;
 			color: #666;
-			font: 24px Georgia, "Times New Roman", Times, serif;
+			font: 24px "Open Sans", sans-serif;
 			margin: 30px 0 0 0;
 			padding: 0;
 			padding-bottom: 7px;
 		}
 		#error-page {
 		}
 		a:hover {
 			color: #D54E21;
 		}
 		.button {
+			background: #f7f7f7;
+			border: 1px solid #cccccc;
+			color: #555;
 			display: inline-block;
 			text-decoration: none;
-			font-size: 14px;
+			font-size: 13px;
-			line-height: 23px;
+			line-height: 26px;
-			height: 24px;
+			height: 28px;
 			margin: 0;
 			padding: 0 10px 1px;
 			cursor: pointer;
-			border-width: 1px;
-			border-style: solid;
 			-webkit-border-radius: 3px;
+			-webkit-appearance: none;
 			border-radius: 3px;
 			white-space: nowrap;
 			-webkit-box-sizing: border-box;
 			-moz-box-sizing:    border-box;
 			box-sizing:         border-box;
-			background: #f3f3f3;
-			background-image: -webkit-gradient(linear, left top, left bottom, from(#fefefe), to(#f4f4f4));
+			-webkit-box-shadow: inset 0 1px 0 #fff, 0 1px 0 rgba(0,0,0,.08);
-			background-image: -webkit-linear-gradient(top, #fefefe, #f4f4f4);
+			box-shadow: inset 0 1px 0 #fff, 0 1px 0 rgba(0,0,0,.08);
-			background-image:    -moz-linear-gradient(top, #fefefe, #f4f4f4);
+		 	vertical-align: top;
-			background-image:      -o-linear-gradient(top, #fefefe, #f4f4f4);
-			background-image:   linear-gradient(to bottom, #fefefe, #f4f4f4);
-			border-color: #bbb;
-		 	color: #333;
-			text-shadow: 0 1px 0 #fff;
 		}
 		.button.button-large {
 			height: 29px;
 			line-height: 28px;
 			padding: 0 12px;
 		}
 		.button:hover,
 		.button:focus {
-			background: #f3f3f3;
+			background: #fafafa;
-			background-image: -webkit-gradient(linear, left top, left bottom, from(#fff), to(#f3f3f3));
-			background-image: -webkit-linear-gradient(top, #fff, #f3f3f3);
-			background-image:    -moz-linear-gradient(top, #fff, #f3f3f3);
-			background-image:     -ms-linear-gradient(top, #fff, #f3f3f3);
-			background-image:      -o-linear-gradient(top, #fff, #f3f3f3);
-			background-image:   linear-gradient(to bottom, #fff, #f3f3f3);
 			border-color: #999;
 			color: #222;
 		}
 		.button:focus  {
 			-webkit-box-shadow: 1px 1px 1px rgba(0,0,0,.2);
 			box-shadow: 1px 1px 1px rgba(0,0,0,.2);
 		}
 		.button:active {
-			outline: none;
 			background: #eee;
-			background-image: -webkit-gradient(linear, left top, left bottom, from(#f4f4f4), to(#fefefe));
-			background-image: -webkit-linear-gradient(top, #f4f4f4, #fefefe);
-			background-image:    -moz-linear-gradient(top, #f4f4f4, #fefefe);
-			background-image:     -ms-linear-gradient(top, #f4f4f4, #fefefe);
-			background-image:      -o-linear-gradient(top, #f4f4f4, #fefefe);
-			background-image:   linear-gradient(to bottom, #f4f4f4, #fefefe);
 			border-color: #999;
 			color: #333;
-			text-shadow: 0 -1px 0 #fff;
 			-webkit-box-shadow: inset 0 2px 5px -3px rgba( 0, 0, 0, 0.5 );
 		 	box-shadow: inset 0 2px 5px -3px rgba( 0, 0, 0, 0.5 );
 		}
 		<?php if ( 'rtl' == $text_direction ) : ?>
 * This is the handler for wp_die when processing XMLRPC requests.
 *
 * @since 3.2.0
 * @access private
 *
-* @param string $message Error message.
+* @param string       $message Error message.
-* @param string $title Error title.
+* @param string       $title   Optional. Error title. Default empty.
-* @param string|array $args Optional arguments to control behavior.
+* @param string|array $args    Optional. Arguments to control behavior. Default empty array.
 */
 function _xmlrpc_wp_die_handler( $message, $title = '', $args = array() ) {
 	global $wp_xmlrpc_server;
 	$defaults = array( 'response' => 500 );
 * This is the handler for wp_die when processing Ajax requests.
 *
 * @since 3.4.0
 * @access private
 *
-* @param string $message Optional. Response to print.
+* @param string $message Optional. Response to print. Default empty.
 */
 function _ajax_wp_die_handler( $message = '' ) {
 	if ( is_scalar( $message ) )
 		die( (string) $message );
 	die( '0' );
 * This is the handler for wp_die when processing APP requests.
 *
 * @since 3.4.0
 * @access private
 *
-* @param string $message Optional. Response to print.
+* @param string $message Optional. Response to print. Default empty.
 */
 function _scalar_wp_die_handler( $message = '' ) {
 	if ( is_scalar( $message ) )
 		die( (string) $message );
 	die();
 }
 /**
+* Encode a variable into JSON, with some sanity checks.
+*
+* @since 4.1.0
+*
+* @param mixed $data    Variable (usually an array or object) to encode as JSON.
+* @param int   $options Optional. Options to be passed to json_encode(). Default 0.
+* @param int   $depth   Optional. Maximum depth to walk through $data. Must be
+*                       greater than 0. Default 512.
+* @return bool|string The JSON encoded string, or false if it cannot be encoded.
+*/
+function wp_json_encode( $data, $options = 0, $depth = 512 ) {
+	/*
+	 * json_encode() has had extra params added over the years.
+	 * $options was added in 5.3, and $depth in 5.5.
+	 * We need to make sure we call it with the correct arguments.
+	 */
+	if ( version_compare( PHP_VERSION, '5.5', '>=' ) ) {
+		$args = array( $data, $options, $depth );
+	} elseif ( version_compare( PHP_VERSION, '5.3', '>=' ) ) {
+		$args = array( $data, $options );
+	} else {
+		$args = array( $data );
+	}
+	$json = call_user_func_array( 'json_encode', $args );
+	// If json_encode() was successful, no need to do more sanity checking.
+	// ... unless we're in an old version of PHP, and json_encode() returned
+	// a string containing 'null'. Then we need to do more sanity checking.
+	if ( false !== $json && ( version_compare( PHP_VERSION, '5.5', '>=' ) || false === strpos( $json, 'null' ) ) )  {
+		return $json;
+	}
+	try {
+		$args[0] = _wp_json_sanity_check( $data, $depth );
+	} catch ( Exception $e ) {
+		return false;
+	}
+	return call_user_func_array( 'json_encode', $args );
+}
+/**
+* Perform sanity checks on data that shall be encoded to JSON.
+*
+* @ignore
+* @since 4.1.0
+* @access private
+*
+* @see wp_json_encode()
+*
+* @param mixed $data  Variable (usually an array or object) to encode as JSON.
+* @param int   $depth Maximum depth to walk through $data. Must be greater than 0.
+* @return mixed The sanitized data that shall be encoded to JSON.
+*/
+function _wp_json_sanity_check( $data, $depth ) {
+	if ( $depth < 0 ) {
+		throw new Exception( 'Reached depth limit' );
+	}
+	if ( is_array( $data ) ) {
+		$output = array();
+		foreach ( $data as $id => $el ) {
+			// Don't forget to sanitize the ID!
+			if ( is_string( $id ) ) {
+				$clean_id = _wp_json_convert_string( $id );
+			} else {
+				$clean_id = $id;
+			}
+			// Check the element type, so that we're only recursing if we really have to.
+			if ( is_array( $el ) || is_object( $el ) ) {
+				$output[ $clean_id ] = _wp_json_sanity_check( $el, $depth - 1 );
+			} elseif ( is_string( $el ) ) {
+				$output[ $clean_id ] = _wp_json_convert_string( $el );
+			} else {
+				$output[ $clean_id ] = $el;
+			}
+		}
+	} elseif ( is_object( $data ) ) {
+		$output = new stdClass;
+		foreach ( $data as $id => $el ) {
+			if ( is_string( $id ) ) {
+				$clean_id = _wp_json_convert_string( $id );
+			} else {
+				$clean_id = $id;
+			}
+			if ( is_array( $el ) || is_object( $el ) ) {
+				$output->$clean_id = _wp_json_sanity_check( $el, $depth - 1 );
+			} elseif ( is_string( $el ) ) {
+				$output->$clean_id = _wp_json_convert_string( $el );
+			} else {
+				$output->$clean_id = $el;
+			}
+		}
+	} elseif ( is_string( $data ) ) {
+		return _wp_json_convert_string( $data );
+	} else {
+		return $data;
+	}
+	return $output;
+}
+/**
+* Convert a string to UTF-8, so that it can be safely encoded to JSON.
+*
+* @ignore
+* @since 4.1.0
+* @access private
+*
+* @see _wp_json_sanity_check()
+*
+* @param string $string The string which is to be converted.
+* @return string The checked string.
+*/
+function _wp_json_convert_string( $string ) {
+	static $use_mb = null;
+	if ( is_null( $use_mb ) ) {
+		$use_mb = function_exists( 'mb_convert_encoding' );
+	}
+	if ( $use_mb ) {
+		$encoding = mb_detect_encoding( $string, mb_detect_order(), true );
+		if ( $encoding ) {
+			return mb_convert_encoding( $string, 'UTF-8', $encoding );
+		} else {
+			return mb_convert_encoding( $string, 'UTF-8', 'UTF-8' );
+		}
+	} else {
+		return wp_check_invalid_utf8( $string, true );
+	}
+}
+/**
 * Send a JSON response back to an Ajax request.
 *
 * @since 3.5.0
 *
-* @param mixed $response Variable (usually an array or object) to encode as JSON, then print and die.
+* @param mixed $response Variable (usually an array or object) to encode as JSON,
+*                        then print and die.
 */
 function wp_send_json( $response ) {
 	@header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) );
-	echo json_encode( $response );
+	echo wp_json_encode( $response );
 	if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
 		wp_die();
 	else
 		die;
 }
 }
 /**
 * Send a JSON response back to an Ajax request, indicating failure.
 *
+* If the `$data` parameter is a {@see WP_Error} object, the errors
+* within the object are processed and output as an array of error
+* codes and corresponding messages. All other types are output
+* without further processing.
+*
 * @since 3.5.0
+* @since 4.1.0 The `$data` parameter is now processed if a {@see WP_Error}
+*              object is passed in.
 *
 * @param mixed $data Data to encode as JSON, then print and die.
 */
 function wp_send_json_error( $data = null ) {
 	$response = array( 'success' => false );
-	if ( isset( $data ) )
+	if ( isset( $data ) ) {
-		$response['data'] = $data;
+		if ( is_wp_error( $data ) ) {
+			$result = array();
+			foreach ( $data->errors as $code => $messages ) {
+				foreach ( $messages as $message ) {
+					$result[] = array( 'code' => $code, 'message' => $message );
+				}
+			}
+			$response['data'] = $result;
+		} else {
+			$response['data'] = $data;
+		}
+	}
 	wp_send_json( $response );
 }
 /**
 * Retrieve the WordPress home page URL.
 *
-* If the constant named 'WP_HOME' exists, then it will be used and returned by
+* If the constant named 'WP_HOME' exists, then it will be used and returned
-* the function. This can be used to counter the redirection on your local
+* by the function. This can be used to counter the redirection on your local
 * development environment.
 *
+* @since 2.2.0
 * @access private
-* @package WordPress
+*
-* @since 2.2.0
+* @see WP_HOME
 *
-* @param string $url URL for the home location
+* @param string $url URL for the home location.
 * @return string Homepage location.
 */
 function _config_wp_home( $url = '' ) {
 	if ( defined( 'WP_HOME' ) )
 		return untrailingslashit( WP_HOME );
 /**
 * Retrieve the WordPress site URL.
 *
 * If the constant named 'WP_SITEURL' is defined, then the value in that
-* constant will always be returned. This can be used for debugging a site on
+* constant will always be returned. This can be used for debugging a site
-* your localhost while not having to change the database to your URL.
+* on your localhost while not having to change the database to your URL.
 *
+* @since 2.2.0
 * @access private
-* @package WordPress
+*
-* @since 2.2.0
+* @see WP_SITEURL
 *
 * @param string $url URL to set the WordPress site location.
-* @return string The WordPress Site URL
+* @return string The WordPress Site URL.
 */
 function _config_wp_siteurl( $url = '' ) {
 	if ( defined( 'WP_SITEURL' ) )
 		return untrailingslashit( WP_SITEURL );
 	return $url;
 }
 /**
 * Set the localized direction for MCE plugin.
 *
-* Will only set the direction to 'rtl', if the WordPress locale has the text
+* Will only set the direction to 'rtl', if the WordPress locale has
-* direction set to 'rtl'.
+* the text direction set to 'rtl'.
 *
-* Fills in the 'directionality', 'plugins', and 'theme_advanced_button1' array
+* Fills in the 'directionality' setting, enables the 'directionality'
-* keys. These keys are then returned in the $input array.
+* plugin, and adds the 'ltr' button to 'toolbar1', formerly
-*
+* 'theme_advanced_buttons1' array keys. These keys are then returned
+* in the $input (TinyMCE settings) array.
+*
+* @since 2.1.0
 * @access private
-* @package WordPress
+*
-* @subpackage MCE
+* @param array $input MCE settings array.
-* @since 2.1.0
-*
-* @param array $input MCE plugin array.
 * @return array Direction set for 'rtl', if needed by locale.
 */
 function _mce_set_direction( $input ) {
 	if ( is_rtl() ) {
 		$input['directionality'] = 'rtl';
-		$input['plugins'] .= ',directionality';
-		$input['theme_advanced_buttons1'] .= ',ltr';
+		if ( ! empty( $input['plugins'] ) && strpos( $input['plugins'], 'directionality' ) === false ) {
+			$input['plugins'] .= ',directionality';
+		}
+		if ( ! empty( $input['toolbar1'] ) && ! preg_match( '/\bltr\b/', $input['toolbar1'] ) ) {
+			$input['toolbar1'] .= ',ltr';
+		}
 	}
 	return $input;
 }
 /**
 * Convert smiley code to the icon graphic file equivalent.
 *
 * You can turn off smilies, by going to the write setting screen and unchecking
 * the description. Probably should create a Codex page for it, so that it is
 * available.
 *
 * @global array $wpsmiliestrans
 * @global array $wp_smiliessearch
+*
 * @since 2.2.0
 */
 function smilies_init() {
 	global $wpsmiliestrans, $wp_smiliessearch;
 	if ( !get_option( 'use_smilies' ) )
 		return;
 	if ( !isset( $wpsmiliestrans ) ) {
 		$wpsmiliestrans = array(
-		':mrgreen:' => 'icon_mrgreen.gif',
+		':mrgreen:' => 'mrgreen.png',
-		':neutral:' => 'icon_neutral.gif',
+		':neutral:' => "\xf0\x9f\x98\x90",
-		':twisted:' => 'icon_twisted.gif',
+		':twisted:' => "\xf0\x9f\x98\x88",
-		  ':arrow:' => 'icon_arrow.gif',
+		  ':arrow:' => "\xe2\x9e\xa1",
-		  ':shock:' => 'icon_eek.gif',
+		  ':shock:' => "\xf0\x9f\x98\xaf",
-		  ':smile:' => 'icon_smile.gif',
+		  ':smile:' => 'simple-smile.png',
-		    ':???:' => 'icon_confused.gif',
+		    ':???:' => "\xf0\x9f\x98\x95",
-		   ':cool:' => 'icon_cool.gif',
+		   ':cool:' => "\xf0\x9f\x98\x8e",
-		   ':evil:' => 'icon_evil.gif',
+		   ':evil:' => "\xf0\x9f\x91\xbf",
-		   ':grin:' => 'icon_biggrin.gif',
+		   ':grin:' => "\xf0\x9f\x98\x80",
-		   ':idea:' => 'icon_idea.gif',
+		   ':idea:' => "\xf0\x9f\x92\xa1",
-		   ':oops:' => 'icon_redface.gif',
+		   ':oops:' => "\xf0\x9f\x98\xb3",
-		   ':razz:' => 'icon_razz.gif',
+		   ':razz:' => "\xf0\x9f\x98\x9b",
-		   ':roll:' => 'icon_rolleyes.gif',
+		   ':roll:' => 'rolleyes.png',
-		   ':wink:' => 'icon_wink.gif',
+		   ':wink:' => "\xf0\x9f\x98\x89",
-		    ':cry:' => 'icon_cry.gif',
+		    ':cry:' => "\xf0\x9f\x98\xa5",
-		    ':eek:' => 'icon_surprised.gif',
+		    ':eek:' => "\xf0\x9f\x98\xae",
-		    ':lol:' => 'icon_lol.gif',
+		    ':lol:' => "\xf0\x9f\x98\x86",
-		    ':mad:' => 'icon_mad.gif',
+		    ':mad:' => "\xf0\x9f\x98\xa1",
-		    ':sad:' => 'icon_sad.gif',
+		    ':sad:' => 'frownie.png',
-		      '8-)' => 'icon_cool.gif',
+		      '8-)' => "\xf0\x9f\x98\x8e",
-		      '8-O' => 'icon_eek.gif',
+		      '8-O' => "\xf0\x9f\x98\xaf",
-		      ':-(' => 'icon_sad.gif',
+		      ':-(' => 'frownie.png',
-		      ':-)' => 'icon_smile.gif',
+		      ':-)' => 'simple-smile.png',
-		      ':-?' => 'icon_confused.gif',
+		      ':-?' => "\xf0\x9f\x98\x95",
-		      ':-D' => 'icon_biggrin.gif',
+		      ':-D' => "\xf0\x9f\x98\x80",
-		      ':-P' => 'icon_razz.gif',
+		      ':-P' => "\xf0\x9f\x98\x9b",
-		      ':-o' => 'icon_surprised.gif',
+		      ':-o' => "\xf0\x9f\x98\xae",
-		      ':-x' => 'icon_mad.gif',
+		      ':-x' => "\xf0\x9f\x98\xa1",
-		      ':-|' => 'icon_neutral.gif',
+		      ':-|' => "\xf0\x9f\x98\x90",
-		      ';-)' => 'icon_wink.gif',
+		      ';-)' => "\xf0\x9f\x98\x89",
 		// This one transformation breaks regular text with frequency.
-		//     '8)' => 'icon_cool.gif',
+		//     '8)' => "\xf0\x9f\x98\x8e",
-		       '8O' => 'icon_eek.gif',
+		       '8O' => "\xf0\x9f\x98\xaf",
-		       ':(' => 'icon_sad.gif',
+		       ':(' => 'frownie.png',
-		       ':)' => 'icon_smile.gif',
+		       ':)' => 'simple-smile.png',
-		       ':?' => 'icon_confused.gif',
+		       ':?' => "\xf0\x9f\x98\x95",
-		       ':D' => 'icon_biggrin.gif',
+		       ':D' => "\xf0\x9f\x98\x80",
-		       ':P' => 'icon_razz.gif',
+		       ':P' => "\xf0\x9f\x98\x9b",
-		       ':o' => 'icon_surprised.gif',
+		       ':o' => "\xf0\x9f\x98\xae",
-		       ':x' => 'icon_mad.gif',
+		       ':x' => "\xf0\x9f\x98\xa1",
-		       ':|' => 'icon_neutral.gif',
+		       ':|' => "\xf0\x9f\x98\x90",
-		       ';)' => 'icon_wink.gif',
+		       ';)' => "\xf0\x9f\x98\x89",
-		      ':!:' => 'icon_exclaim.gif',
+		      ':!:' => "\xe2\x9d\x97",
-		      ':?:' => 'icon_question.gif',
+		      ':?:' => "\xe2\x9d\x93",
 		);
 	}
 	if (count($wpsmiliestrans) == 0) {
 		return;
 	 * we match the longest possible smilie (:???: vs :?) as the regular
 	 * expression used below is first-match
 	 */
 	krsort($wpsmiliestrans);
-	$wp_smiliessearch = '/(?:\s|^)';
+	$spaces = wp_spaces_regexp();
+	// Begin first "subpattern"
+	$wp_smiliessearch = '/(?<=' . $spaces . '|^)';
 	$subchar = '';
 	foreach ( (array) $wpsmiliestrans as $smiley => $img ) {
 		$firstchar = substr($smiley, 0, 1);
 		$rest = substr($smiley, 1);
 		// new subpattern?
 		if ($firstchar != $subchar) {
 			if ($subchar != '') {
-				$wp_smiliessearch .= ')|(?:\s|^)';
+				$wp_smiliessearch .= ')(?=' . $spaces . '|$)';  // End previous "subpattern"
+				$wp_smiliessearch .= '|(?<=' . $spaces . '|^)'; // Begin another "subpattern"
 			}
 			$subchar = $firstchar;
 			$wp_smiliessearch .= preg_quote($firstchar, '/') . '(?:';
 		} else {
 			$wp_smiliessearch .= '|';
 		}
 		$wp_smiliessearch .= preg_quote($rest, '/');
 	}
-	$wp_smiliessearch .= ')(?:\s|$)/m';
+	$wp_smiliessearch .= ')(?=' . $spaces . '|$)/m';
 }
 /**
 * Merge user defined arguments into defaults array.
 *
 * This function is used throughout WordPress to allow for both string or array
 * to be merged into another array.
 *
 * @since 2.2.0
 *
-* @param string|array $args Value to merge with $defaults
+* @param string|array $args     Value to merge with $defaults
-* @param array $defaults Array that serves as the defaults.
+* @param array        $defaults Optional. Array that serves as the defaults. Default empty.
 * @return array Merged user defined values with defaults.
 */
 function wp_parse_args( $args, $defaults = '' ) {
 	if ( is_object( $args ) )
 		$r = get_object_vars( $args );
 /**
 * Clean up an array, comma- or space-separated list of IDs.
 *
 * @since 3.0.0
 *
-* @param array|string $list
+* @param array|string $list List of ids.
-* @return array Sanitized array of IDs
+* @return array Sanitized array of IDs.
 */
 function wp_parse_id_list( $list ) {
 	if ( !is_array($list) )
 		$list = preg_split('/[\s,]+/', $list);
 /**
 * Extract a slice of an array, given a list of keys.
 *
 * @since 3.1.0
 *
-* @param array $array The original array
+* @param array $array The original array.
-* @param array $keys The list of keys
+* @param array $keys  The list of keys.
-* @return array The array slice
+* @return array The array slice.
 */
 function wp_array_slice_assoc( $array, $keys ) {
 	$slice = array();
 	foreach ( $keys as $key )
 		if ( isset( $array[ $key ] ) )
 /**
 * Filters a list of objects, based on a set of key => value arguments.
 *
 * @since 3.0.0
 *
-* @param array $list An array of objects to filter
+* @param array       $list     An array of objects to filter
-* @param array $args An array of key => value arguments to match against each object
+* @param array       $args     Optional. An array of key => value arguments to match
-* @param string $operator The logical operation to perform. 'or' means only one element
+*                              against each object. Default empty array.
-*	from the array needs to match; 'and' means all elements must match. The default is 'and'.
+* @param string      $operator Optional. The logical operation to perform. 'or' means
-* @param bool|string $field A field from the object to place instead of the entire object
+*                              only one element from the array needs to match; 'and'
-* @return array A list of objects or object fields
+*                              means all elements must match. Default 'and'.
+* @param bool|string $field    A field from the object to place instead of the entire object.
+*                              Default false.
+* @return array A list of objects or object fields.
 */
 function wp_filter_object_list( $list, $args = array(), $operator = 'and', $field = false ) {
 	if ( ! is_array( $list ) )
 		return array();
 /**
 * Filters a list of objects, based on a set of key => value arguments.
 *
 * @since 3.1.0
 *
-* @param array $list An array of objects to filter
+* @param array  $list     An array of objects to filter.
-* @param array $args An array of key => value arguments to match against each object
+* @param array  $args     Optional. An array of key => value arguments to match
-* @param string $operator The logical operation to perform:
+*                         against each object. Default empty array.
-*    'AND' means all elements from the array must match;
+* @param string $operator Optional. The logical operation to perform. 'AND' means
-*    'OR' means only one element needs to match;
+*                         all elements from the array must match. 'OR' means only
-*    'NOT' means no elements may match.
+*                         one element needs to match. 'NOT' means no elements may
-*   The default is 'AND'.
+*                         match. Default 'AND'.
-* @return array
+* @return array Array of found values.
 */
 function wp_list_filter( $list, $args = array(), $operator = 'AND' ) {
 	if ( ! is_array( $list ) )
 		return array();
 }
 /**
 * Pluck a certain field out of each object in a list.
 *
+* This has the same functionality and prototype of
+* array_column() (PHP 5.5) but also supports objects.
+*
 * @since 3.1.0
-*
+* @since 4.0.0 $index_key parameter added.
-* @param array $list A list of objects or arrays
+*
-* @param int|string $field A field from the object to place instead of the entire object
+* @param array      $list      List of objects or arrays
-* @return array
+* @param int|string $field     Field from the object to place instead of the entire object
-*/
+* @param int|string $index_key Optional. Field from the object to use as keys for the new array.
-function wp_list_pluck( $list, $field ) {
+*                              Default null.
-	foreach ( $list as $key => $value ) {
+* @return array Array of found values. If `$index_key` is set, an array of found values with keys
-		if ( is_object( $value ) )
+*               corresponding to `$index_key`. If `$index_key` is null, array keys from the original
-			$list[ $key ] = $value->$field;
+*               `$list` will be preserved in the results.
-		else
+*/
-			$list[ $key ] = $value[ $field ];
+function wp_list_pluck( $list, $field, $index_key = null ) {
-	}
+	if ( ! $index_key ) {
+		/*
-	return $list;
+		 * This is simple. Could at some point wrap array_column()
+		 * if we knew we had an array of arrays.
+		 */
+		foreach ( $list as $key => $value ) {
+			if ( is_object( $value ) ) {
+				$list[ $key ] = $value->$field;
+			} else {
+				$list[ $key ] = $value[ $field ];
+			}
+		}
+		return $list;
+	}
+	/*
+	 * When index_key is not set for a particular item, push the value
+	 * to the end of the stack. This is how array_column() behaves.
+	 */
+	$newlist = array();
+	foreach ( $list as $value ) {
+		if ( is_object( $value ) ) {
+			if ( isset( $value->$index_key ) ) {
+				$newlist[ $value->$index_key ] = $value->$field;
+			} else {
+				$newlist[] = $value->$field;
+			}
+		} else {
+			if ( isset( $value[ $index_key ] ) ) {
+				$newlist[ $value[ $index_key ] ] = $value[ $field ];
+			} else {
+				$newlist[] = $value[ $field ];
+			}
+		}
+	}
+	return $newlist;
 }
 /**
 * Determines if Widgets library should be loaded.
 *
-* Checks to make sure that the widgets library hasn't already been loaded. If
+* Checks to make sure that the widgets library hasn't already been loaded.
-* it hasn't, then it will load the widgets library and run an action hook.
+* If it hasn't, then it will load the widgets library and run an action hook.
 *
 * @since 2.2.0
-* @uses add_action() Calls '_admin_menu' hook with 'wp_widgets_add_menu' value.
 */
 function wp_maybe_load_widgets() {
-	if ( ! apply_filters('load_default_widgets', true) )
+	/**
+	 * Filter whether to load the Widgets library.
+	 *
+	 * Passing a falsey value to the filter will effectively short-circuit
+	 * the Widgets library from loading.
+	 *
+	 * @since 2.8.0
+	 *
+	 * @param bool $wp_maybe_load_widgets Whether to load the Widgets library.
+	 *                                    Default true.
+	 */
+	if ( ! apply_filters( 'load_default_widgets', true ) ) {
 		return;
+	}
 	require_once( ABSPATH . WPINC . '/default-widgets.php' );
 	add_action( '_admin_menu', 'wp_widgets_add_menu' );
 }
 /**
 * Append the Widgets menu to the themes main menu.
 *
 * @since 2.2.0
-* @uses $submenu The administration submenu list.
 */
 function wp_widgets_add_menu() {
 	global $submenu;
 	if ( ! current_theme_supports( 'widgets' ) )
 }
 /**
 * Flush all output buffers for PHP 5.2.
 *
-* Make sure all output buffers are flushed before our singletons our destroyed.
+* Make sure all output buffers are flushed before our singletons are destroyed.
 *
 * @since 2.2.0
 */
 function wp_ob_end_flush_all() {
 	$levels = ob_get_level();
 *
 * This function was backported to WordPress 2.3.2, but originally was added
 * in WordPress 2.5.0.
 *
 * @since 2.3.2
-* @uses $wpdb
+*
+* @global wpdb $wpdb WordPress database abstraction object.
 */
 function dead_db() {
 	global $wpdb;
+	wp_load_translations_early();
 	// Load custom DB error template, if present.
 	if ( file_exists( WP_CONTENT_DIR . '/db-error.php' ) ) {
 		require_once( WP_CONTENT_DIR . '/db-error.php' );
 		die();
 	// Otherwise, be terse.
 	status_header( 500 );
 	nocache_headers();
 	header( 'Content-Type: text/html; charset=utf-8' );
-	wp_load_translations_early();
 ?>
 <!DOCTYPE html>
 <html xmlns="http://www.w3.org/1999/xhtml"<?php if ( is_rtl() ) echo ' dir="rtl"'; ?>>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <?php
 	die();
 }
 /**
-* Converts value to nonnegative integer.
+* Convert a value to non-negative integer.
 *
 * @since 2.5.0
 *
-* @param mixed $maybeint Data you wish to have converted to a nonnegative integer
+* @param mixed $maybeint Data you wish to have converted to a non-negative integer.
-* @return int An nonnegative integer
+* @return int A non-negative integer.
 */
 function absint( $maybeint ) {
 	return abs( intval( $maybeint ) );
 }
 /**
-* Determines if the blog can be accessed over SSL.
+* Mark a function as deprecated and inform when it has been used.
-*
-* Determines if blog can be accessed over SSL by using cURL to access the site
-* using the https in the siteurl. Requires cURL extension to work correctly.
-*
-* @since 2.5.0
-*
-* @param string $url
-* @return bool Whether SSL access is available
-*/
-function url_is_accessable_via_ssl($url)
-{
-	if ( in_array( 'curl', get_loaded_extensions() ) ) {
-		$ssl = set_url_scheme( $url, 'https' );
-		$ch = curl_init();
-		curl_setopt($ch, CURLOPT_URL, $ssl);
-		curl_setopt($ch, CURLOPT_FAILONERROR, true);
-		curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
-		curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
-		curl_exec($ch);
-		$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
-		curl_close ($ch);
-		if ($status == 200 || $status == 401) {
-			return true;
-		}
-	}
-	return false;
-}
-/**
-* Marks a function as deprecated and informs when it has been used.
 *
 * There is a hook deprecated_function_run that will be called that can be used
 * to get the backtrace up to what file and function called the deprecated
 * function.
 *
 * The current behavior is to trigger a user error if WP_DEBUG is true.
 *
 * This function is to be used in every function that is deprecated.
 *
-* @package WordPress
-* @subpackage Debug
 * @since 2.5.0
 * @access private
 *
-* @uses do_action() Calls 'deprecated_function_run' and passes the function name, what to use instead,
+* @param string $function    The function that was called.
-*   and the version the function was deprecated in.
+* @param string $version     The version of WordPress that deprecated the function.
-* @uses apply_filters() Calls 'deprecated_function_trigger_error' and expects boolean value of true to do
+* @param string $replacement Optional. The function that should have been called. Default null.
-*   trigger or false to not trigger error.
-*
-* @param string $function The function that was called
-* @param string $version The version of WordPress that deprecated the function
-* @param string $replacement Optional. The function that should have been called
 */
 function _deprecated_function( $function, $version, $replacement = null ) {
+	/**
+	 * Fires when a deprecated function is called.
+	 *
+	 * @since 2.5.0
+	 *
+	 * @param string $function    The function that was called.
+	 * @param string $replacement The function that should have been called.
+	 * @param string $version     The version of WordPress that deprecated the function.
+	 */
 	do_action( 'deprecated_function_run', $function, $replacement, $version );
-	// Allow plugin to filter the output error trigger
+	/**
+	 * Filter whether to trigger an error for deprecated functions.
+	 *
+	 * @since 2.5.0
+	 *
+	 * @param bool $trigger Whether to trigger the error for deprecated functions. Default true.
+	 */
 	if ( WP_DEBUG && apply_filters( 'deprecated_function_trigger_error', true ) ) {
 		if ( function_exists( '__' ) ) {
 			if ( ! is_null( $replacement ) )
 				trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $function, $version, $replacement ) );
 			else
 		}
 	}
 }
 /**
-* Marks a file as deprecated and informs when it has been used.
+* Mark a file as deprecated and inform when it has been used.
 *
 * There is a hook deprecated_file_included that will be called that can be used
 * to get the backtrace up to what file and function included the deprecated
 * file.
 *
 * The current behavior is to trigger a user error if WP_DEBUG is true.
 *
 * This function is to be used in every file that is deprecated.
 *
-* @package WordPress
-* @subpackage Debug
 * @since 2.5.0
 * @access private
 *
-* @uses do_action() Calls 'deprecated_file_included' and passes the file name, what to use instead,
+* @param string $file        The file that was included.
-*   the version in which the file was deprecated, and any message regarding the change.
+* @param string $version     The version of WordPress that deprecated the file.
-* @uses apply_filters() Calls 'deprecated_file_trigger_error' and expects boolean value of true to do
+* @param string $replacement Optional. The file that should have been included based on ABSPATH.
-*   trigger or false to not trigger error.
+*                            Default null.
-*
+* @param string $message     Optional. A message regarding the change. Default empty.
-* @param string $file The file that was included
-* @param string $version The version of WordPress that deprecated the file
-* @param string $replacement Optional. The file that should have been included based on ABSPATH
-* @param string $message Optional. A message regarding the change
 */
 function _deprecated_file( $file, $version, $replacement = null, $message = '' ) {
+	/**
+	 * Fires when a deprecated file is called.
+	 *
+	 * @since 2.5.0
+	 *
+	 * @param string $file        The file that was called.
+	 * @param string $replacement The file that should have been included based on ABSPATH.
+	 * @param string $version     The version of WordPress that deprecated the file.
+	 * @param string $message     A message regarding the change.
+	 */
 	do_action( 'deprecated_file_included', $file, $replacement, $version, $message );
-	// Allow plugin to filter the output error trigger
+	/**
+	 * Filter whether to trigger an error for deprecated files.
+	 *
+	 * @since 2.5.0
+	 *
+	 * @param bool $trigger Whether to trigger the error for deprecated files. Default true.
+	 */
 	if ( WP_DEBUG && apply_filters( 'deprecated_file_trigger_error', true ) ) {
 		$message = empty( $message ) ? '' : ' ' . $message;
 		if ( function_exists( '__' ) ) {
 			if ( ! is_null( $replacement ) )
 				trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $file, $version, $replacement ) . $message );
 				trigger_error( sprintf( '%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.', $file, $version ) . $message );
 		}
 	}
 }
 /**
-* Marks a function argument as deprecated and informs when it has been used.
+* Mark a function argument as deprecated and inform when it has been used.
 *
 * This function is to be used whenever a deprecated function argument is used.
 * Before this function is called, the argument must be checked for whether it was
 * used by comparing it to its default value or evaluating whether it is empty.
 * For example:
-* <code>
+*
-* if ( !empty($deprecated) )
+*     if ( ! empty( $deprecated ) ) {
-* 	_deprecated_argument( __FUNCTION__, '3.0' );
+*         _deprecated_argument( __FUNCTION__, '3.0' );
-* </code>
+*     }
+*
 *
 * There is a hook deprecated_argument_run that will be called that can be used
 * to get the backtrace up to what file and function used the deprecated
 * argument.
 *
 * The current behavior is to trigger a user error if WP_DEBUG is true.
 *
-* @package WordPress
-* @subpackage Debug
 * @since 3.0.0
 * @access private
 *
-* @uses do_action() Calls 'deprecated_argument_run' and passes the function name, a message on the change,
+* @param string $function The function that was called.
-*   and the version in which the argument was deprecated.
+* @param string $version  The version of WordPress that deprecated the argument used.
-* @uses apply_filters() Calls 'deprecated_argument_trigger_error' and expects boolean value of true to do
+* @param string $message  Optional. A message regarding the change. Default null.
-*   trigger or false to not trigger error.
-*
-* @param string $function The function that was called
-* @param string $version The version of WordPress that deprecated the argument used
-* @param string $message Optional. A message regarding the change.
 */
 function _deprecated_argument( $function, $version, $message = null ) {
+	/**
+	 * Fires when a deprecated argument is called.
+	 *
+	 * @since 3.0.0
+	 *
+	 * @param string $function The function that was called.
+	 * @param string $message  A message regarding the change.
+	 * @param string $version  The version of WordPress that deprecated the argument used.
+	 */
 	do_action( 'deprecated_argument_run', $function, $message, $version );
-	// Allow plugin to filter the output error trigger
+	/**
+	 * Filter whether to trigger an error for deprecated arguments.
+	 *
+	 * @since 3.0.0
+	 *
+	 * @param bool $trigger Whether to trigger the error for deprecated arguments. Default true.
+	 */
 	if ( WP_DEBUG && apply_filters( 'deprecated_argument_trigger_error', true ) ) {
 		if ( function_exists( '__' ) ) {
 			if ( ! is_null( $message ) )
 				trigger_error( sprintf( __('%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s'), $function, $version, $message ) );
 			else
 		}
 	}
 }
 /**
-* Marks something as being incorrectly called.
+* Mark something as being incorrectly called.
 *
 * There is a hook doing_it_wrong_run that will be called that can be used
 * to get the backtrace up to what file and function called the deprecated
 * function.
 *
 * The current behavior is to trigger a user error if WP_DEBUG is true.
 *
-* @package WordPress
-* @subpackage Debug
 * @since 3.1.0
 * @access private
 *
-* @uses do_action() Calls 'doing_it_wrong_run' and passes the function arguments.
-* @uses apply_filters() Calls 'doing_it_wrong_trigger_error' and expects boolean value of true to do
-*   trigger or false to not trigger error.
-*
 * @param string $function The function that was called.
-* @param string $message A message explaining what has been done incorrectly.
+* @param string $message  A message explaining what has been done incorrectly.
-* @param string $version The version of WordPress where the message was added.
+* @param string $version  The version of WordPress where the message was added.
 */
 function _doing_it_wrong( $function, $message, $version ) {
+	/**
+	 * Fires when the given function is being used incorrectly.
+	 *
+	 * @since 3.1.0
+	 *
+	 * @param string $function The function that was called.
+	 * @param string $message  A message explaining what has been done incorrectly.
+	 * @param string $version  The version of WordPress where the message was added.
+	 */
 	do_action( 'doing_it_wrong_run', $function, $message, $version );
-	// Allow plugin to filter the output error trigger
+	/**
+	 * Filter whether to trigger an error for _doing_it_wrong() calls.
+	 *
+	 * @since 3.1.0
+	 *
+	 * @param bool $trigger Whether to trigger the error for _doing_it_wrong() calls. Default true.
+	 */
 	if ( WP_DEBUG && apply_filters( 'doing_it_wrong_trigger_error', true ) ) {
 		if ( function_exists( '__' ) ) {
 			$version = is_null( $version ) ? '' : sprintf( __( '(This message was added in version %s.)' ), $version );
-			$message .= ' ' . __( 'Please see <a href="http://codex.wordpress.org/Debugging_in_WordPress">Debugging in WordPress</a> for more information.' );
+			$message .= ' ' . __( 'Please see <a href="https://codex.wordpress.org/Debugging_in_WordPress">Debugging in WordPress</a> for more information.' );
 			trigger_error( sprintf( __( '%1$s was called <strong>incorrectly</strong>. %2$s %3$s' ), $function, $message, $version ) );
 		} else {
 			$version = is_null( $version ) ? '' : sprintf( '(This message was added in version %s.)', $version );
-			$message .= ' Please see <a href="http://codex.wordpress.org/Debugging_in_WordPress">Debugging in WordPress</a> for more information.';
+			$message .= ' Please see <a href="https://codex.wordpress.org/Debugging_in_WordPress">Debugging in WordPress</a> for more information.';
 			trigger_error( sprintf( '%1$s was called <strong>incorrectly</strong>. %2$s %3$s', $function, $message, $version ) );
 		}
 	}
 }
 /**
 * Is the server running earlier than 1.5.0 version of lighttpd?
 *
 * @since 2.5.0
 *
-* @return bool Whether the server is running lighttpd < 1.5.0
+* @return bool Whether the server is running lighttpd < 1.5.0.
 */
 function is_lighttpd_before_150() {
 	$server_parts = explode( '/', isset( $_SERVER['SERVER_SOFTWARE'] )? $_SERVER['SERVER_SOFTWARE'] : '' );
 	$server_parts[1] = isset( $server_parts[1] )? $server_parts[1] : '';
 	return  'lighttpd' == $server_parts[0] && -1 == version_compare( $server_parts[1], '1.5.0' );
 /**
 * Does the specified module exist in the Apache config?
 *
 * @since 2.5.0
 *
-* @param string $mod e.g. mod_rewrite
+* @param string $mod     The module, e.g. mod_rewrite.
-* @param bool $default The default return value if the module is not found
+* @param bool   $default Optional. The default return value if the module is not found. Default false.
-* @return bool
+* @return bool Whether the specified module is loaded.
 */
 function apache_mod_loaded($mod, $default = false) {
 	global $is_apache;
 	if ( !$is_apache )
 		return false;
-	if ( function_exists('apache_get_modules') ) {
+	if ( function_exists( 'apache_get_modules' ) ) {
 		$mods = apache_get_modules();
 		if ( in_array($mod, $mods) )
 			return true;
-	} elseif ( function_exists('phpinfo') ) {
+	} elseif ( function_exists( 'phpinfo' ) && false === strpos( ini_get( 'disable_functions' ), 'phpinfo' ) ) {
 			ob_start();
 			phpinfo(8);
 			$phpinfo = ob_get_clean();
 			if ( false !== strpos($phpinfo, $mod) )
 				return true;
 /**
 * Check if IIS 7+ supports pretty permalinks.
 *
 * @since 2.8.0
 *
-* @return bool
+* @return bool Whether IIS7 supports permalinks.
 */
 function iis7_supports_permalinks() {
 	global $is_iis7;
 	$supports_permalinks = false;
 		 * Next we check if the URL Rewrite Module 1.1 is loaded and enabled for the web site. When
 		 * URL Rewrite 1.1 is loaded it always sets a server variable called 'IIS_UrlRewriteModule'.
 		 * Lastly we make sure that PHP is running via FastCGI. This is important because if it runs
 		 * via ISAPI then pretty permalinks will not work.
 		 */
-		$supports_permalinks = class_exists('DOMDocument') && isset($_SERVER['IIS_UrlRewriteModule']) && ( php_sapi_name() == 'cgi-fcgi' );
+		$supports_permalinks = class_exists('DOMDocument') && isset($_SERVER['IIS_UrlRewriteModule']) && ( PHP_SAPI == 'cgi-fcgi' );
 	}
-	return apply_filters('iis7_supports_permalinks', $supports_permalinks);
+	/**
+	 * Filter whether IIS 7+ supports pretty permalinks.
+	 *
+	 * @since 2.8.0
+	 *
+	 * @param bool $supports_permalinks Whether IIS7 supports permalinks. Default false.
+	 */
+	return apply_filters( 'iis7_supports_permalinks', $supports_permalinks );
 }
 /**
 * File validates against allowed set of defined rules.
 *
 /**
 * Whether SSL login should be forced.
 *
 * @since 2.6.0
 *
-* @param string|bool $force Optional.
+* @see force_ssl_admin()
+*
+* @param string|bool $force Optional Whether to force SSL login. Default null.
 * @return bool True if forced, false if not forced.
 */
 function force_ssl_login( $force = null ) {
+	return force_ssl_admin( $force );
+}
+/**
+* Whether to force SSL used for the Administration Screens.
+*
+* @since 2.6.0
+*
+* @param string|bool $force Optional. Whether to force SSL in admin screens. Default null.
+* @return bool True if forced, false if not forced.
+*/
+function force_ssl_admin( $force = null ) {
 	static $forced = false;
 	if ( !is_null( $force ) ) {
 		$old_forced = $forced;
 		$forced = $force;
 	return $forced;
 }
 /**
-* Whether to force SSL used for the Administration Screens.
-*
-* @since 2.6.0
-*
-* @param string|bool $force
-* @return bool True if forced, false if not forced.
-*/
-function force_ssl_admin( $force = null ) {
-	static $forced = false;
-	if ( !is_null( $force ) ) {
-		$old_forced = $forced;
-		$forced = $force;
-		return $old_forced;
-	}
-	return $forced;
-}
-/**
 * Guess the URL for the site.
 *
 * Will remove wp-admin links to retrieve only return URLs not in the wp-admin
 * directory.
 *
 * @since 2.6.0
 *
-* @return string
+* @return string The guessed URL.
 */
 function wp_guess_url() {
 	if ( defined('WP_SITEURL') && '' != WP_SITEURL ) {
 		$url = WP_SITEURL;
 	} else {
 				$directory = str_replace( ABSPATH, '', $script_filename_dir );
 				// Strip off the sub directory, and any file/query paramss
 				$path = preg_replace( '#/' . preg_quote( $directory, '#' ) . '/[^/]*$#i', '' , $_SERVER['REQUEST_URI'] );
 			} elseif ( false !== strpos( $abspath_fix, $script_filename_dir ) ) {
 				// Request is hitting a file above ABSPATH
-				$subdirectory = str_replace( $script_filename_dir, '', $abspath_fix );
+				$subdirectory = substr( $abspath_fix, strpos( $abspath_fix, $script_filename_dir ) + strlen( $script_filename_dir ) );
 				// Strip off any file/query params from the path, appending the sub directory to the install
 				$path = preg_replace( '#/[^/]*$#i', '' , $_SERVER['REQUEST_URI'] ) . $subdirectory;
 			} else {
 				$path = $_SERVER['REQUEST_URI'];
 			}
 }
 /**
 * Suspend cache invalidation.
 *
-* Turns cache invalidation on and off. Useful during imports where you don't wont to do invalidations
+* Turns cache invalidation on and off. Useful during imports where you don't wont to do
-* every time a post is inserted. Callers must be sure that what they are doing won't lead to an inconsistent
+* invalidations every time a post is inserted. Callers must be sure that what they are
-* cache when invalidation is suspended.
+* doing won't lead to an inconsistent cache when invalidation is suspended.
 *
 * @since 2.7.0
 *
-* @param bool $suspend Whether to suspend or enable cache invalidation
+* @param bool $suspend Optional. Whether to suspend or enable cache invalidation. Default true.
-* @return bool The current suspend setting
+* @return bool The current suspend setting.
 */
-function wp_suspend_cache_invalidation($suspend = true) {
+function wp_suspend_cache_invalidation( $suspend = true ) {
 	global $_wp_suspend_cache_invalidation;
 	$current_suspend = $_wp_suspend_cache_invalidation;
 	$_wp_suspend_cache_invalidation = $suspend;
 	return $current_suspend;
 }
 /**
-* Whether a site is the main site of the current network.
+* Determine whether a site is the main site of the current network.
 *
 * @since 3.0.0
 *
 * @param int $site_id Optional. Site ID to test. Defaults to current site.
-* @return bool True if $site_id is the main site of the network, or if not running multisite.
+*                     Defaults to current site.
+* @return bool True if $site_id is the main site of the network, or if not
+*              running Multisite.
 */
 function is_main_site( $site_id = null ) {
 	// This is the current network's information; 'site' is old terminology.
 	global $current_site;
 	return (int) $site_id === (int) $current_site->blog_id;
 }
 /**
-* Whether a network is the main network of the multisite install.
+* Determine whether a network is the main network of the Multisite install.
 *
 * @since 3.7.0
 *
 * @param int $network_id Optional. Network ID to test. Defaults to current network.
-* @return bool True if $network_id is the main network, or if not running multisite.
+* @return bool True if $network_id is the main network, or if not running Multisite.
 */
 function is_main_network( $network_id = null ) {
-	global $current_site, $wpdb;
+	global $wpdb;
 	if ( ! is_multisite() )
 		return true;
-	$current_network_id = (int) $current_site->id;
+	$current_network_id = (int) get_current_site()->id;
 	if ( ! $network_id )
 		$network_id = $current_network_id;
 	$network_id = (int) $network_id;
 	return $network_id === $primary_network_id;
 }
 /**
-* Whether global terms are enabled.
+* Determine whether global terms are enabled.
-*
 *
 * @since 3.0.0
-* @package WordPress
+*
-*
+* @return bool True if multisite and global terms enabled.
-* @return bool True if multisite and global terms enabled
 */
 function global_terms_enabled() {
 	if ( ! is_multisite() )
 		return false;
 	static $global_terms = null;
 	if ( is_null( $global_terms ) ) {
+		/**
+		 * Filter whether global terms are enabled.
+		 *
+		 * Passing a non-null value to the filter will effectively short-circuit the function,
+		 * returning the value of the 'global_terms_enabled' site option instead.
+		 *
+		 * @since 3.0.0
+		 *
+		 * @param null $anbled Whether global terms are enabled.
+		 */
 		$filter = apply_filters( 'global_terms_enabled', null );
 		if ( ! is_null( $filter ) )
 			$global_terms = (bool) $filter;
 		else
 			$global_terms = (bool) get_site_option( 'global_terms_enabled', false );
 *
 * Overrides the gmt_offset option if we have a timezone_string available.
 *
 * @since 2.8.0
 *
-* @return float|bool
+* @return float|bool Timezone GMT offset, false otherwise.
 */
 function wp_timezone_override_offset() {
 	if ( !$timezone_string = get_option( 'timezone_string' ) ) {
 		return false;
 	}
 /**
 * Sort-helper for timezones.
 *
 * @since 2.9.0
+* @access private
 *
 * @param array $a
 * @param array $b
 * @return int
 */
 		return strnatcasecmp( $a['t_continent'], $b['t_continent'] );
 	}
 }
 /**
-* Gives a nicely formatted list of timezone strings.
+* Gives a nicely-formatted list of timezone strings.
 *
 * @since 2.9.0
 *
-* @param string $selected_zone Selected Zone
+* @param string $selected_zone Selected timezone.
 * @return string
 */
 function wp_timezone_choice( $selected_zone ) {
 	static $mo_loaded = false;
 	return join( "\n", $structure );
 }
 /**
 * Strip close comment and close php tags from file headers used by WP.
-* See http://core.trac.wordpress.org/ticket/8497
 *
 * @since 2.8.0
-*
+* @access private
-* @param string $str
+*
+* @see https://core.trac.wordpress.org/ticket/8497
+*
+* @param string $str Header comment to clean up.
 * @return string
 */
-function _cleanup_header_comment($str) {
+function _cleanup_header_comment( $str ) {
 	return trim(preg_replace("/\s*(?:\*\/|\?>).*/", '', $str));
 }
 /**
-* Permanently deletes posts, pages, attachments, and comments which have been in the trash for EMPTY_TRASH_DAYS.
+* Permanently delete comments or posts of any type that have held a status
+* of 'trash' for the number of days defined in EMPTY_TRASH_DAYS.
+*
+* The default value of `EMPTY_TRASH_DAYS` is 30 (days).
 *
 * @since 2.9.0
 */
 function wp_scheduled_delete() {
 	global $wpdb;
 * lines, the value will get cut at the end of the first line.
 *
 * If the file data is not within that first 8kiB, then the author should correct
 * their plugin file and move the data headers to the top.
 *
-* @see http://codex.wordpress.org/File_Header
+* @link https://codex.wordpress.org/File_Header
 *
 * @since 2.9.0
-* @param string $file Path to the file
+*
-* @param array $default_headers List of headers, in the format array('HeaderKey' => 'Header Name')
+* @param string $file            Path to the file.
-* @param string $context If specified adds filter hook "extra_{$context}_headers"
+* @param array  $default_headers List of headers, in the format array('HeaderKey' => 'Header Name').
+* @param string $context         Optional. If specified adds filter hook "extra_{$context}_headers".
+*                                Default empty.
+* @return array Array of file headers in `HeaderKey => Header Value` format.
 */
 function get_file_data( $file, $default_headers, $context = '' ) {
 	// We don't need to write to the file, so just open for reading.
 	$fp = fopen( $file, 'r' );
 	fclose( $fp );
 	// Make sure we catch CR-only line endings.
 	$file_data = str_replace( "\r", "\n", $file_data );
+	/**
+	 * Filter extra file headers by context.
+	 *
+	 * The dynamic portion of the hook name, `$context`, refers to
+	 * the context where extra headers might be loaded.
+	 *
+	 * @since 2.9.0
+	 *
+	 * @param array $extra_context_headers Empty array by default.
+	 */
 	if ( $context && $extra_headers = apply_filters( "extra_{$context}_headers", array() ) ) {
 		$extra_headers = array_combine( $extra_headers, $extra_headers ); // keys equal values
 		$all_headers = array_merge( $extra_headers, (array) $default_headers );
 	} else {
 		$all_headers = $default_headers;
 * Returns true.
 *
 * Useful for returning true to filters easily.
 *
 * @since 3.0.0
+*
 * @see __return_false()
-* @return bool true
+*
+* @return bool True.
 */
 function __return_true() {
 	return true;
 }
 * Returns false.
 *
 * Useful for returning false to filters easily.
 *
 * @since 3.0.0
+*
 * @see __return_true()
-* @return bool false
+*
+* @return bool False.
 */
 function __return_false() {
 	return false;
 }
 * Returns 0.
 *
 * Useful for returning 0 to filters easily.
 *
 * @since 3.0.0
-* @see __return_zero()
+*
-* @return int 0
+* @return int 0.
 */
 function __return_zero() {
 	return 0;
 }
 * Returns an empty array.
 *
 * Useful for returning an empty array to filters easily.
 *
 * @since 3.0.0
-* @see __return_zero()
+*
-* @return array Empty array
+* @return array Empty array.
 */
 function __return_empty_array() {
 	return array();
 }
 * Returns null.
 *
 * Useful for returning null to filters easily.
 *
 * @since 3.4.0
-* @return null
+*
+* @return null Null value.
 */
 function __return_null() {
 	return null;
 }
 * Returns an empty string.
 *
 * Useful for returning an empty string to filters easily.
 *
 * @since 3.7.0
+*
 * @see __return_null()
-* @return string Empty string
+*
+* @return string Empty string.
 */
 function __return_empty_string() {
 	return '';
 }
 /**
 * Send a HTTP header to disable content type sniffing in browsers which support it.
 *
-* @link http://blogs.msdn.com/ie/archive/2008/07/02/ie8-security-part-v-comprehensive-protection.aspx
-* @link http://src.chromium.org/viewvc/chrome?view=rev&revision=6985
-*
 * @since 3.0.0
-* @return none
+*
+* @see http://blogs.msdn.com/ie/archive/2008/07/02/ie8-security-part-v-comprehensive-protection.aspx
+* @see http://src.chromium.org/viewvc/chrome?view=rev&revision=6985
 */
 function send_nosniff_header() {
 	@header( 'X-Content-Type-Options: nosniff' );
 }
 /**
-* Returns a MySQL expression for selecting the week number based on the start_of_week option.
+* Return a MySQL expression for selecting the week number based on the start_of_week option.
 *
-* @internal
+* @ignore
 * @since 3.0.0
-* @param string $column
+*
-* @return string
+* @param string $column Database column.
+* @return string SQL clause.
 */
 function _wp_mysql_week( $column ) {
 	switch ( $start_of_week = (int) get_option( 'start_of_week' ) ) {
-	default :
-	case 0 :
-		return "WEEK( $column, 0 )";
 	case 1 :
 		return "WEEK( $column, 1 )";
 	case 2 :
 	case 3 :
 	case 4 :
 	case 5 :
 	case 6 :
 		return "WEEK( DATE_SUB( $column, INTERVAL $start_of_week DAY ), 0 )";
-	}
+	case 0 :
-}
+	default :
+		return "WEEK( $column, 0 )";
-/**
+	}
-* Finds hierarchy loops using a callback function that maps object IDs to parent IDs.
+}
+/**
+* Find hierarchy loops using a callback function that maps object IDs to parent IDs.
 *
 * @since 3.1.0
 * @access private
 *
-* @param callback $callback function that accepts ( ID, $callback_args ) and outputs parent_ID
+* @param callback $callback      Function that accepts ( ID, $callback_args ) and outputs parent_ID.
-* @param int $start The ID to start the loop check at
+* @param int      $start         The ID to start the loop check at.
-* @param int $start_parent the parent_ID of $start to use instead of calling $callback( $start ). Use null to always use $callback
+* @param int      $start_parent  The parent_ID of $start to use instead of calling $callback( $start ).
-* @param array $callback_args optional additional arguments to send to $callback
+*                                Use null to always use $callback
-* @return array IDs of all members of loop
+* @param array    $callback_args Optional. Additional arguments to send to $callback.
+* @return array IDs of all members of loop.
 */
 function wp_find_hierarchy_loop( $callback, $start, $start_parent, $callback_args = array() ) {
 	$override = is_null( $start_parent ) ? array() : array( $start => $start_parent );
 	if ( !$arbitrary_loop_member = wp_find_hierarchy_loop_tortoise_hare( $callback, $start, $override, $callback_args ) )
 	return wp_find_hierarchy_loop_tortoise_hare( $callback, $arbitrary_loop_member, $override, $callback_args, true );
 }
 /**
-* Uses the "The Tortoise and the Hare" algorithm to detect loops.
+* Use the "The Tortoise and the Hare" algorithm to detect loops.
 *
 * For every step of the algorithm, the hare takes two steps and the tortoise one.
 * If the hare ever laps the tortoise, there must be a loop.
 *
 * @since 3.1.0
 * @access private
 *
-* @param callback $callback function that accepts ( ID, callback_arg, ... ) and outputs parent_ID
+* @param callback $callback      Function that accepts ( ID, callback_arg, ... ) and outputs parent_ID.
-* @param int $start The ID to start the loop check at
+* @param int      $start         The ID to start the loop check at.
-* @param array $override an array of ( ID => parent_ID, ... ) to use instead of $callback
+* @param array    $override      Optional. An array of ( ID => parent_ID, ... ) to use instead of $callback.
-* @param array $callback_args optional additional arguments to send to $callback
+*                                Default empty array.
-* @param bool $_return_loop Return loop members or just detect presence of loop?
+* @param array    $callback_args Optional. Additional arguments to send to $callback. Default empty array.
-*             Only set to true if you already know the given $start is part of a loop
+* @param bool     $_return_loop  Optional. Return loop members or just detect presence of loop? Only set
-*             (otherwise the returned array might include branches)
+*                                to true if you already know the given $start is part of a loop (otherwise
-* @return mixed scalar ID of some arbitrary member of the loop, or array of IDs of all members of loop if $_return_loop
+*                                the returned array might include branches). Default false.
+* @return mixed Scalar ID of some arbitrary member of the loop, or array of IDs of all members of loop if
+*               $_return_loop
 */
 function wp_find_hierarchy_loop_tortoise_hare( $callback, $start, $override = array(), $callback_args = array(), $_return_loop = false ) {
 	$tortoise = $hare = $evanescent_hare = $start;
 	$return = array();
 }
 /**
 * Send a HTTP header to limit rendering of pages to same origin iframes.
 *
-* @link https://developer.mozilla.org/en/the_x-frame-options_response_header
-*
 * @since 3.1.3
-* @return none
+*
+* @see https://developer.mozilla.org/en/the_x-frame-options_response_header
 */
 function send_frame_options_header() {
 	@header( 'X-Frame-Options: SAMEORIGIN' );
 }
 /**
 * Retrieve a list of protocols to allow in HTML attributes.
 *
 * @since 3.3.0
+*
 * @see wp_kses()
 * @see esc_url()
 *
-* @return array Array of allowed protocols
+* @return array Array of allowed protocols.
 */
 function wp_allowed_protocols() {
 	static $protocols;
 	if ( empty( $protocols ) ) {
 		$protocols = array( 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'svn', 'tel', 'fax', 'xmpp' );
+		/**
+		 * Filter the list of protocols allowed in HTML attributes.
+		 *
+		 * @since 3.0.0
+		 *
+		 * @param array $protocols Array of allowed protocols e.g. 'http', 'ftp', 'tel', and more.
+		 */
 		$protocols = apply_filters( 'kses_allowed_protocols', $protocols );
 	}
 	return $protocols;
 }
 /**
-* Return a comma separated string of functions that have been called to get to the current point in code.
+* Return a comma-separated string of functions that have been called to get
-*
+* to the current point in code.
-* @link http://core.trac.wordpress.org/ticket/19589
+*
-* @since 3.4
+* @since 3.4.0
 *
-* @param string $ignore_class A class to ignore all function calls within - useful when you want to just give info about the callee
+* @see https://core.trac.wordpress.org/ticket/19589
-* @param int $skip_frames A number of stack frames to skip - useful for unwinding back to the source of the issue
+*
-* @param bool $pretty Whether or not you want a comma separated string or raw array returned
+* @param string $ignore_class Optional. A class to ignore all function calls within - useful
-* @return string|array Either a string containing a reversed comma separated trace or an array of individual calls.
+*                             when you want to just give info about the callee. Default null.
+* @param int    $skip_frames  Optional. A number of stack frames to skip - useful for unwinding
+*                             back to the source of the issue. Default 0.
+* @param bool   $pretty       Optional. Whether or not you want a comma separated string or raw
+*                             array returned. Default true.
+* @return string|array Either a string containing a reversed comma separated trace or an array
+*                      of individual calls.
 */
 function wp_debug_backtrace_summary( $ignore_class = null, $skip_frames = 0, $pretty = true ) {
 	if ( version_compare( PHP_VERSION, '5.2.5', '>=' ) )
 		$trace = debug_backtrace( false );
 	else
 	else
 		return $caller;
 }
 /**
-* Retrieve ids that are not already present in the cache
+* Retrieve ids that are not already present in the cache.
 *
 * @since 3.4.0
-*
+* @access private
-* @param array $object_ids ID list
+*
-* @param string $cache_key The cache bucket to check against
+* @param array  $object_ids ID list.
-*
+* @param string $cache_key  The cache bucket to check against.
-* @return array
+*
+* @return array List of ids not present in the cache.
 */
 function _get_non_cached_ids( $object_ids, $cache_key ) {
 	$clean = array();
 	foreach ( $object_ids as $id ) {
 		$id = (int) $id;
 * Test if the current device has the capability to upload files.
 *
 * @since 3.4.0
 * @access private
 *
-* @return bool true|false
+* @return bool true|false Whether the device is able to upload files.
 */
 function _device_can_upload() {
 	if ( ! wp_is_mobile() )
 		return true;
 }
 /**
 * Test if a given path is a stream URL
 *
-* @param string $path The resource path or URL
+* @param string $path The resource path or URL.
-* @return bool True if the path is a stream URL
+* @return bool True if the path is a stream URL.
 */
 function wp_is_stream( $path ) {
 	$wrappers = stream_get_wrappers();
 	$wrappers_re = '(' . join('|', $wrappers) . ')';
 	return preg_match( "!^$wrappers_re://!", $path ) === 1;
 }
 /**
-* Test if the supplied date is valid for the Gregorian calendar
+* Test if the supplied date is valid for the Gregorian calendar.
 *
 * @since 3.5.0
 *
-* @return bool true|false
+* @see checkdate()
+*
+* @param  int    $month       Month number.
+* @param  int    $day         Day number.
+* @param  int    $year        Year number.
+* @param  string $source_date The date to filter.
+* @return bool True if valid date, false if not valid date.
 */
 function wp_checkdate( $month, $day, $year, $source_date ) {
+	/**
+	 * Filter whether the given date is valid for the Gregorian calendar.
+	 *
+	 * @since 3.5.0
+	 *
+	 * @param bool   $checkdate   Whether the given date is valid.
+	 * @param string $source_date Date to check.
+	 */
 	return apply_filters( 'wp_checkdate', checkdate( $month, $day, $year ), $source_date );
 }
 /**
 * Load the auth check for monitoring whether the user is still logged in.
 	$screen = get_current_screen();
 	$hidden = array( 'update', 'update-network', 'update-core', 'update-core-network', 'upgrade', 'upgrade-network', 'network' );
 	$show = ! in_array( $screen->id, $hidden );
+	/**
+	 * Filter whether to load the authentication check.
+	 *
+	 * Passing a falsey value to the filter will effectively short-circuit
+	 * loading the authentication check.
+	 *
+	 * @since 3.6.0
+	 *
+	 * @param bool      $show   Whether to load the authentication check.
+	 * @param WP_Screen $screen The current screen object.
+	 */
 	if ( apply_filters( 'wp_auth_check_load', $show, $screen ) ) {
 		wp_enqueue_style( 'wp-auth-check' );
 		wp_enqueue_script( 'wp-auth-check' );
 		add_action( 'admin_print_footer_scripts', 'wp_auth_check_html', 5 );
 function wp_auth_check_html() {
 	$login_url = wp_login_url();
 	$current_domain = ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'];
 	$same_domain = ( strpos( $login_url, $current_domain ) === 0 );
-	if ( $same_domain && force_ssl_login() && ! force_ssl_admin() )
+	/**
-		$same_domain = false;
+	 * Filter whether the authentication check originated at the same domain.
+	 *
-	// Let plugins change this if they know better.
+	 * @since 3.6.0
+	 *
+	 * @param bool $same_domain Whether the authentication check originated at the same domain.
+	 */
 	$same_domain = apply_filters( 'wp_auth_check_same_domain', $same_domain );
 	$wrap_class = $same_domain ? 'hidden' : 'hidden fallback';
 	?>
 	<div id="wp-auth-check-wrap" class="<?php echo $wrap_class; ?>">
 *
 * Send a result that shows a log-in box if the user is no longer logged in,
 * or if their cookie is within the grace period.
 *
 * @since 3.6.0
-*/
+*
-function wp_auth_check( $response, $data ) {
+* @param array|object $response  The Heartbeat response object or array.
+* @return array|object $response The Heartbeat response object or array with 'wp-auth-check'
+*                                value set.
+*/
+function wp_auth_check( $response ) {
 	$response['wp-auth-check'] = is_user_logged_in() && empty( $GLOBALS['login_grace_period'] );
 	return $response;
 }
 /**
-* Return RegEx body to liberally match an opening HTML tag that:
+* Return RegEx body to liberally match an opening HTML tag.
+*
+* Matches an opening HTML tag that:
 * 1. Is self-closing or
 * 2. Has no body but has a closing tag of the same name or
 * 3. Contains a body and a closing tag of the same name
 *
-* Note: this RegEx does not balance inner tags and does not attempt to produce valid HTML
+* Note: this RegEx does not balance inner tags and does not attempt
+* to produce valid HTML
 *
 * @since 3.6.0
 *
-* @param string $tag An HTML tag name. Example: 'video'
+* @param string $tag An HTML tag name. Example: 'video'.
-* @return string
+* @return string Tag RegEx.
 */
 function get_tag_regex( $tag ) {
 	if ( empty( $tag ) )
 		return;
 	return sprintf( '<%1$s[^<]*(?:>[\s\S]*<\/%1$s>|\s*\/>)', tag_escape( $tag ) );
 }
 /**
-* Return a canonical form of the provided charset appropriate for passing to PHP
+* Retrieve a canonical form of the provided charset appropriate for passing to PHP
 * functions such as htmlspecialchars() and charset html attributes.
 *
-* @link http://core.trac.wordpress.org/ticket/23688
 * @since 3.6.0
-*
+* @access private
-* @param string A charset name
+*
-* @return string The canonical form of the charset
+* @see https://core.trac.wordpress.org/ticket/23688
+*
+* @param string $charset A charset name.
+* @return string The canonical form of the charset.
 */
 function _canonical_charset( $charset ) {
 	if ( 'UTF-8' === $charset || 'utf-8' === $charset || 'utf8' === $charset ||
 		'UTF8' === $charset )
 		return 'UTF-8';
 	return $charset;
 }
 /**
-* Sets the mbstring internal encoding to a binary safe encoding whne func_overload is enabled.
+* Set the mbstring internal encoding to a binary safe encoding when func_overload
-*
+* is enabled.
-* When mbstring.func_overload is in use for multi-byte encodings, the results from strlen() and
+*
-* similar functions respect the utf8 characters, causing binary data to return incorrect lengths.
+* When mbstring.func_overload is in use for multi-byte encodings, the results from
-*
+* strlen() and similar functions respect the utf8 characters, causing binary data
-* This function overrides the mbstring encoding to a binary-safe encoding, and resets it to the
+* to return incorrect lengths.
-* users expected encoding afterwards through the `reset_mbstring_encoding` function.
+*
-*
+* This function overrides the mbstring encoding to a binary-safe encoding, and
-* It is safe to recursively call this function, however each `mbstring_binary_safe_encoding()`
+* resets it to the users expected encoding afterwards through the
-* call must be followed up with an equal number of `reset_mbstring_encoding()` calls.
+* `reset_mbstring_encoding` function.
+*
+* It is safe to recursively call this function, however each
+* `mbstring_binary_safe_encoding()` call must be followed up with an equal number
+* of `reset_mbstring_encoding()` calls.
+*
+* @since 3.7.0
 *
 * @see reset_mbstring_encoding()
 *
-* @since 3.7.0
+* @param bool $reset Optional. Whether to reset the encoding back to a previously-set encoding.
-*
+*                    Default false.
-* @param bool $reset Whether to reset the encoding back to a previously-set encoding.
 */
 function mbstring_binary_safe_encoding( $reset = false ) {
 	static $encodings = array();
 	static $overloaded = null;
 		mb_internal_encoding( $encoding );
 	}
 }
 /**
-* Resets the mbstring internal encoding to a users previously set encoding.
+* Reset the mbstring internal encoding to a users previously set encoding.
 *
 * @see mbstring_binary_safe_encoding()
 *
 * @since 3.7.0
 */
 function reset_mbstring_encoding() {
 	mbstring_binary_safe_encoding( true );
 }
+/**
+* Filter/validate a variable as a boolean.
+*
+* Alternative to `filter_var( $var, FILTER_VALIDATE_BOOLEAN )`.
+*
+* @since 4.0.0
+*
+* @param mixed $var Boolean value to validate.
+* @return bool Whether the value is validated.
+*/
+function wp_validate_boolean( $var ) {
+	if ( is_bool( $var ) ) {
+		return $var;
+	}
+	if ( is_string( $var ) && 'false' === strtolower( $var ) ) {
+		return false;
+	}
+	return (bool) $var;
+}
+/**
+* Delete a file
+*
+* @since 4.2.0
+*
+* @param string $file The path to the file to delete.
+*/
+function wp_delete_file( $file ) {
+	/**
+	 * Filter the path of the file to delete.
+	 *
+	 * @since 2.1.0
+	 *
+	 * @param string $medium Path to the file to delete.
+	 */
+	$delete = apply_filters( 'wp_delete_file', $file );
+	if ( ! empty( $delete ) ) {
+		@unlink( $delete );
+	}
+}

changeset 5	5e2f62d02dcd
parent 0	d970ebf37754
child 7	cf61fcea0001