X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/7f1521bf193b382565eb753043c161f4cb3fcda7..refs/tags/wordpress-4.5:/wp-includes/theme.php diff --git a/wp-includes/theme.php b/wp-includes/theme.php index 1b372da3..f4dfaeed 100644 --- a/wp-includes/theme.php +++ b/wp-includes/theme.php @@ -14,6 +14,9 @@ * * @since 3.4.0 * + * @global array $wp_theme_directories + * @staticvar array $_themes + * * @param array $args The search arguments. Optional. * - errors mixed True to return themes with errors, false to return themes without errors, null * to return all themes. Defaults to false. @@ -22,7 +25,7 @@ * to return only network-allowed themes. Null to return all themes. Defaults to null. * - blog_id int (Multisite) The blog ID used to calculate which themes are allowed. Defaults to 0, * synonymous for the current blog. - * @return Array of WP_Theme objects. + * @return array Array of WP_Theme objects. */ function wp_get_themes( $args = array() ) { global $wp_theme_directories; @@ -84,9 +87,11 @@ function wp_get_themes( $args = array() ) { * * @since 3.4.0 * + * @global array $wp_theme_directories + * * @param string $stylesheet Directory name for the theme. Optional. Defaults to current theme. * @param string $theme_root Absolute path of the theme root to look in. Optional. If not specified, get_raw_theme_root() - * is used to calculate the theme root for the $stylesheet provided (or current theme). + * is used to calculate the theme root for the $stylesheet provided (or current theme). * @return WP_Theme Theme object. Be sure to check the object's exists() method if you need to confirm the theme's existence. */ function wp_get_theme( $stylesheet = null, $theme_root = null ) { @@ -172,7 +177,7 @@ function get_stylesheet_directory() { * * @since 1.5.0 * - * @param string $stylesheet_dir Absolute path to the current them. + * @param string $stylesheet_dir Absolute path to the current theme. * @param string $stylesheet Directory name of the current theme. * @param string $theme_root Absolute path to themes directory. */ @@ -243,6 +248,8 @@ function get_stylesheet_uri() { * * @since 2.1.0 * + * @global WP_Locale $wp_locale + * * @return string */ function get_locale_stylesheet_uri() { @@ -338,6 +345,8 @@ function get_template_directory_uri() { * * @since 2.9.0 * + * @global array $wp_theme_directories + * * @return array|string An array of theme roots keyed by template/stylesheet or a single theme root if all themes have the same root. */ function get_theme_roots() { @@ -359,6 +368,8 @@ function get_theme_roots() { * * @since 2.9.0 * + * @global array $wp_theme_directories + * * @param string $directory Either the full filesystem path to a theme folder or a folder within WP_CONTENT_DIR * @return bool */ @@ -391,15 +402,19 @@ function register_theme_directory( $directory ) { * * @since 2.9.0 * + * @global array $wp_theme_directories + * @staticvar array $found_themes + * * @param bool $force Optional. Whether to force a new directory scan. Defaults to false. - * @return array Valid themes found + * @return array|false Valid themes found */ function search_theme_directories( $force = false ) { global $wp_theme_directories; + static $found_themes = null; + if ( empty( $wp_theme_directories ) ) return false; - static $found_themes; if ( ! $force && isset( $found_themes ) ) return $found_themes; @@ -518,6 +533,8 @@ function search_theme_directories( $force = false ) { * * @since 1.5.0 * + * @global array $wp_theme_directories + * * @param string $stylesheet_or_template The stylesheet or template name of the theme * @return string Theme path. */ @@ -550,10 +567,12 @@ function get_theme_root( $stylesheet_or_template = false ) { * * @since 1.5.0 * + * @global array $wp_theme_directories + * * @param string $stylesheet_or_template Optional. The stylesheet or template name of the theme. - * Default is to leverage the main theme root. - * @param string $theme_root Optional. The theme root for which calculations will be based, preventing - * the need for a get_raw_theme_root() call. + * Default is to leverage the main theme root. + * @param string $theme_root Optional. The theme root for which calculations will be based, preventing + * the need for a get_raw_theme_root() call. * @return string Themes URI. */ function get_theme_root_uri( $stylesheet_or_template = false, $theme_root = false ) { @@ -597,8 +616,11 @@ function get_theme_root_uri( $stylesheet_or_template = false, $theme_root = fals * * @since 3.1.0 * + * @global array $wp_theme_directories + * * @param string $stylesheet_or_template The stylesheet or template name of the theme - * @param bool $skip_cache Optional. Whether to skip the cache. Defaults to false, meaning the cache is used. + * @param bool $skip_cache Optional. Whether to skip the cache. + * Defaults to false, meaning the cache is used. * @return string Theme root */ function get_raw_theme_root( $stylesheet_or_template, $skip_cache = false ) { @@ -638,116 +660,6 @@ function locale_stylesheet() { echo ''; } -/** - * Start preview theme output buffer. - * - * Will only perform task if the user has permissions and template and preview - * query variables exist. - * - * @since 2.6.0 - */ -function preview_theme() { - if ( ! (isset($_GET['template']) && isset($_GET['preview'])) ) - return; - - if ( !current_user_can( 'switch_themes' ) ) - return; - - // Admin Thickbox requests - if ( isset( $_GET['preview_iframe'] ) ) - show_admin_bar( false ); - - $_GET['template'] = preg_replace('|[^a-z0-9_./-]|i', '', $_GET['template']); - - if ( validate_file($_GET['template']) ) - return; - - add_filter( 'template', '_preview_theme_template_filter' ); - - if ( isset($_GET['stylesheet']) ) { - $_GET['stylesheet'] = preg_replace('|[^a-z0-9_./-]|i', '', $_GET['stylesheet']); - if ( validate_file($_GET['stylesheet']) ) - return; - add_filter( 'stylesheet', '_preview_theme_stylesheet_filter' ); - } - - // Prevent theme mods to current theme being used on theme being previewed - add_filter( 'pre_option_theme_mods_' . get_option( 'stylesheet' ), '__return_empty_array' ); - - ob_start( 'preview_theme_ob_filter' ); -} - -/** - * Private function to modify the current template when previewing a theme - * - * @since 2.9.0 - * @access private - * - * @return string - */ -function _preview_theme_template_filter() { - return isset($_GET['template']) ? $_GET['template'] : ''; -} - -/** - * Private function to modify the current stylesheet when previewing a theme - * - * @since 2.9.0 - * @access private - * - * @return string - */ -function _preview_theme_stylesheet_filter() { - return isset($_GET['stylesheet']) ? $_GET['stylesheet'] : ''; -} - -/** - * Callback function for ob_start() to capture all links in the theme. - * - * @since 2.6.0 - * @access private - * - * @param string $content - * @return string - */ -function preview_theme_ob_filter( $content ) { - return preg_replace_callback( "|()|", 'preview_theme_ob_filter_callback', $content ); -} - -/** - * Manipulates preview theme links in order to control and maintain location. - * - * Callback function for preg_replace_callback() to accept and filter matches. - * - * @since 2.6.0 - * @access private - * - * @param array $matches - * @return string - */ -function preview_theme_ob_filter_callback( $matches ) { - if ( strpos($matches[4], 'onclick') !== false ) - $matches[4] = preg_replace('#onclick=([\'"]).*?(?. (? 1, 'template' => $template, 'stylesheet' => $stylesheet, 'preview_iframe' => 1 ), $matches[3] ); - if ( 0 === strpos($link, 'preview=1') ) - $link = "?$link"; - return $matches[1] . esc_attr( $link ) . $matches[4]; -} - /** * Switches the theme. * @@ -756,6 +668,10 @@ function preview_theme_ob_filter_callback( $matches ) { * * @since 2.5.0 * + * @global array $wp_theme_directories + * @global WP_Customize_Manager $wp_customize + * @global array $sidebars_widgets + * * @param string $stylesheet Stylesheet name */ function switch_theme( $stylesheet ) { @@ -772,16 +688,16 @@ function switch_theme( $stylesheet ) { set_theme_mod( 'sidebars_widgets', array( 'time' => time(), 'data' => $_sidebars_widgets ) ); } - $old_theme = wp_get_theme(); - $new_theme = wp_get_theme( $stylesheet ); + $nav_menu_locations = get_theme_mod( 'nav_menu_locations' ); if ( func_num_args() > 1 ) { - $template = $stylesheet; $stylesheet = func_get_arg( 1 ); - } else { - $template = $new_theme->get_template(); } + $old_theme = wp_get_theme(); + $new_theme = wp_get_theme( $stylesheet ); + $template = $new_theme->get_template(); + update_option( 'template', $template ); update_option( 'stylesheet', $stylesheet ); @@ -800,35 +716,50 @@ function switch_theme( $stylesheet ) { // Migrate from the old mods_{name} option to theme_mods_{slug}. if ( is_admin() && false === get_option( 'theme_mods_' . $stylesheet ) ) { $default_theme_mods = (array) get_option( 'mods_' . $new_name ); + if ( ! empty( $nav_menu_locations ) && empty( $default_theme_mods['nav_menu_locations'] ) ) { + $default_theme_mods['nav_menu_locations'] = $nav_menu_locations; + } add_option( "theme_mods_$stylesheet", $default_theme_mods ); } else { /* * Since retrieve_widgets() is called when initializing a theme in the Customizer, - * we need to to remove the theme mods to avoid overwriting changes made via + * we need to remove the theme mods to avoid overwriting changes made via * the Customizer when accessing wp-admin/widgets.php. */ if ( 'wp_ajax_customize_save' === current_action() ) { remove_theme_mod( 'sidebars_widgets' ); } + + if ( ! empty( $nav_menu_locations ) ) { + $nav_mods = get_theme_mod( 'nav_menu_locations' ); + if ( empty( $nav_mods ) ) { + set_theme_mod( 'nav_menu_locations', $nav_menu_locations ); + } + } } update_option( 'theme_switched', $old_theme->get_stylesheet() ); + /** * Fires after the theme is switched. * * @since 1.5.0 + * @since 4.5.0 Introduced the `$old_theme` parameter. * * @param string $new_name Name of the new theme. * @param WP_Theme $new_theme WP_Theme instance of the new theme. + * @param WP_Theme $old_theme WP_Theme instance of the old theme. */ - do_action( 'switch_theme', $new_name, $new_theme ); + do_action( 'switch_theme', $new_name, $new_theme, $old_theme ); } /** * Checks that current theme files 'index.php' and 'style.css' exists. * - * Does not check the default theme, which is the fallback and should always exist. + * Does not initially check the default theme, which is the fallback and should always exist. + * But if it doesn't exist, it'll fall back to the latest core default theme that does exist. * Will switch theme to the fallback theme if current theme does not validate. + * * You can use the 'validate_current_theme' filter to return false to * disable this functionality. * @@ -843,27 +774,44 @@ function validate_current_theme() { * * @since 2.7.0 * - * @param bool true Validation flag to check the current theme. + * @param bool $validate Whether to validate the current theme. Default true. */ - if ( defined('WP_INSTALLING') || ! apply_filters( 'validate_current_theme', true ) ) + if ( wp_installing() || ! apply_filters( 'validate_current_theme', true ) ) return true; - if ( get_template() != WP_DEFAULT_THEME && !file_exists(get_template_directory() . '/index.php') ) { - switch_theme( WP_DEFAULT_THEME ); - return false; + if ( ! file_exists( get_template_directory() . '/index.php' ) ) { + // Invalid. + } elseif ( ! file_exists( get_template_directory() . '/style.css' ) ) { + // Invalid. + } elseif ( is_child_theme() && ! file_exists( get_stylesheet_directory() . '/style.css' ) ) { + // Invalid. + } else { + // Valid. + return true; } - if ( get_stylesheet() != WP_DEFAULT_THEME && !file_exists(get_template_directory() . '/style.css') ) { + $default = wp_get_theme( WP_DEFAULT_THEME ); + if ( $default->exists() ) { switch_theme( WP_DEFAULT_THEME ); return false; } - if ( is_child_theme() && ! file_exists( get_stylesheet_directory() . '/style.css' ) ) { - switch_theme( WP_DEFAULT_THEME ); - return false; + /** + * If we're in an invalid state but WP_DEFAULT_THEME doesn't exist, + * switch to the latest core default theme that's installed. + * If it turns out that this latest core default theme is our current + * theme, then there's nothing we can do about that, so we have to bail, + * rather than going into an infinite loop. (This is why there are + * checks against WP_DEFAULT_THEME above, also.) We also can't do anything + * if it turns out there is no default theme installed. (That's `false`.) + */ + $default = WP_Theme::get_core_default_theme(); + if ( false === $default || get_stylesheet() == $default->get_stylesheet() ) { + return true; } - return true; + switch_theme( $default->get_stylesheet() ); + return false; } /** @@ -871,11 +819,12 @@ function validate_current_theme() { * * @since 3.1.0 * - * @return array|null Theme modifications. + * @return array|void Theme modifications. */ function get_theme_mods() { $theme_slug = get_option( 'stylesheet' ); - if ( false === ( $mods = get_option( "theme_mods_$theme_slug" ) ) ) { + $mods = get_option( "theme_mods_$theme_slug" ); + if ( false === $mods ) { $theme_name = get_option( 'current_theme' ); if ( false === $theme_name ) $theme_name = wp_get_theme()->get('Name'); @@ -898,7 +847,7 @@ function get_theme_mods() { * * @since 2.1.0 * - * @param string $name Theme modification name. + * @param string $name Theme modification name. * @param bool|string $default * @return string */ @@ -933,8 +882,8 @@ function get_theme_mod( $name, $default = false ) { * * @since 2.1.0 * - * @param string $name Theme modification name. - * @param mixed $value theme modification value. + * @param string $name Theme modification name. + * @param mixed $value Theme modification value. */ function set_theme_mod( $name, $value ) { $mods = get_theme_mods(); @@ -967,7 +916,6 @@ function set_theme_mod( $name, $value ) { * @since 2.1.0 * * @param string $name Theme modification name. - * @return null */ function remove_theme_mod( $name ) { $mods = get_theme_mods(); @@ -977,9 +925,10 @@ function remove_theme_mod( $name ) { unset( $mods[ $name ] ); - if ( empty( $mods ) ) - return remove_theme_mods(); - + if ( empty( $mods ) ) { + remove_theme_mods(); + return; + } $theme = get_option( 'stylesheet' ); update_option( "theme_mods_$theme", $mods ); } @@ -1000,18 +949,18 @@ function remove_theme_mods() { } /** - * Retrieve text color for custom header. + * Retrieves the custom header text color in HEX format. * * @since 2.1.0 * - * @return string + * @return string Header text color in HEX format (minus the hash symbol). */ function get_header_textcolor() { return get_theme_mod('header_textcolor', get_theme_support( 'custom-header', 'default-text-color' ) ); } /** - * Display text color for custom header. + * Displays the custom header text color in HEX format (minus the hash symbol). * * @since 2.1.0 */ @@ -1031,7 +980,7 @@ function display_header_text() { return false; $text_color = get_theme_mod( 'header_textcolor', get_theme_support( 'custom-header', 'default-text-color' ) ); - return 'blank' != $text_color; + return 'blank' !== $text_color; } /** @@ -1066,6 +1015,83 @@ function get_header_image() { return esc_url_raw( set_url_scheme( $url ) ); } +/** + * Create image tag markup for a custom header image. + * + * @since 4.4.0 + * + * @param array $attr Optional. Additional attributes for the image tag. Can be used + * to override the default attributes. Default empty. + * @return string HTML image element markup or empty string on failure. + */ +function get_header_image_tag( $attr = array() ) { + $header = get_custom_header(); + + if ( empty( $header->url ) ) { + return ''; + } + + $width = absint( $header->width ); + $height = absint( $header->height ); + + $attr = wp_parse_args( + $attr, + array( + 'src' => $header->url, + 'width' => $width, + 'height' => $height, + 'alt' => get_bloginfo( 'name' ), + ) + ); + + // Generate 'srcset' and 'sizes' if not already present. + if ( empty( $attr['srcset'] ) && ! empty( $header->attachment_id ) ) { + $image_meta = get_post_meta( $header->attachment_id, '_wp_attachment_metadata', true ); + $size_array = array( $width, $height ); + + if ( is_array( $image_meta ) ) { + $srcset = wp_calculate_image_srcset( $size_array, $header->url, $image_meta, $header->attachment_id ); + $sizes = ! empty( $attr['sizes'] ) ? $attr['sizes'] : wp_calculate_image_sizes( $size_array, $header->url, $image_meta, $header->attachment_id ); + + if ( $srcset && $sizes ) { + $attr['srcset'] = $srcset; + $attr['sizes'] = $sizes; + } + } + } + + $attr = array_map( 'esc_attr', $attr ); + $html = ' $value ) { + $html .= ' ' . $name . '="' . $value . '"'; + } + + $html .= ' />'; + + /** + * Filter the markup of header images. + * + * @since 4.4.0 + * + * @param string $html The HTML image tag markup being filtered. + * @param object $header The custom header object returned by 'get_custom_header()'. + * @param array $attr Array of the attributes for the image tag. + */ + return apply_filters( 'get_header_image_tag', $html, $header, $attr ); +} + +/** + * Display the image markup for a custom header image. + * + * @since 4.4.0 + * + * @param array $attr Optional. Attributes for the image markup. Default empty. + */ +function the_header_image_tag( $attr = array() ) { + echo get_header_image_tag( $attr ); +} + /** * Get random header image data from registered images in theme. * @@ -1073,11 +1099,13 @@ function get_header_image() { * * @access private * - * @return string Path to header image + * @global array $_wp_default_headers + * @staticvar object $_wp_random_header + * + * @return object */ - function _get_random_header_data() { - static $_wp_random_header; + static $_wp_random_header = null; if ( empty( $_wp_random_header ) ) { global $_wp_default_headers; @@ -1113,7 +1141,6 @@ function _get_random_header_data() { * * @return string Path to header image */ - function get_random_header_image() { $random_image = _get_random_header_data(); if ( empty( $random_image->url ) ) @@ -1131,7 +1158,7 @@ function get_random_header_image() { * @since 3.2.0 * * @param string $type The random pool to use. any|default|uploaded - * @return boolean + * @return bool */ function is_random_header_image( $type = 'any' ) { $header_image_mod = get_theme_mod( 'header_image', get_theme_support( 'custom-header', 'default-image' ) ); @@ -1180,11 +1207,14 @@ function get_uploaded_header_images() { foreach ( (array) $headers as $header ) { $url = esc_url_raw( wp_get_attachment_url( $header->ID ) ); $header_data = wp_get_attachment_metadata( $header->ID ); - $header_index = basename($url); + $header_index = $header->ID; + $header_images[$header_index] = array(); - $header_images[$header_index]['attachment_id'] = $header->ID; + $header_images[$header_index]['attachment_id'] = $header->ID; $header_images[$header_index]['url'] = $url; - $header_images[$header_index]['thumbnail_url'] = $url; + $header_images[$header_index]['thumbnail_url'] = $url; + $header_images[$header_index]['alt_text'] = get_post_meta( $header->ID, '_wp_attachment_image_alt', true ); + if ( isset( $header_data['width'] ) ) $header_images[$header_index]['width'] = $header_data['width']; if ( isset( $header_data['height'] ) ) @@ -1199,6 +1229,8 @@ function get_uploaded_header_images() { * * @since 3.4.0 * + * @global array $_wp_default_headers + * * @return object */ function get_custom_header() { @@ -1240,6 +1272,8 @@ function get_custom_header() { * * @since 3.0.0 * + * @global array $_wp_default_headers + * * @param array $headers Array of headers keyed by a string id. The ids point to arrays containing 'url', 'thumbnail_url', and 'description' keys. */ function register_default_headers( $headers ) { @@ -1257,6 +1291,8 @@ function register_default_headers( $headers ) { * @see register_default_headers() * @since 3.0.0 * + * @global array $_wp_default_headers + * * @param string|array $header The header string id (key of array) to remove, or an array thereof. * @return bool|void A single header returns true on success, false on failure. * There is currently no return value for multiple headers. @@ -1380,11 +1416,12 @@ body.custom-background { } * * @since 3.0.0 * + * @global array $editor_styles + * * @param array|string $stylesheet Optional. Stylesheet name or array thereof, relative to theme root. - * Defaults to 'editor-style.css' + * Defaults to 'editor-style.css' */ function add_editor_style( $stylesheet = 'editor-style.css' ) { - add_theme_support( 'editor-style' ); if ( ! is_admin() ) @@ -1406,6 +1443,8 @@ function add_editor_style( $stylesheet = 'editor-style.css' ) { * * @since 3.1.0 * + * @global array $editor_styles + * * @return bool True on success, false if there were no stylesheets to remove. */ function remove_editor_styles() { @@ -1422,7 +1461,7 @@ function remove_editor_styles() { * * @since 4.0.0 * - * @global $editor_styles Registered editor stylesheets + * @global array $editor_styles Registered editor stylesheets * * @return array If registered, a list of editor stylesheet URLs. */ @@ -1462,7 +1501,15 @@ function get_editor_stylesheets() { } } } - return $stylesheets; + + /** + * Filter the array of stylesheets applied to the editor. + * + * @since 4.3.0 + * + * @param array $stylesheets Array of stylesheets to be applied to the editor. + */ + return apply_filters( 'editor_stylesheets', $stylesheets ); } /** @@ -1474,6 +1521,8 @@ function get_editor_stylesheets() { * * @since 2.9.0 * + * @global array $_wp_theme_features + * * @param string $feature The feature being added. * @return void|bool False on failure, void otherwise. */ @@ -1510,6 +1559,26 @@ function add_theme_support( $feature ) { $args[0] = array_merge( $_wp_theme_features['html5'][0], $args[0] ); break; + case 'custom-logo': + if ( ! is_array( $args ) ) { + $args = array( 0 => array() ); + } + $defaults = array( + 'width' => null, + 'height' => null, + 'flex-width' => false, + 'flex-height' => false, + 'header-text' => '', + ); + $args[0] = wp_parse_args( array_intersect_key( $args[0], $defaults ), $defaults ); + + // Allow full flexibility if no size is specified. + if ( is_null( $args[0]['width'] ) && is_null( $args[0]['height'] ) ) { + $args[0]['flex-width'] = true; + $args[0]['flex-height'] = true; + } + break; + case 'custom-header-uploads' : return add_theme_support( 'custom-header', array( 'uploads' => true ) ); @@ -1647,6 +1716,9 @@ function add_theme_support( $feature ) { * * @since 3.4.0 * @access private + * + * @global Custom_Image_Header $custom_image_header + * @global Custom_Background $custom_background */ function _custom_header_background_just_in_time() { global $custom_image_header, $custom_background; @@ -1679,11 +1751,37 @@ function _custom_header_background_just_in_time() { } } +/** + * Adds CSS to hide header text for custom logo, based on Customizer setting. + * + * @since 4.5.0 + * @access private + */ +function _custom_logo_header_styles() { + if ( ! current_theme_supports( 'custom-header', 'header-text' ) && get_theme_support( 'custom-logo', 'header-text' ) && ! get_theme_mod( 'header_text', true ) ) { + $classes = (array) get_theme_support( 'custom-logo', 'header-text' ); + $classes = array_map( 'sanitize_html_class', $classes ); + $classes = '.' . implode( ', .', $classes ); + + ?> + + + get_data( 'customize-loader', 'data' ); if ( $data ) $script = "$data\n$script"; @@ -1985,7 +2101,8 @@ function _wp_customize_loader_settings() { * @since 3.4.0 * * @param string $stylesheet Optional. Theme to customize. Defaults to current theme. - * The theme's stylesheet will be urlencoded if necessary. + * The theme's stylesheet will be urlencoded if necessary. + * @return string */ function wp_customize_url( $stylesheet = null ) { $url = admin_url( 'customize.php' );