X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/5d244c8fd9a27c9f89dd08da2af6fbc67d4fce63..refs/tags/wordpress-4.5:/wp-includes/functions.php diff --git a/wp-includes/functions.php b/wp-includes/functions.php index d903349c..0e720ee1 100644 --- a/wp-includes/functions.php +++ b/wp-includes/functions.php @@ -78,6 +78,8 @@ function current_time( $type, $gmt = 0 ) { * * @since 0.71 * + * @global WP_Locale $wp_locale + * * @param string $dateformatstring Format to display the date. * @param bool|int $unixtimestamp Optional. Unix timestamp. Default false. * @param bool $gmt Optional. Whether to use GMT timezone. Default false. @@ -130,7 +132,7 @@ function date_i18n( $dateformatstring, $unixtimestamp = false, $gmt = false ) { if ( $timezone_string ) { $timezone_object = timezone_open( $timezone_string ); $date_object = date_create( null, $timezone_object ); - foreach( $timezone_formats as $timezone_format ) { + foreach ( $timezone_formats as $timezone_format ) { if ( false !== strpos( $dateformatstring, $timezone_format ) ) { $formatted = date_format( $date_object, $timezone_format ); $dateformatstring = ' '.$dateformatstring; @@ -157,17 +159,70 @@ function date_i18n( $dateformatstring, $unixtimestamp = false, $gmt = false ) { } /** - * Convert integer number to format based on the locale. + * Determines if the date should be declined. + * + * If the locale specifies that month names require a genitive case in certain + * formats (like 'j F Y'), the month name will be replaced with a correct form. + * + * @since 4.4.0 + * + * @param string $date Formatted date string. + * @return string The date, declined if locale specifies it. + */ +function wp_maybe_decline_date( $date ) { + global $wp_locale; + + // i18n functions are not available in SHORTINIT mode + if ( ! function_exists( '_x' ) ) { + return $date; + } + + /* translators: If months in your language require a genitive case, + * translate this to 'on'. Do not translate into your own language. + */ + if ( 'on' === _x( 'off', 'decline months names: on or off' ) ) { + // Match a format like 'j F Y' or 'j. F' + if ( @preg_match( '#^\d{1,2}\.? \w+#u', $date ) ) { + $months = $wp_locale->month; + + foreach ( $months as $key => $month ) { + $months[ $key ] = '#' . $month . '#'; + } + + $date = preg_replace( $months, $wp_locale->month_genitive, $date ); + } + } + + // Used for locale-specific rules + $locale = get_locale(); + + if ( 'ca' === $locale ) { + // " de abril| de agost| de octubre..." -> " d'abril| d'agost| d'octubre..." + $date = preg_replace( '# de ([ao])#i', " d'\\1", $date ); + } + + return $date; +} + +/** + * Convert float number to format based on the locale. * * @since 2.3.0 * - * @param int $number The number to convert based on locale. - * @param int $decimals Optional. Precision of the number of decimal places. Default 0. + * @global WP_Locale $wp_locale + * + * @param float $number The number to convert based on locale. + * @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'] ); + + if ( isset( $wp_locale ) ) { + $formatted = number_format( $number, absint( $decimals ), $wp_locale->number_format['decimal_point'], $wp_locale->number_format['thousands_sep'] ); + } else { + $formatted = number_format( $number, absint( $decimals ) ); + } /** * Filter the number formatted based on the locale. @@ -182,7 +237,7 @@ function number_format_i18n( $number, $decimals = 0 ) { /** * 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. * @@ -201,16 +256,18 @@ function number_format_i18n( $number, $decimals = 0 ) { */ 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) + 'TB' => TB_IN_BYTES, + 'GB' => GB_IN_BYTES, + 'MB' => MB_IN_BYTES, + 'kB' => KB_IN_BYTES, + 'B' => 1, ); - 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; } @@ -249,8 +306,8 @@ function get_weekstartend( $mysqlstring, $start_of_week = '' ) { // The most recent week start day on or before $day. $start = $day - DAY_IN_SECONDS * ( $weekday - $start_of_week ); - // $start + 7 days - 1 second. - $end = $start + 7 * DAY_IN_SECONDS - 1; + // $start + 1 week - 1 second. + $end = $start + WEEK_IN_SECONDS - 1; return compact( 'start', 'end' ); } @@ -378,6 +435,7 @@ function maybe_serialize( $data ) { // Double serialization is required for backward compatibility. // See https://core.trac.wordpress.org/ticket/12930 + // Also the world will end. See WP 3.6.1. if ( is_serialized( $data, false ) ) return serialize( $data ); @@ -487,10 +545,10 @@ function wp_extract_urls( $content ) { * * @since 1.5.0 * - * @see $wpdb + * @global wpdb $wpdb WordPress database abstraction object. * * @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; @@ -524,6 +582,19 @@ function do_enclose( $content, $post_ID ) { } } + /** + * Filter the list of enclosure links before querying the database. + * + * Allows for the addition and/or removal of potential enclosures to save + * to postmeta before checking the database for existing enclosures. + * + * @since 4.4.0 + * + * @param array $post_links An array of enclosure links. + * @param int $post_ID Post ID. + */ + $post_links = apply_filters( 'enclosure_links', $post_links, $post_ID ); + 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, $wpdb->esc_like( $url ) . '%' ) ) ) { @@ -555,62 +626,6 @@ function do_enclose( $content, $post_ID ) { } } -/** - * Perform a HTTP HEAD or GET request. - * - * 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|bool $file_path Optional. File path to write request to. Default 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 ); - - if ( $red > 5 ) - return false; - - $options = array(); - $options['redirection'] = 5; - - if ( false == $file_path ) - $options['method'] = 'HEAD'; - else - $options['method'] = 'GET'; - - $response = wp_safe_remote_request( $url, $options ); - - if ( is_wp_error( $response ) ) - return false; - - $headers = wp_remote_retrieve_headers( $response ); - $headers['response'] = wp_remote_retrieve_response_code( $response ); - - // WP_HTTP no longer follows redirects for HEAD requests. - if ( 'HEAD' == $options['method'] && in_array($headers['response'], array(301, 302)) && isset( $headers['location'] ) ) { - return wp_get_http( $headers['location'], $file_path, ++$red ); - } - - if ( false == $file_path ) - return $headers; - - // GET request - write it to the supplied filename - $out_fp = fopen($file_path, 'w'); - if ( !$out_fp ) - return $headers; - - fwrite( $out_fp, wp_remote_retrieve_body( $response ) ); - fclose($out_fp); - clearstatcache(); - - return $headers; -} - /** * Retrieve HTTP Headers from URL. * @@ -660,8 +675,8 @@ function is_new_day() { * @since 2.3.0 * * @see _http_build_query() Used to build the query - * @see http://us2.php.net/manual/en/function.http-build-query.php for more on what - * http_build_query() does. + * @link http://us2.php.net/manual/en/function.http-build-query.php for more on what + * http_build_query() does. * * @param array $data URL-encode key/value pairs. * @return string URL-encoded string. @@ -700,7 +715,7 @@ function _http_build_query( $data, $prefix = null, $sep = null, $key = '', $urle $k = $key . '%5B' . $k . '%5D'; if ( $v === null ) continue; - elseif ( $v === FALSE ) + elseif ( $v === false ) $v = '0'; if ( is_array($v) || is_object($v) ) @@ -718,22 +733,39 @@ function _http_build_query( $data, $prefix = null, $sep = null, $key = '', $urle } /** - * Retrieve a modified URL query string. + * Retrieves a modified URL query string. * - * You can rebuild the URL and append a new query variable to the URL query by - * using this function. You can also retrieve the full URL with query data. + * You can rebuild the URL and append query variables to the URL query by using this function. + * There are two ways to use this function; either a single key and value, or an associative array. * - * Adding a single key & value or an associative array. Setting a key value to - * an empty string removes the key. Omitting oldquery_or_uri uses the $_SERVER - * value. Additional values provided are expected to be encoded appropriately - * with urlencode() or rawurlencode(). + * Using a single key and value: + * + * add_query_arg( 'key', 'value', 'http://example.com' ); + * + * Using an associative array: + * + * add_query_arg( array( + * 'key1' => 'value1', + * 'key2' => 'value2', + * ), 'http://example.com' ); + * + * Omitting the URL from either use results in the current URL being used + * (the value of `$_SERVER['REQUEST_URI']`). + * + * Values are expected to be encoded appropriately with urlencode() or rawurlencode(). + * + * Setting any query variable's value to boolean false removes the key (see remove_query_arg()). + * + * Important: The return value of add_query_arg() is not escaped by default. Output should be + * late-escaped with esc_url() or similar to help prevent vulnerability to cross-site scripting + * (XSS) attacks. * * @since 1.5.0 * - * @param string|array $param1 Either newkey or an associative_array. - * @param string $param2 Either newvalue or oldquery or URI. - * @param string $param3 Optional. Old query or URI. - * @return string New URL query string. + * @param string|array $key Either a query variable key, or an associative array of query variables. + * @param string $value Optional. Either a query variable value, or a URL to act upon. + * @param string $url Optional. A URL to act upon. + * @return string New URL query string (unescaped). */ function add_query_arg() { $args = func_get_args(); @@ -778,8 +810,9 @@ function add_query_arg() { 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]; - $qs = array_merge( $qs, $kayvees ); + foreach ( $args[0] as $k => $v ) { + $qs[ $k ] = $v; + } } else { $qs[ $args[0] ] = $args[1]; } @@ -798,12 +831,12 @@ function add_query_arg() { } /** - * Removes an item or list from the query string. + * Removes an item or items from a query string. * * @since 1.5.0 * * @param string|array $key Query key or keys to remove. - * @param bool|string $query Optional. When false uses the $_SERVER value. Default false. + * @param bool|string $query Optional. When false uses the current URL. Default false. * @return string New URL query string. */ function remove_query_arg( $key, $query = false ) { @@ -815,6 +848,48 @@ function remove_query_arg( $key, $query = false ) { return add_query_arg( $key, false, $query ); } +/** + * Returns an array of single-use query variable names that can be removed from a URL. + * + * @since 4.4.0 + * + * @return array An array of parameters to remove from the URL. + */ +function wp_removable_query_args() { + $removable_query_args = array( + 'activate', + 'activated', + 'approved', + 'deactivate', + 'deleted', + 'disabled', + 'enabled', + 'error', + 'locked', + 'message', + 'same', + 'saved', + 'settings-updated', + 'skipped', + 'spammed', + 'trashed', + 'unspammed', + 'untrashed', + 'update', + 'updated', + 'wp-post-new-reload', + ); + + /** + * Filter the list of query variables to remove. + * + * @since 4.2.0 + * + * @param array $removable_query_args An array of query variables to remove from a URL. + */ + return apply_filters( 'removable_query_args', $removable_query_args ); +} + /** * Walks the array while sanitizing the contents. * @@ -866,7 +941,11 @@ function wp_remote_fopen( $uri ) { * * @since 2.0.0 * - * @param string $query_vars Default WP_Query arguments. + * @global WP $wp_locale + * @global WP_Query $wp_query + * @global WP_Query $wp_the_query + * + * @param string|array $query_vars Default WP_Query arguments. */ function wp( $query_vars = '' ) { global $wp, $wp_query, $wp_the_query; @@ -881,6 +960,8 @@ function wp( $query_vars = '' ) { * * @since 2.3.0 * + * @global array $wp_header_to_desc + * * @param int $code HTTP status code. * @return string Empty string if not found, or description if found. */ @@ -913,6 +994,7 @@ function get_status_header_desc( $code ) { 305 => 'Use Proxy', 306 => 'Reserved', 307 => 'Temporary Redirect', + 308 => 'Permanent Redirect', 400 => 'Bad Request', 401 => 'Unauthorized', @@ -933,6 +1015,7 @@ function get_status_header_desc( $code ) { 416 => 'Requested Range Not Satisfiable', 417 => 'Expectation Failed', 418 => 'I\'m a teapot', + 421 => 'Misdirected Request', 422 => 'Unprocessable Entity', 423 => 'Locked', 424 => 'Failed Dependency', @@ -940,6 +1023,7 @@ function get_status_header_desc( $code ) { 428 => 'Precondition Required', 429 => 'Too Many Requests', 431 => 'Request Header Fields Too Large', + 451 => 'Unavailable For Legal Reasons', 500 => 'Internal Server Error', 501 => 'Not Implemented', @@ -964,20 +1048,23 @@ function get_status_header_desc( $code ) { * Set HTTP status header. * * @since 2.0.0 + * @since 4.4.0 Added the `$description` parameter. * * @see get_status_header_desc() * - * @param int $code HTTP status code. + * @param int $code HTTP status code. + * @param string $description Optional. A custom description for the HTTP status. */ -function status_header( $code ) { - $description = get_status_header_desc( $code ); +function status_header( $code, $description = '' ) { + if ( ! $description ) { + $description = get_status_header_desc( $code ); + } - if ( empty( $description ) ) + if ( empty( $description ) ) { return; + } - $protocol = $_SERVER['SERVER_PROTOCOL']; - if ( 'HTTP/1.1' != $protocol && 'HTTP/1.0' != $protocol ) - $protocol = 'HTTP/1.0'; + $protocol = wp_get_server_protocol(); $status_header = "$protocol $code $description"; if ( function_exists( 'apply_filters' ) ) @@ -1065,7 +1152,7 @@ function nocache_headers() { } } - foreach( $headers as $name => $field_value ) + foreach ( $headers as $name => $field_value ) @header("{$name}: {$field_value}"); } @@ -1120,7 +1207,7 @@ function bool_from_yn( $yn ) { * * @since 2.1.0 * - * @uses $wp_query Used to tell if the use a comment feed. + * @global WP_Query $wp_query Used to tell if the use a comment feed. */ function do_feed() { global $wp_query; @@ -1133,20 +1220,23 @@ function do_feed() { if ( $feed == '' || $feed == 'feed' ) $feed = get_default_feed(); - $hook = 'do_feed_' . $feed; - if ( ! has_action( $hook ) ) + if ( ! has_action( "do_feed_{$feed}" ) ) { 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. + * The dynamic portion of the hook name, `$feed`, refers to the feed template name. + * Possible values include: 'rdf', 'rss', 'rss2', and 'atom'. * * @since 2.1.0 + * @since 4.4.0 The `$feed` parameter was added. * - * @param bool $is_comment_feed Whether the feed is a comment feed. + * @param bool $is_comment_feed Whether the feed is a comment feed. + * @param string $feed The feed name. */ - do_action( $hook, $wp_query->is_comment_feed ); + do_action( "do_feed_{$feed}", $wp_query->is_comment_feed, $feed ); } /** @@ -1229,6 +1319,7 @@ function do_robots() { $site_url = parse_url( site_url() ); $path = ( !empty( $site_url['path'] ) ) ? $site_url['path'] : ''; $output .= "Disallow: $path/wp-admin/\n"; + $output .= "Allow: $path/wp-admin/admin-ajax.php\n"; } /** @@ -1243,7 +1334,7 @@ function do_robots() { } /** - * Test whether blog is already installed. + * Test whether WordPress is already installed. * * The cache will be checked first. If you have a cache plugin, which saves * the cache values, then this will work. If you use the default WordPress @@ -1255,7 +1346,7 @@ function do_robots() { * * @global wpdb $wpdb WordPress database abstraction object. * - * @return bool Whether the blog is already installed. + * @return bool Whether the site is already installed. */ function is_blog_installed() { global $wpdb; @@ -1268,7 +1359,7 @@ function is_blog_installed() { return true; $suppress = $wpdb->suppress_errors(); - if ( ! defined( 'WP_INSTALLING' ) ) { + if ( ! wp_installing() ) { $alloptions = wp_load_alloptions(); } // If siteurl is not set to autoload, check it specifically @@ -1429,16 +1520,35 @@ function wp_original_referer_field( $echo = true, $jump_back_to = 'current' ) { * @return false|string False on failure. Referer URL on success. */ function wp_get_referer() { - if ( ! function_exists( 'wp_validate_redirect' ) ) + 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'] ) ) - $ref = wp_unslash( $_SERVER['HTTP_REFERER'] ); + } + + $ref = wp_get_raw_referer(); - if ( $ref && $ref !== wp_unslash( $_SERVER['REQUEST_URI'] ) ) + if ( $ref && $ref !== wp_unslash( $_SERVER['REQUEST_URI'] ) && $ref !== home_url() . wp_unslash( $_SERVER['REQUEST_URI'] ) ) { return wp_validate_redirect( $ref, false ); + } + + return false; +} + +/** + * Retrieves unvalidated referer from '_wp_http_referer' or HTTP referer. + * + * Do not use for redirects, use {@see wp_get_referer()} instead. + * + * @since 4.5.0 + * + * @return string|false Referer URL on success, false on failure. + */ +function wp_get_raw_referer() { + if ( ! empty( $_REQUEST['_wp_http_referer'] ) ) { + return wp_unslash( $_REQUEST['_wp_http_referer'] ); + } else if ( ! empty( $_SERVER['HTTP_REFERER'] ) ) { + return wp_unslash( $_SERVER['HTTP_REFERER'] ); + } + return false; } @@ -1469,7 +1579,7 @@ function wp_mkdir_p( $target ) { $wrapper = null; // Strip the protocol. - if( wp_is_stream( $target ) ) { + if ( wp_is_stream( $target ) ) { list( $wrapper, $target ) = explode( '://', $target, 2 ); } @@ -1477,7 +1587,7 @@ function wp_mkdir_p( $target ) { $target = str_replace( '//', '/', $target ); // Put the wrapper back on the target. - if( $wrapper !== null ) { + if ( $wrapper !== null ) { $target = $wrapper . '://' . $target; } @@ -1513,7 +1623,7 @@ function wp_mkdir_p( $target ) { */ if ( $dir_perms != ( $dir_perms & ~umask() ) ) { $folder_parts = explode( '/', substr( $target, strlen( $target_parent ) + 1 ) ); - for ( $i = 1; $i <= count( $folder_parts ); $i++ ) { + for ( $i = 1, $c = count( $folder_parts ); $i <= $c; $i++ ) { @chmod( $target_parent . '/' . implode( '/', array_slice( $folder_parts, 0, $i ) ), $dir_perms ); } } @@ -1575,17 +1685,24 @@ function path_join( $base, $path ) { /** * Normalize a filesystem path. * - * Replaces backslashes with forward slashes for Windows systems, and ensures - * no duplicate slashes exist. + * On windows systems, replaces backslashes with forward slashes + * and forces upper-case drive letters. + * Allows for two leading slashes for Windows network shares, but + * ensures that all other duplicate slashes are reduced to a single. * * @since 3.9.0 + * @since 4.4.0 Ensures upper-case drive letters on Windows systems. + * @since 4.5.0 Allows for Windows network shares. * * @param string $path Path to normalize. * @return string Normalized path. */ function wp_normalize_path( $path ) { $path = str_replace( '\\', '/', $path ); - $path = preg_replace( '|/+|','/', $path ); + $path = preg_replace( '|(?<=.)/+|', '/', $path ); + if ( ':' === substr( $path, 1, 1 ) ) { + $path = ucfirst( $path ); + } return $path; } @@ -1601,10 +1718,12 @@ function wp_normalize_path( $path ) { * * @since 2.5.0 * + * @staticvar string $temp + * * @return string Writable temporary directory. */ function get_temp_dir() { - static $temp; + static $temp = ''; if ( defined('WP_TEMP_DIR') ) return trailingslashit(WP_TEMP_DIR); @@ -1625,8 +1744,7 @@ function get_temp_dir() { if ( is_dir( $temp ) && wp_is_writable( $temp ) ) return $temp; - $temp = '/tmp/'; - return $temp; + return '/tmp/'; } /** @@ -1667,11 +1785,11 @@ function wp_is_writable( $path ) { */ 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' ); @@ -1683,6 +1801,23 @@ function win_is_writable( $path ) { return true; } +/** + * Retrieves uploads directory information. + * + * Same as wp_upload_dir() but "light weight" as it doesn't attempt to create the uploads directory. + * Intended for use in themes, when only 'basedir' and 'baseurl' are needed, generally in all cases + * when not uploading files. + * + * @since 4.5.0 + * + * @see wp_upload_dir() + * + * @return array See wp_upload_dir() for description. + */ +function wp_get_upload_dir() { + return wp_upload_dir( null, false ); +} + /** * Get an array containing the current upload directory's path and url. * @@ -1708,14 +1843,71 @@ function win_is_writable( $path ) { * 'subdir' - sub directory if uploads use year/month folders option is on. * 'basedir' - path without subdir. * 'baseurl' - URL path without subdir. - * 'error' - set to false. + * 'error' - false or error message. * * @since 2.0.0 + * @uses _wp_upload_dir() * * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null. + * @param bool $create_dir Optional. Whether to check and create the uploads directory. Default true (backwards compatible). + * @param bool $refresh_cache Optional. Whether to refresh the cache. Default false. * @return array See above for description. */ -function wp_upload_dir( $time = null ) { +function wp_upload_dir( $time = null, $create_dir = true, $refresh_cache = false ) { + static $cache = array(); + + $key = sprintf( '%d-%s', get_current_blog_id(), (string) $time ); + + if ( $refresh_cache || empty( $cache[ $key ] ) ) { + $cache[ $key ] = _wp_upload_dir( $time ); + } + + /** + * 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', $cache[ $key ] ); + + if ( $create_dir ) { + $path = $uploads['path']; + $tested_paths = wp_cache_get( 'upload_dir_tested_paths' ); + + if ( ! is_array( $tested_paths ) ) { + $tested_paths = array(); + } + + if ( ! in_array( $path, $tested_paths, true ) ) { + if ( ! wp_mkdir_p( $path ) ) { + if ( 0 === strpos( $uploads['basedir'], ABSPATH ) ) { + $error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir']; + } else { + $error_path = basename( $uploads['basedir'] ) . $uploads['subdir']; + } + + $uploads['error'] = sprintf( __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), esc_html( $error_path ) ); + } else { + $tested_paths[] = $path; + wp_cache_set( 'upload_dir_tested_paths', $tested_paths ); + } + } + } + + return $uploads; +} + +/** + * A non-filtered, non-cached version of wp_upload_dir() that doesn't check the path. + * + * @access private + * + * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null. + * @return array See wp_upload_dir() + */ +function _wp_upload_dir( $time = null ) { $siteurl = get_option( 'siteurl' ); $upload_path = trim( get_option( 'upload_path' ) ); @@ -1804,36 +1996,14 @@ function wp_upload_dir( $time = null ) { $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 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']; - - $message = sprintf( __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), $error_path ); - $uploads['error'] = $message; - } - - return $uploads; + return array( + 'path' => $dir, + 'url' => $url, + 'subdir' => $subdir, + 'basedir' => $basedir, + 'baseurl' => $baseurl, + 'error' => false, + ); } /** @@ -1850,7 +2020,7 @@ function wp_upload_dir( $time = null ) { * * @param string $dir Directory. * @param string $filename File name. - * @param callback $unique_filename_callback Callback. Default null. + * @param callable $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 ) { @@ -1883,22 +2053,35 @@ function wp_unique_filename( $dir, $filename, $unique_filename_callback = null ) // 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 ); + $filename = str_replace( array( "-$number$ext", "$number$ext" ), "-$new_number$ext", $filename ); + $filename2 = str_replace( array( "-$number$ext2", "$number$ext2" ), "-$new_number$ext2", $filename2 ); $number = $new_number; } - return $filename2; + + /** + * Filter the result when generating a unique file name. + * + * @since 4.5.0 + * + * @param string $filename Unique file name. + * @param string $ext File extension, eg. ".png". + * @param string $dir Directory path. + * @param callable|null $unique_filename_callback Callback function that generates the unique file name. + */ + return apply_filters( 'wp_unique_filename', $filename2, $ext, $dir, $unique_filename_callback ); } while ( file_exists( $dir . "/$filename" ) ) { - if ( '' == "$number$ext" ) - $filename = $filename . ++$number . $ext; - else - $filename = str_replace( "$number$ext", ++$number . $ext, $filename ); + if ( '' == "$number$ext" ) { + $filename = "$filename-" . ++$number; + } else { + $filename = str_replace( array( "-$number$ext", "$number$ext" ), "-" . ++$number . $ext, $filename ); + } } } - return $filename; + /** This filter is documented in wp-includes/functions.php */ + return apply_filters( 'wp_unique_filename', $filename, $ext, $dir, $unique_filename_callback ); } /** @@ -1987,7 +2170,8 @@ function wp_upload_bits( $name, $deprecated, $bits, $time = null ) { // Compute the URL $url = $upload['url'] . "/$filename"; - return array( 'file' => $new_file, 'url' => $url, 'error' => false ); + /** This filter is documented in wp-admin/includes/file.php */ + return apply_filters( 'wp_handle_upload', array( 'file' => $new_file, 'url' => $url, 'type' => $wp_filetype['type'], 'error' => false ), 'sideload' ); } /** @@ -1996,8 +2180,7 @@ function wp_upload_bits( $name, $deprecated, $bits, $time = null ) { * @since 2.5.0 * * @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|void The file type, example: audio, video, document, spreadsheet, etc. */ function wp_ext2type( $ext ) { $ext = strtolower( $ext ); @@ -2016,7 +2199,7 @@ function wp_ext2type( $ext ) { '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( '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', 'xps', 'oxps', 'rtf', 'wp', 'wpd', 'psd' ), + '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' ), @@ -2027,8 +2210,6 @@ function wp_ext2type( $ext ) { foreach ( $ext2type as $type => $exts ) if ( in_array( $ext, $exts ) ) return $type; - - return null; } /** @@ -2080,7 +2261,6 @@ function wp_check_filetype( $filename, $mimes = null ) { * 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 @@ -2153,6 +2333,7 @@ function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) { * Retrieve list of mime types and file extensions. * * @since 3.5.0 + * @since 4.2.0 Support was added for GIMP (xcf) files. * * @return array Array of mime types keyed by the file extension regex corresponding to those types. */ @@ -2174,7 +2355,7 @@ function wp_get_mime_types() { 'gif' => 'image/gif', 'png' => 'image/png', 'bmp' => 'image/bmp', - 'tif|tiff' => 'image/tiff', + 'tiff|tif' => 'image/tiff', 'ico' => 'image/x-icon', // Video formats. 'asf|asx' => 'video/x-ms-asf', @@ -2224,6 +2405,7 @@ function wp_get_mime_types() { '7z' => 'application/x-7z-compressed', 'exe' => 'application/x-msdownload', 'psd' => 'application/octet-stream', + 'xcf' => 'application/octet-stream', // MS Office formats. 'doc' => 'application/msword', 'pot|pps|ppt' => 'application/vnd.ms-powerpoint', @@ -2373,7 +2555,7 @@ function wp_die( $message = '', $title = '', $args = array() ) { * * @since 3.4.0 * - * @param callback $function Callback function name. + * @param callable $function Callback function name. */ $function = apply_filters( 'wp_die_ajax_handler', '_ajax_wp_die_handler' ); } elseif ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) { @@ -2382,7 +2564,7 @@ function wp_die( $message = '', $title = '', $args = array() ) { * * @since 3.4.0 * - * @param callback $function Callback function name. + * @param callable $function Callback function name. */ $function = apply_filters( 'wp_die_xmlrpc_handler', '_xmlrpc_wp_die_handler' ); } else { @@ -2391,7 +2573,7 @@ function wp_die( $message = '', $title = '', $args = array() ) { * * @since 3.0.0 * - * @param callback $function Callback function name. + * @param callable $function Callback function name. */ $function = apply_filters( 'wp_die_handler', '_default_wp_die_handler' ); } @@ -2467,6 +2649,7 @@ function _default_wp_die_handler( $message, $title = '', $args = array() ) { > + <?php echo $title ?> @@ -2586,6 +2785,8 @@ function _default_wp_die_handler( $message, $title = '', $args = array() ) { * @since 3.2.0 * @access private * + * @global wp_xmlrpc_server $wp_xmlrpc_server + * * @param string $message Error message. * @param string $title Optional. Error title. Default empty. * @param string|array $args Optional. Arguments to control behavior. Default empty array. @@ -2644,7 +2845,7 @@ function _scalar_wp_die_handler( $message = '' ) { * @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. + * @return string|false The JSON encoded string, or false if it cannot be encoded. */ function wp_json_encode( $data, $options = 0, $depth = 512 ) { /* @@ -2660,7 +2861,10 @@ function wp_json_encode( $data, $options = 0, $depth = 512 ) { $args = array( $data ); } - $json = call_user_func_array( 'json_encode', $args ); + // Prepare the data for JSON serialization. + $data = _wp_json_prepare_data( $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 @@ -2681,11 +2885,11 @@ function wp_json_encode( $data, $options = 0, $depth = 512 ) { /** * Perform sanity checks on data that shall be encoded to JSON. * - * @see wp_json_encode() - * + * @ignore * @since 4.1.0 * @access private - * @internal + * + * @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. @@ -2744,11 +2948,13 @@ function _wp_json_sanity_check( $data, $depth ) { /** * Convert a string to UTF-8, so that it can be safely encoded to JSON. * - * @see _wp_json_sanity_check() - * + * @ignore * @since 4.1.0 * @access private - * @internal + * + * @see _wp_json_sanity_check() + * + * @staticvar bool $use_mb * * @param string $string The string which is to be converted. * @return string The checked string. @@ -2771,6 +2977,56 @@ function _wp_json_convert_string( $string ) { } } +/** + * Prepares response data to be serialized to JSON. + * + * This supports the JsonSerializable interface for PHP 5.2-5.3 as well. + * + * @ignore + * @since 4.4.0 + * @access private + * + * @param mixed $data Native representation. + * @return bool|int|float|null|string|array Data ready for `json_encode()`. + */ +function _wp_json_prepare_data( $data ) { + if ( ! defined( 'WP_JSON_SERIALIZE_COMPATIBLE' ) || WP_JSON_SERIALIZE_COMPATIBLE === false ) { + return $data; + } + + switch ( gettype( $data ) ) { + case 'boolean': + case 'integer': + case 'double': + case 'string': + case 'NULL': + // These values can be passed through. + return $data; + + case 'array': + // Arrays must be mapped in case they also return objects. + return array_map( '_wp_json_prepare_data', $data ); + + case 'object': + // If this is an incomplete object (__PHP_Incomplete_Class), bail. + if ( ! is_object( $data ) ) { + return null; + } + + if ( $data instanceof JsonSerializable ) { + $data = $data->jsonSerialize(); + } else { + $data = get_object_vars( $data ); + } + + // Now, pass the array (or whatever was returned from jsonSerialize through). + return _wp_json_prepare_data( $data ); + + default: + return null; + } +} + /** * Send a JSON response back to an Ajax request. * @@ -2901,8 +3157,14 @@ function _config_wp_siteurl( $url = '' ) { function _mce_set_direction( $input ) { if ( is_rtl() ) { $input['directionality'] = 'rtl'; - $input['plugins'] .= ',directionality'; - $input['toolbar1'] .= ',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; @@ -2940,51 +3202,51 @@ function smilies_init() { if ( !isset( $wpsmiliestrans ) ) { $wpsmiliestrans = array( - ':mrgreen:' => 'icon_mrgreen.gif', - ':neutral:' => 'icon_neutral.gif', - ':twisted:' => 'icon_twisted.gif', - ':arrow:' => 'icon_arrow.gif', - ':shock:' => 'icon_eek.gif', - ':smile:' => 'icon_smile.gif', - ':???:' => 'icon_confused.gif', - ':cool:' => 'icon_cool.gif', - ':evil:' => 'icon_evil.gif', - ':grin:' => 'icon_biggrin.gif', - ':idea:' => 'icon_idea.gif', - ':oops:' => 'icon_redface.gif', - ':razz:' => 'icon_razz.gif', - ':roll:' => 'icon_rolleyes.gif', - ':wink:' => 'icon_wink.gif', - ':cry:' => 'icon_cry.gif', - ':eek:' => 'icon_surprised.gif', - ':lol:' => 'icon_lol.gif', - ':mad:' => 'icon_mad.gif', - ':sad:' => 'icon_sad.gif', - '8-)' => 'icon_cool.gif', - '8-O' => 'icon_eek.gif', - ':-(' => 'icon_sad.gif', - ':-)' => 'icon_smile.gif', - ':-?' => 'icon_confused.gif', - ':-D' => 'icon_biggrin.gif', - ':-P' => 'icon_razz.gif', - ':-o' => 'icon_surprised.gif', - ':-x' => 'icon_mad.gif', - ':-|' => 'icon_neutral.gif', - ';-)' => 'icon_wink.gif', + ':mrgreen:' => 'mrgreen.png', + ':neutral:' => "\xf0\x9f\x98\x90", + ':twisted:' => "\xf0\x9f\x98\x88", + ':arrow:' => "\xe2\x9e\xa1", + ':shock:' => "\xf0\x9f\x98\xaf", + ':smile:' => "\xf0\x9f\x99\x82", + ':???:' => "\xf0\x9f\x98\x95", + ':cool:' => "\xf0\x9f\x98\x8e", + ':evil:' => "\xf0\x9f\x91\xbf", + ':grin:' => "\xf0\x9f\x98\x80", + ':idea:' => "\xf0\x9f\x92\xa1", + ':oops:' => "\xf0\x9f\x98\xb3", + ':razz:' => "\xf0\x9f\x98\x9b", + ':roll:' => 'rolleyes.png', + ':wink:' => "\xf0\x9f\x98\x89", + ':cry:' => "\xf0\x9f\x98\xa5", + ':eek:' => "\xf0\x9f\x98\xae", + ':lol:' => "\xf0\x9f\x98\x86", + ':mad:' => "\xf0\x9f\x98\xa1", + ':sad:' => "\xf0\x9f\x99\x81", + '8-)' => "\xf0\x9f\x98\x8e", + '8-O' => "\xf0\x9f\x98\xaf", + ':-(' => "\xf0\x9f\x99\x81", + ':-)' => "\xf0\x9f\x99\x82", + ':-?' => "\xf0\x9f\x98\x95", + ':-D' => "\xf0\x9f\x98\x80", + ':-P' => "\xf0\x9f\x98\x9b", + ':-o' => "\xf0\x9f\x98\xae", + ':-x' => "\xf0\x9f\x98\xa1", + ':-|' => "\xf0\x9f\x98\x90", + ';-)' => "\xf0\x9f\x98\x89", // This one transformation breaks regular text with frequency. - // '8)' => 'icon_cool.gif', - '8O' => 'icon_eek.gif', - ':(' => 'icon_sad.gif', - ':)' => 'icon_smile.gif', - ':?' => 'icon_confused.gif', - ':D' => 'icon_biggrin.gif', - ':P' => 'icon_razz.gif', - ':o' => 'icon_surprised.gif', - ':x' => 'icon_mad.gif', - ':|' => 'icon_neutral.gif', - ';)' => 'icon_wink.gif', - ':!:' => 'icon_exclaim.gif', - ':?:' => 'icon_question.gif', + // '8)' => "\xf0\x9f\x98\x8e", + '8O' => "\xf0\x9f\x98\xaf", + ':(' => "\xf0\x9f\x99\x81", + ':)' => "\xf0\x9f\x99\x82", + ':?' => "\xf0\x9f\x98\x95", + ':D' => "\xf0\x9f\x98\x80", + ':P' => "\xf0\x9f\x98\x9b", + ':o' => "\xf0\x9f\x98\xae", + ':x' => "\xf0\x9f\x98\xa1", + ':|' => "\xf0\x9f\x98\x90", + ';)' => "\xf0\x9f\x98\x89", + ':!:' => "\xe2\x9d\x97", + ':?:' => "\xe2\x9d\x93", ); } @@ -3085,6 +3347,24 @@ function wp_array_slice_assoc( $array, $keys ) { return $slice; } +/** + * Determines if the variable is a numeric-indexed array. + * + * @since 4.4.0 + * + * @param mixed $data Variable to check. + * @return bool Whether the variable is a list. + */ +function wp_is_numeric_array( $data ) { + if ( ! is_array( $data ) ) { + return false; + } + + $keys = array_keys( $data ); + $string_keys = array_filter( $keys, 'is_string' ); + return count( $string_keys ) === 0; +} + /** * Filters a list of objects, based on a set of key => value arguments. * @@ -3095,7 +3375,8 @@ function wp_array_slice_assoc( $array, $keys ) { * against each object. Default empty array. * @param string $operator Optional. The logical operation to perform. 'or' means * only one element from the array needs to match; 'and' - * means all elements must match. Default 'and'. + * means all elements must match; 'not' means no elements may + * 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. @@ -3169,8 +3450,9 @@ function wp_list_filter( $list, $args = array(), $operator = 'AND' ) { * @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. * Default null. - * @return array Array of found values. If $index_key is set, an array of found values with keys - * corresponding to $index_key. + * @return array Array of found values. If `$index_key` is set, an array of found values with keys + * corresponding to `$index_key`. If `$index_key` is null, array keys from the original + * `$list` will be preserved in the results. */ function wp_list_pluck( $list, $field, $index_key = null ) { if ( ! $index_key ) { @@ -3245,6 +3527,8 @@ function wp_maybe_load_widgets() { * Append the Widgets menu to the themes main menu. * * @since 2.2.0 + * + * @global array $submenu */ function wp_widgets_add_menu() { global $submenu; @@ -3299,7 +3583,7 @@ function dead_db() { } // If installing or in the admin, provide the verbose message. - if ( defined('WP_INSTALLING') || defined('WP_ADMIN') ) + if ( wp_installing() || defined( 'WP_ADMIN' ) ) wp_die($wpdb->error); // Otherwise, be terse. @@ -3387,6 +3671,73 @@ function _deprecated_function( $function, $version, $replacement = null ) { } } +/** + * Marks a constructor as deprecated and informs when it has been used. + * + * Similar to _deprecated_function(), but with different strings. Used to + * remove PHP4 style constructors. + * + * The current behavior is to trigger a user error if `WP_DEBUG` is true. + * + * This function is to be used in every PHP4 style constructor method that is deprecated. + * + * @since 4.3.0 + * @since 4.5.0 Added the `$parent_class` parameter. + * + * @access private + * + * @param string $class The class containing the deprecated constructor. + * @param string $version The version of WordPress that deprecated the function. + * @param string $parent_class Optional. The parent class calling the deprecated constructor. + * Default empty string. + */ +function _deprecated_constructor( $class, $version, $parent_class = '' ) { + + /** + * Fires when a deprecated constructor is called. + * + * @since 4.3.0 + * @since 4.5.0 Added the `$parent_class` parameter. + * + * @param string $class The class containing the deprecated constructor. + * @param string $version The version of WordPress that deprecated the function. + * @param string $parent_class The parent class calling the deprecated constructor. + */ + do_action( 'deprecated_constructor_run', $class, $version, $parent_class ); + + /** + * Filter whether to trigger an error for deprecated functions. + * + * `WP_DEBUG` must be true in addition to the filter evaluating to true. + * + * @since 4.3.0 + * + * @param bool $trigger Whether to trigger the error for deprecated functions. Default true. + */ + if ( WP_DEBUG && apply_filters( 'deprecated_constructor_trigger_error', true ) ) { + if ( function_exists( '__' ) ) { + if ( ! empty( $parent_class ) ) { + /* translators: 1: PHP class name, 2: PHP parent class name, 3: version number, 4: __construct() method */ + trigger_error( sprintf( __( 'The called constructor method for %1$s in %2$s is deprecated since version %3$s! Use %4$s instead.' ), + $class, $parent_class, $version, '
__construct()
' ) ); + } else { + /* translators: 1: PHP class name, 2: version number, 3: __construct() method */ + trigger_error( sprintf( __( 'The called constructor method for %1$s is deprecated since version %2$s! Use %3$s instead.' ), + $class, $version, '
__construct()
' ) ); + } + } else { + if ( ! empty( $parent_class ) ) { + trigger_error( sprintf( 'The called constructor method for %1$s in %2$s is deprecated since version %3$s! Use %4$s instead.', + $class, $parent_class, $version, '
__construct()
' ) ); + } else { + trigger_error( sprintf( 'The called constructor method for %1$s is deprecated since version %2$s! Use %3$s instead.', + $class, $version, '
__construct()
' ) ); + } + } + } + +} + /** * Mark a file as deprecated and inform when it has been used. * @@ -3543,11 +3894,16 @@ function _doing_it_wrong( $function, $message, $version ) { 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 Debugging in WordPress for more information.' ); + /* translators: %s: Codex URL */ + $message .= ' ' . sprintf( __( 'Please see Debugging in WordPress for more information.' ), + __( 'https://codex.wordpress.org/Debugging_in_WordPress' ) + ); trigger_error( sprintf( __( '%1$s was called incorrectly. %2$s %3$s' ), $function, $message, $version ) ); } else { $version = is_null( $version ) ? '' : sprintf( '(This message was added in version %s.)', $version ); - $message .= ' Please see Debugging in WordPress for more information.'; + $message .= sprintf( ' Please see Debugging in WordPress for more information.', + 'https://codex.wordpress.org/Debugging_in_WordPress' + ); trigger_error( sprintf( '%1$s was called incorrectly. %2$s %3$s', $function, $message, $version ) ); } } @@ -3571,6 +3927,8 @@ function is_lighttpd_before_150() { * * @since 2.5.0 * + * @global bool $is_apache + * * @param string $mod The module, e.g. mod_rewrite. * @param bool $default Optional. The default return value if the module is not found. Default false. * @return bool Whether the specified module is loaded. @@ -3600,6 +3958,8 @@ function apache_mod_loaded($mod, $default = false) { * * @since 2.8.0 * + * @global bool $is_iis7 + * * @return bool Whether IIS7 supports permalinks. */ function iis7_supports_permalinks() { @@ -3616,7 +3976,7 @@ function iis7_supports_permalinks() { * 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', false ) && isset($_SERVER['IIS_UrlRewriteModule']) && ( PHP_SAPI == 'cgi-fcgi' ); } /** @@ -3640,7 +4000,7 @@ function iis7_supports_permalinks() { * @since 1.2.0 * * @param string $file File path. - * @param array $allowed_files List of allowed files. + * @param array $allowed_files List of allowed files. * @return int 0 means nothing is wrong, greater than 0 means something was wrong. */ function validate_file( $file, $allowed_files = '' ) { @@ -3678,25 +4038,13 @@ function is_ssl() { return false; } -/** - * Whether SSL login should be forced. - * - * @since 2.6.0 - * - * @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 * + * @staticvar bool $forced + * * @param string|bool $force Optional. Whether to force SSL in admin screens. Default null. * @return bool True if forced, false if not forced. */ @@ -3742,7 +4090,7 @@ function wp_guess_url() { if ( false !== strpos( $_SERVER['SCRIPT_FILENAME'], $abspath_fix ) ) { // Request is hitting a file inside ABSPATH $directory = str_replace( ABSPATH, '', $script_filename_dir ); - // Strip off the sub directory, and any file/query paramss + // Strip off the sub directory, and any file/query params $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 @@ -3773,6 +4121,8 @@ function wp_guess_url() { * * @since 3.3.0 * + * @staticvar bool $_suspend + * * @param bool $suspend Optional. Suspends additions if true, re-enables them if false. * @return bool The current suspend setting */ @@ -3794,6 +4144,8 @@ function wp_suspend_cache_addition( $suspend = null ) { * * @since 2.7.0 * + * @global bool $_wp_suspend_cache_invalidation + * * @param bool $suspend Optional. Whether to suspend or enable cache invalidation. Default true. * @return bool The current suspend setting. */ @@ -3810,6 +4162,8 @@ function wp_suspend_cache_invalidation( $suspend = true ) { * * @since 3.0.0 * + * @global object $current_site + * * @param int $site_id Optional. Site ID to test. Defaults to current site. * Defaults to current site. * @return bool True if $site_id is the main site of the network, or if not @@ -3837,32 +4191,59 @@ function is_main_site( $site_id = null ) { * @return bool True if $network_id is the main network, or if not running Multisite. */ function is_main_network( $network_id = null ) { - global $wpdb; - - if ( ! is_multisite() ) + if ( ! is_multisite() ) { return true; + } $current_network_id = (int) get_current_site()->id; - if ( ! $network_id ) + if ( null === $network_id ) { $network_id = $current_network_id; + } + $network_id = (int) $network_id; - if ( defined( 'PRIMARY_NETWORK_ID' ) ) - return $network_id === (int) PRIMARY_NETWORK_ID; + return ( $network_id === get_main_network_id() ); +} - if ( 1 === $current_network_id ) - return $network_id === $current_network_id; +/** + * Get the main network ID. + * + * @since 4.3.0 + * + * @global wpdb $wpdb WordPress database abstraction object. + * + * @return int The ID of the main network. + */ +function get_main_network_id() { + global $wpdb; - $primary_network_id = (int) wp_cache_get( 'primary_network_id', 'site-options' ); + if ( ! is_multisite() ) { + return 1; + } - if ( $primary_network_id ) - return $network_id === $primary_network_id; + if ( defined( 'PRIMARY_NETWORK_ID' ) ) { + $main_network_id = PRIMARY_NETWORK_ID; + } elseif ( 1 === (int) get_current_site()->id ) { + // If the current network has an ID of 1, assume it is the main network. + $main_network_id = 1; + } else { + $main_network_id = wp_cache_get( 'primary_network_id', 'site-options' ); - $primary_network_id = (int) $wpdb->get_var( "SELECT id FROM $wpdb->site ORDER BY id LIMIT 1" ); - wp_cache_add( 'primary_network_id', $primary_network_id, 'site-options' ); + if ( false === $main_network_id ) { + $main_network_id = (int) $wpdb->get_var( "SELECT id FROM {$wpdb->site} ORDER BY id LIMIT 1" ); + wp_cache_add( 'primary_network_id', $main_network_id, 'site-options' ); + } + } - return $network_id === $primary_network_id; + /** + * Filter the main network ID. + * + * @since 4.3.0 + * + * @param int $main_network_id The ID of the main network. + */ + return (int) apply_filters( 'get_main_network_id', $main_network_id ); } /** @@ -3870,6 +4251,8 @@ function is_main_network( $network_id = null ) { * * @since 3.0.0 * + * @staticvar bool $global_terms + * * @return bool True if multisite and global terms enabled. */ function global_terms_enabled() { @@ -3887,7 +4270,7 @@ function global_terms_enabled() { * * @since 3.0.0 * - * @param null $anbled Whether global terms are enabled. + * @param null $enabled Whether global terms are enabled. */ $filter = apply_filters( 'global_terms_enabled', null ); if ( ! is_null( $filter ) ) @@ -3905,7 +4288,7 @@ function global_terms_enabled() { * * @since 2.8.0 * - * @return float|bool Timezone GMT offset, false otherwise. + * @return float|false Timezone GMT offset, false otherwise. */ function wp_timezone_override_offset() { if ( !$timezone_string = get_option( 'timezone_string' ) ) { @@ -3973,6 +4356,8 @@ function _wp_timezone_choice_usort_callback( $a, $b ) { * * @since 2.9.0 * + * @staticvar bool $mo_loaded + * * @param string $selected_zone Selected timezone. * @return string */ @@ -4113,10 +4498,14 @@ function _cleanup_header_comment( $str ) { } /** - * Permanently delete 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 + * + * @global wpdb $wpdb WordPress database abstraction object. */ function wp_scheduled_delete() { global $wpdb; @@ -4153,7 +4542,7 @@ function wp_scheduled_delete() { delete_comment_meta($comment_id, '_wp_trash_meta_time'); delete_comment_meta($comment_id, '_wp_trash_meta_status'); } else { - wp_delete_comment($comment_id); + wp_delete_comment( $del_comment ); } } } @@ -4168,7 +4557,7 @@ function wp_scheduled_delete() { * 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. * - * @link http://codex.wordpress.org/File_Header + * @link https://codex.wordpress.org/File_Header * * @since 2.9.0 * @@ -4227,7 +4616,7 @@ function get_file_data( $file, $default_headers, $context = '' ) { * * @see __return_false() * - * @return bool True. + * @return true True. */ function __return_true() { return true; @@ -4242,7 +4631,7 @@ function __return_true() { * * @see __return_true() * - * @return bool False. + * @return false False. */ function __return_false() { return false; @@ -4317,7 +4706,7 @@ function send_nosniff_header() { /** * 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 Database column. @@ -4345,7 +4734,7 @@ function _wp_mysql_week( $column ) { * @since 3.1.0 * @access private * - * @param callback $callback Function that accepts ( ID, $callback_args ) and outputs parent_ID. + * @param callable $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_parent The parent_ID of $start to use instead of calling $callback( $start ). * Use null to always use $callback @@ -4370,7 +4759,7 @@ function wp_find_hierarchy_loop( $callback, $start, $start_parent, $callback_arg * @since 3.1.0 * @access private * - * @param callback $callback Function that accepts ( ID, callback_arg, ... ) and outputs parent_ID. + * @param callable $callback Function that accepts ( ID, callback_arg, ... ) and outputs parent_ID. * @param int $start The ID to start the loop check at. * @param array $override Optional. An array of ( ID => parent_ID, ... ) to use instead of $callback. * Default empty array. @@ -4423,17 +4812,22 @@ function send_frame_options_header() { * Retrieve a list of protocols to allow in HTML attributes. * * @since 3.3.0 + * @since 4.3.0 Added 'webcal' to the protocols array. * * @see wp_kses() * @see esc_url() * - * @return array Array of allowed protocols. + * @staticvar array $protocols + * + * @return array Array of allowed protocols. Defaults to an array containing 'http', 'https', + * 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet', + * 'mms', 'rtsp', 'svn', 'tel', 'fax', 'xmpp', and 'webcal'. */ function wp_allowed_protocols() { - static $protocols; + static $protocols = array(); if ( empty( $protocols ) ) { - $protocols = array( 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'svn', 'tel', 'fax', 'xmpp' ); + $protocols = array( 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'svn', 'tel', 'fax', 'xmpp', 'webcal' ); /** * Filter the list of protocols allowed in HTML attributes. @@ -4528,7 +4922,7 @@ function _get_non_cached_ids( $object_ids, $cache_key ) { * @since 3.4.0 * @access private * - * @return bool true|false Whether the device is able to upload files. + * @return bool Whether the device is able to upload files. */ function _device_can_upload() { if ( ! wp_is_mobile() ) @@ -4649,12 +5043,12 @@ function wp_auth_check_html() {
-
+ -
+
ID; + + ?> + +