X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/596d585e1dc1eb25bccd3781e37210a4e2504179..16e7b37c7914d753890c1a05a9335f3b43751eb8:/wp-includes/theme.php diff --git a/wp-includes/theme.php b/wp-includes/theme.php index f449ae50..8aac86c9 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 ) { @@ -106,6 +111,20 @@ function wp_get_theme( $stylesheet = null, $theme_root = null ) { return new WP_Theme( $stylesheet, $theme_root ); } +/** + * Clears the cache held by get_theme_roots() and WP_Theme. + * + * @since 3.5.0 + * @param bool $clear_update_cache Whether to clear the Theme updates cache + */ +function wp_clean_themes_cache( $clear_update_cache = true ) { + if ( $clear_update_cache ) + delete_site_transient( 'update_themes' ); + search_theme_directories( true ); + foreach ( wp_get_themes( array( 'errors' => null ) ) as $theme ) + $theme->cache_delete(); +} + /** * Whether a child theme is in use. * @@ -123,23 +142,28 @@ function is_child_theme() { * The theme name that the administrator has currently set the front end theme * as. * - * For all extensive purposes, the template name and the stylesheet name are + * For all intents and purposes, the template name and the stylesheet name are * going to be the same for most cases. * * @since 1.5.0 - * @uses apply_filters() Calls 'stylesheet' filter on stylesheet name. * * @return string Stylesheet name. */ function get_stylesheet() { - return apply_filters('stylesheet', get_option('stylesheet')); + /** + * Filters the name of current stylesheet. + * + * @since 1.5.0 + * + * @param string $stylesheet Name of the current stylesheet. + */ + return apply_filters( 'stylesheet', get_option( 'stylesheet' ) ); } /** * Retrieve stylesheet directory path for current theme. * * @since 1.5.0 - * @uses apply_filters() Calls 'stylesheet_directory' filter on stylesheet directory and theme name. * * @return string Path to current theme directory. */ @@ -148,6 +172,15 @@ function get_stylesheet_directory() { $theme_root = get_theme_root( $stylesheet ); $stylesheet_dir = "$theme_root/$stylesheet"; + /** + * Filters the stylesheet directory path for current theme. + * + * @since 1.5.0 + * + * @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. + */ return apply_filters( 'stylesheet_directory', $stylesheet_dir, $stylesheet, $theme_root ); } @@ -159,32 +192,48 @@ function get_stylesheet_directory() { * @return string */ function get_stylesheet_directory_uri() { - $stylesheet = get_stylesheet(); + $stylesheet = str_replace( '%2F', '/', rawurlencode( get_stylesheet() ) ); $theme_root_uri = get_theme_root_uri( $stylesheet ); $stylesheet_dir_uri = "$theme_root_uri/$stylesheet"; + /** + * Filters the stylesheet directory URI. + * + * @since 1.5.0 + * + * @param string $stylesheet_dir_uri Stylesheet directory URI. + * @param string $stylesheet Name of the activated theme's directory. + * @param string $theme_root_uri Themes root URI. + */ return apply_filters( 'stylesheet_directory_uri', $stylesheet_dir_uri, $stylesheet, $theme_root_uri ); } /** - * Retrieve URI of current theme stylesheet. + * Retrieves the URI of current theme stylesheet. * - * The stylesheet file name is 'style.css' which is appended to {@link - * get_stylesheet_directory_uri() stylesheet directory URI} path. + * The stylesheet file name is 'style.css' which is appended to the stylesheet directory URI path. + * See get_stylesheet_directory_uri(). * * @since 1.5.0 - * @uses apply_filters() Calls 'stylesheet_uri' filter on stylesheet URI path and stylesheet directory URI. * * @return string */ function get_stylesheet_uri() { $stylesheet_dir_uri = get_stylesheet_directory_uri(); $stylesheet_uri = $stylesheet_dir_uri . '/style.css'; - return apply_filters('stylesheet_uri', $stylesheet_uri, $stylesheet_dir_uri); + /** + * Filters the URI of the current theme stylesheet. + * + * @since 1.5.0 + * + * @param string $stylesheet_uri Stylesheet URI for the current theme/child theme. + * @param string $stylesheet_dir_uri Stylesheet directory URI for the current theme/child theme. + */ + return apply_filters( 'stylesheet_uri', $stylesheet_uri, $stylesheet_dir_uri ); } /** - * Retrieve localized stylesheet URI. + * Retrieves the localized stylesheet URI. * * The stylesheet directory for the localized stylesheet files are located, by * default, in the base theme directory. The name of the locale file will be the @@ -192,13 +241,15 @@ function get_stylesheet_uri() { * stylesheet will be checked for existence, for example 'ltr.css'. * * The theme may change the location of the stylesheet directory by either using - * the 'stylesheet_directory_uri' filter or the 'locale_stylesheet_uri' filter. + * the {@see 'stylesheet_directory_uri'} or {@see 'locale_stylesheet_uri'} filters. + * * If you want to change the location of the stylesheet files for the entire * WordPress workflow, then change the former. If you just have the locale in a * separate folder, then change the latter. * * @since 2.1.0 - * @uses apply_filters() Calls 'locale_stylesheet_uri' filter on stylesheet URI path and stylesheet directory URI. + * + * @global WP_Locale $wp_locale * * @return string */ @@ -213,26 +264,39 @@ function get_locale_stylesheet_uri() { $stylesheet_uri = "$stylesheet_dir_uri/{$wp_locale->text_direction}.css"; else $stylesheet_uri = ''; - return apply_filters('locale_stylesheet_uri', $stylesheet_uri, $stylesheet_dir_uri); + /** + * Filters the localized stylesheet URI. + * + * @since 2.1.0 + * + * @param string $stylesheet_uri Localized stylesheet URI. + * @param string $stylesheet_dir_uri Stylesheet directory URI. + */ + return apply_filters( 'locale_stylesheet_uri', $stylesheet_uri, $stylesheet_dir_uri ); } /** * Retrieve name of the current theme. * * @since 1.5.0 - * @uses apply_filters() Calls 'template' filter on template option. * * @return string Template name. */ function get_template() { - return apply_filters('template', get_option('template')); + /** + * Filters the name of the current theme. + * + * @since 1.5.0 + * + * @param string $template Current theme's directory name. + */ + return apply_filters( 'template', get_option( 'template' ) ); } /** * Retrieve current theme directory. * * @since 1.5.0 - * @uses apply_filters() Calls 'template_directory' filter on template directory path and template name. * * @return string Template directory path. */ @@ -241,6 +305,15 @@ function get_template_directory() { $theme_root = get_theme_root( $template ); $template_dir = "$theme_root/$template"; + /** + * Filters the current theme directory path. + * + * @since 1.5.0 + * + * @param string $template_dir The URI of the current theme directory. + * @param string $template Directory name of the current theme. + * @param string $theme_root Absolute path to the themes directory. + */ return apply_filters( 'template_directory', $template_dir, $template, $theme_root ); } @@ -248,15 +321,23 @@ function get_template_directory() { * Retrieve theme directory URI. * * @since 1.5.0 - * @uses apply_filters() Calls 'template_directory_uri' filter on template directory URI path and template name. * * @return string Template directory URI. */ function get_template_directory_uri() { - $template = get_template(); + $template = str_replace( '%2F', '/', rawurlencode( get_template() ) ); $theme_root_uri = get_theme_root_uri( $template ); $template_dir_uri = "$theme_root_uri/$template"; + /** + * Filters the current theme directory URI. + * + * @since 1.5.0 + * + * @param string $template_dir_uri The URI of the current theme directory. + * @param string $template Directory name of the current theme. + * @param string $theme_root_uri The themes root URI. + */ return apply_filters( 'template_directory_uri', $template_dir_uri, $template, $theme_root_uri ); } @@ -265,6 +346,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() { @@ -286,6 +369,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 */ @@ -296,11 +381,19 @@ function register_theme_directory( $directory ) { // Try prepending as the theme directory could be relative to the content directory $directory = WP_CONTENT_DIR . '/' . $directory; // If this directory does not exist, return and do not register - if ( ! file_exists( $directory ) ) + if ( ! file_exists( $directory ) ) { return false; + } + } + + if ( ! is_array( $wp_theme_directories ) ) { + $wp_theme_directories = array(); } - $wp_theme_directories[] = $directory; + $untrailed = untrailingslashit( $directory ); + if ( ! empty( $untrailed ) && ! in_array( $untrailed, $wp_theme_directories ) ) { + $wp_theme_directories[] = $untrailed; + } return true; } @@ -310,25 +403,30 @@ 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; $found_themes = array(); $wp_theme_directories = (array) $wp_theme_directories; + $relative_theme_roots = array(); // Set up maybe-relative, maybe-absolute array of theme directories. // We always want to return absolute, but we need to cache relative - // use in for get_theme_root(). + // to use in get_theme_root(). foreach ( $wp_theme_directories as $theme_root ) { if ( 0 === strpos( $theme_root, WP_CONTENT_DIR ) ) $relative_theme_roots[ str_replace( WP_CONTENT_DIR, '', $theme_root ) ] = $theme_root; @@ -336,6 +434,14 @@ function search_theme_directories( $force = false ) { $relative_theme_roots[ $theme_root ] = $theme_root; } + /** + * Filters whether to get the cache of the registered theme directories. + * + * @since 3.4.0 + * + * @param bool $cache_expiration Whether to get the cache of the theme directories. Default false. + * @param string $cache_directory Directory to be searched for the cache. + */ if ( $cache_expiration = apply_filters( 'wp_cache_themes_persistently', false, 'search_theme_directories' ) ) { $cached_roots = get_site_transient( 'theme_roots' ); if ( is_array( $cached_roots ) ) { @@ -361,8 +467,10 @@ function search_theme_directories( $force = false ) { // Start with directories in the root of the current theme directory. $dirs = @ scandir( $theme_root ); - if ( ! $dirs ) - return false; + if ( ! $dirs ) { + trigger_error( "$theme_root is not readable", E_USER_NOTICE ); + continue; + } foreach ( $dirs as $dir ) { if ( ! is_dir( $theme_root . '/' . $dir ) || $dir[0] == '.' || $dir == 'CVS' ) continue; @@ -378,8 +486,10 @@ function search_theme_directories( $force = false ) { // wp-content/themes/a-folder-of-themes/* // wp-content/themes is $theme_root, a-folder-of-themes is $dir, then themes are $sub_dirs $sub_dirs = @ scandir( $theme_root . '/' . $dir ); - if ( ! $sub_dirs ) - return false; + if ( ! $sub_dirs ) { + trigger_error( "$theme_root/$dir is not readable", E_USER_NOTICE ); + continue; + } foreach ( $sub_dirs as $sub_dir ) { if ( ! is_dir( $theme_root . '/' . $dir . '/' . $sub_dir ) || $dir[0] == '.' || $dir == 'CVS' ) continue; @@ -423,7 +533,8 @@ function search_theme_directories( $force = false ) { * Does not have trailing slash. * * @since 1.5.0 - * @uses apply_filters() Calls 'theme_root' filter on path. + * + * @global array $wp_theme_directories * * @param string $stylesheet_or_template The stylesheet or template name of the theme * @return string Theme path. @@ -440,6 +551,13 @@ function get_theme_root( $stylesheet_or_template = false ) { $theme_root = WP_CONTENT_DIR . '/themes'; } + /** + * Filters the absolute path to the themes directory. + * + * @since 1.5.0 + * + * @param string $theme_root Absolute path to themes directory. + */ return apply_filters( 'theme_root', $theme_root ); } @@ -450,10 +568,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 ) { @@ -480,7 +600,16 @@ function get_theme_root_uri( $stylesheet_or_template = false, $theme_root = fals $theme_root_uri = content_url( 'themes' ); } - return apply_filters( 'theme_root_uri', $theme_root_uri, get_option('siteurl'), $stylesheet_or_template ); + /** + * Filters the URI for themes directory. + * + * @since 1.5.0 + * + * @param string $theme_root_uri The URI for themes directory. + * @param string $siteurl WordPress web address which is set in General Options. + * @param string $stylesheet_or_template Stylesheet or template name of the theme. + */ + return apply_filters( 'theme_root_uri', $theme_root_uri, get_option( 'siteurl' ), $stylesheet_or_template ); } /** @@ -488,8 +617,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 ) { @@ -530,131 +662,42 @@ function locale_stylesheet() { } /** - * Start preview theme output buffer. + * Switches the theme. * - * Will only preform 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' ); -} -add_action('setup_theme', 'preview_theme'); - -/** - * 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 + * Accepts one argument: $stylesheet of the theme. It also accepts an additional function signature + * of two arguments: $template then $stylesheet. This is for backward compatibility. * - * @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.5.0 * - * @since 2.6.0 - * @access private + * @global array $wp_theme_directories + * @global WP_Customize_Manager $wp_customize + * @global array $sidebars_widgets * - * @param array $matches - * @return string + * @param string $stylesheet Stylesheet name */ -function preview_theme_ob_filter_callback( $matches ) { - if ( strpos($matches[4], 'onclick') !== false ) - $matches[4] = preg_replace('#onclick=([\'"]).*?(?. (?post_value( $wp_customize->get_setting( 'old_sidebars_widgets_data' ) ); + } elseif ( is_array( $sidebars_widgets ) ) { + $_sidebars_widgets = $sidebars_widgets; + } - $link = add_query_arg( array( 'preview' => 1, 'template' => $_GET['template'], 'stylesheet' => @$_GET['stylesheet'], 'preview_iframe' => 1 ), $matches[3] ); - if ( 0 === strpos($link, 'preview=1') ) - $link = "?$link"; - return $matches[1] . esc_attr( $link ) . $matches[4]; -} + if ( is_array( $_sidebars_widgets ) ) { + set_theme_mod( 'sidebars_widgets', array( 'time' => time(), 'data' => $_sidebars_widgets ) ); + } -/** - * Switches current theme to new template and stylesheet names. - * - * @since 2.5.0 - * @uses do_action() Calls 'switch_theme' action, passing the new theme. - * - * @param string $template Template name - * @param string $stylesheet Stylesheet name. - */ -function switch_theme( $template, $stylesheet ) { - global $wp_theme_directories, $sidebars_widgets; + $nav_menu_locations = get_theme_mod( 'nav_menu_locations' ); - if ( is_array( $sidebars_widgets ) ) - set_theme_mod( 'sidebars_widgets', array( 'time' => time(), 'data' => $sidebars_widgets ) ); + if ( func_num_args() > 1 ) { + $stylesheet = func_get_arg( 1 ); + } - $old_theme = wp_get_theme(); + $old_theme = wp_get_theme(); $new_theme = wp_get_theme( $stylesheet ); - $new_name = $new_theme->get('Name'); + $template = $new_theme->get_template(); update_option( 'template', $template ); update_option( 'stylesheet', $stylesheet ); @@ -662,25 +705,63 @@ function switch_theme( $template, $stylesheet ) { if ( count( $wp_theme_directories ) > 1 ) { update_option( 'template_root', get_raw_theme_root( $template, true ) ); update_option( 'stylesheet_root', get_raw_theme_root( $stylesheet, true ) ); + } else { + delete_option( 'template_root' ); + delete_option( 'stylesheet_root' ); } + $new_name = $new_theme->get('Name'); + update_option( 'current_theme', $new_name ); + // 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 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() ); - do_action( 'switch_theme', $new_name, $new_theme ); + + /** + * 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, $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 + * + * You can use the {@see 'validate_current_theme'} filter to return false to * disable this functionality. * * @since 1.5.0 @@ -689,26 +770,49 @@ function switch_theme( $template, $stylesheet ) { * @return bool */ function validate_current_theme() { - // Don't validate during an install/upgrade. - if ( defined('WP_INSTALLING') || !apply_filters( 'validate_current_theme', true ) ) + /** + * Filters whether to validate the current theme. + * + * @since 2.7.0 + * + * @param bool $validate Whether to validate the current theme. Default 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, 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') ) { - switch_theme( WP_DEFAULT_THEME, WP_DEFAULT_THEME ); + $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, 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; } /** @@ -716,11 +820,12 @@ function validate_current_theme() { * * @since 3.1.0 * - * @return array 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'); @@ -737,27 +842,40 @@ function get_theme_mods() { * Retrieve theme modification value for the current theme. * * If the modification name does not exist, then the $default will be passed - * through {@link http://php.net/sprintf sprintf()} PHP function with the first + * through {@link https://secure.php.net/sprintf sprintf()} PHP function with the first * string the template directory URI and the second string the stylesheet * directory URI. * * @since 2.1.0 - * @uses apply_filters() Calls 'theme_mod_$name' filter on the value. * - * @param string $name Theme modification name. + * @param string $name Theme modification name. * @param bool|string $default * @return string */ function get_theme_mod( $name, $default = false ) { $mods = get_theme_mods(); - if ( isset( $mods[ $name ] ) ) - return apply_filters( "theme_mod_$name", $mods[ $name ] ); + if ( isset( $mods[$name] ) ) { + /** + * Filters the theme modification, or 'theme_mod', value. + * + * The dynamic portion of the hook name, `$name`, refers to + * the key name of the modification array. For example, + * 'header_textcolor', 'header_image', and so on depending + * on the theme options. + * + * @since 2.2.0 + * + * @param string $current_mod The value of the current theme modification. + */ + return apply_filters( "theme_mod_{$name}", $mods[$name] ); + } if ( is_string( $default ) ) $default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() ); - return apply_filters( "theme_mod_$name", $default ); + /** This filter is documented in wp-includes/theme.php */ + return apply_filters( "theme_mod_{$name}", $default ); } /** @@ -765,13 +883,26 @@ function get_theme_mod( $name, $default = false ) { * * @since 2.1.0 * - * @param string $name Theme modification name. - * @param string $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(); - - $mods[ $name ] = $value; + $old_value = isset( $mods[ $name ] ) ? $mods[ $name ] : false; + + /** + * Filters the theme mod value on save. + * + * The dynamic portion of the hook name, `$name`, refers to the key name of + * the modification array. For example, 'header_textcolor', 'header_image', + * and so on depending on the theme options. + * + * @since 3.9.0 + * + * @param string $value The new value of the theme mod. + * @param string $old_value The current value of the theme mod. + */ + $mods[ $name ] = apply_filters( "pre_set_theme_mod_{$name}", $value, $old_value ); $theme = get_option( 'stylesheet' ); update_option( "theme_mods_$theme", $mods ); @@ -786,7 +917,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(); @@ -796,9 +926,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 ); } @@ -819,18 +950,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 */ @@ -850,7 +981,20 @@ 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; +} + +/** + * Check whether a header image is set or not. + * + * @since 4.2.0 + * + * @see get_header_image() + * + * @return bool Whether a header image is set or not. + */ +function has_header_image() { + return (bool) get_header_image(); } /** @@ -858,7 +1002,7 @@ function display_header_text() { * * @since 2.1.0 * - * @return string + * @return string|false */ function get_header_image() { $url = get_theme_mod( 'header_image', get_theme_support( 'custom-header', 'default-image' ) ); @@ -869,12 +1013,85 @@ function get_header_image() { if ( is_random_header_image() ) $url = get_random_header_image(); - if ( is_ssl() ) - $url = str_replace( 'http://', 'https://', $url ); - else - $url = str_replace( 'https://', 'http://', $url ); + return esc_url_raw( set_url_scheme( $url ) ); +} - return esc_url_raw( $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(); + $header->url = get_header_image(); + + if ( ! $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 .= ' />'; + + /** + * Filters 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 ); } /** @@ -884,11 +1101,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; @@ -924,7 +1143,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 ) ) @@ -942,7 +1160,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' ) ); @@ -961,12 +1179,15 @@ function is_random_header_image( $type = 'any' ) { } /** - * Display header image path. + * Display header image URL. * * @since 2.1.0 */ function header_image() { - echo get_header_image(); + $image = get_header_image(); + if ( $image ) { + echo esc_url( $image ); + } } /** @@ -986,15 +1207,20 @@ function get_uploaded_header_images() { return array(); foreach ( (array) $headers as $header ) { - $url = esc_url_raw( $header->guid ); + $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]['width'] = $header_data['width']; - $header_images[$header_index]['height'] = $header_data['height']; + $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'] ) ) + $header_images[$header_index]['height'] = $header_data['height']; } return $header_images; @@ -1005,15 +1231,41 @@ function get_uploaded_header_images() { * * @since 3.4.0 * + * @global array $_wp_default_headers + * * @return object */ function get_custom_header() { - $data = is_random_header_image()? _get_random_header_data() : get_theme_mod( 'header_image_data' ); + global $_wp_default_headers; + + if ( is_random_header_image() ) { + $data = _get_random_header_data(); + } else { + $data = get_theme_mod( 'header_image_data' ); + if ( ! $data && current_theme_supports( 'custom-header', 'default-image' ) ) { + $directory_args = array( get_template_directory_uri(), get_stylesheet_directory_uri() ); + $data = array(); + $data['url'] = $data['thumbnail_url'] = vsprintf( get_theme_support( 'custom-header', 'default-image' ), $directory_args ); + if ( ! empty( $_wp_default_headers ) ) { + foreach ( (array) $_wp_default_headers as $default_header ) { + $url = vsprintf( $default_header['url'], $directory_args ); + if ( $data['url'] == $url ) { + $data = $default_header; + $data['url'] = $url; + $data['thumbnail_url'] = vsprintf( $data['thumbnail_url'], $directory_args ); + break; + } + } + } + } + } + $default = array( 'url' => '', 'thumbnail_url' => '', 'width' => get_theme_support( 'custom-header', 'width' ), 'height' => get_theme_support( 'custom-header', 'height' ), + 'video' => get_theme_support( 'custom-header', 'video' ), ); return (object) wp_parse_args( $data, $default ); } @@ -1023,6 +1275,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 ) { @@ -1040,8 +1294,11 @@ 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 True on success, false on failure. + * @return bool|void A single header returns true on success, false on failure. + * There is currently no return value for multiple headers. */ function unregister_default_headers( $header ) { global $_wp_default_headers; @@ -1055,6 +1312,180 @@ function unregister_default_headers( $header ) { } } +/** + * Check whether a header video is set or not. + * + * @since 4.7.0 + * + * @see get_header_video_url() + * + * @return bool Whether a header video is set or not. + */ +function has_header_video() { + return (bool) get_header_video_url(); +} + +/* Retrieve header video URL for custom header. + * + * Uses a local video if present, or falls back to an external video. Returns false if there is no video. + * + * @since 4.7.0 + * + * @return string|false + */ +function get_header_video_url() { + $id = absint( get_theme_mod( 'header_video' ) ); + $url = esc_url( get_theme_mod( 'external_header_video' ) ); + + if ( ! $id && ! $url ) { + return false; + } + + if ( $id ) { + // Get the file URL from the attachment ID. + $url = wp_get_attachment_url( $id ); + } + + return esc_url_raw( set_url_scheme( $url ) ); +} + +/** + * Display header video URL. + * + * @since 4.7.0 + */ +function the_header_video_url() { + $video = get_header_video_url(); + if ( $video ) { + echo esc_url( $video ); + } +} + +/** + * Retrieve header video settings. + * + * @since 4.7.0 + * + * @return array + */ +function get_header_video_settings() { + $header = get_custom_header(); + $video_url = get_header_video_url(); + $video_type = wp_check_filetype( $video_url, wp_get_mime_types() ); + + $settings = array( + 'mimeType' => '', + 'posterUrl' => get_header_image(), + 'videoUrl' => $video_url, + 'width' => absint( $header->width ), + 'height' => absint( $header->height ), + 'minWidth' => 900, + 'minHeight' => 500, + 'l10n' => array( + 'pause' => __( 'Pause' ), + 'play' => __( 'Play' ), + 'pauseSpeak' => __( 'Video is paused.'), + 'playSpeak' => __( 'Video is playing.'), + ), + ); + + if ( preg_match( '#^https?://(?:www\.)?(?:youtube\.com/watch|youtu\.be/)#', $video_url ) ) { + $settings['mimeType'] = 'video/x-youtube'; + } elseif ( ! empty( $video_type['type'] ) ) { + $settings['mimeType'] = $video_type['type']; + } + + return apply_filters( 'header_video_settings', $settings ); +} + +/** + * Check whether a custom header is set or not. + * + * @since 4.7.0 + * + * @return bool True if a custom header is set. False if not. + */ +function has_custom_header() { + if ( has_header_image() || ( has_header_video() && is_header_video_active() ) ) { + return true; + } + + return false; +} + +/** + * Checks whether the custom header video is eligible to show on the current page. + * + * @since 4.7.0 + * + * @return bool True if the custom header video should be shown. False if not. + */ +function is_header_video_active() { + if ( ! get_theme_support( 'custom-header', 'video' ) ) { + return false; + } + + $video_active_cb = get_theme_support( 'custom-header', 'video-active-callback' ); + + if ( empty( $video_active_cb ) || ! is_callable( $video_active_cb ) ) { + $show_video = true; + } else { + $show_video = call_user_func( $video_active_cb ); + } + + /** + * Modify whether the custom header video is eligible to show on the current page. + * + * @since 4.7.0 + * + * @param bool $show_video Whether the custom header video should be shown. Returns the value + * of the theme setting for the `custom-header`'s `video-active-callback`. + * If no callback is set, the default value is that of `is_front_page()`. + */ + return apply_filters( 'is_header_video_active', $show_video ); +} + +/** + * Retrieve the markup for a custom header. + * + * The container div will always be returned in the Customizer preview. + * + * @since 4.7.0 + * + * @return string The markup for a custom header on success. + */ +function get_custom_header_markup() { + if ( ! has_custom_header() && ! is_customize_preview() ) { + return ''; + } + + return sprintf( + '
%s
', + get_header_image_tag() + ); +} + +/** + * Print the markup for a custom header. + * + * A container div will always be printed in the Customizer preview. + * + * @since 4.7.0 + */ +function the_custom_header_markup() { + $custom_header = get_custom_header_markup(); + if ( empty( $custom_header ) ) { + return; + } + + echo $custom_header; + + if ( is_header_video_active() && ( has_header_video() || is_customize_preview() ) ) { + wp_enqueue_script( 'wp-custom-header' ); + wp_localize_script( 'wp-custom-header', '_wpCustomHeaderSettings', get_header_video_settings() ); + } +} + /** * Retrieve background image for custom background. * @@ -1103,36 +1534,70 @@ function background_color() { */ function _custom_background_cb() { // $background is the saved custom image, or the default image. - $background = get_background_image(); + $background = set_url_scheme( get_background_image() ); // $color is the saved custom color. // A default has to be specified in style.css. It will not be printed here. - $color = get_theme_mod( 'background_color' ); + $color = get_background_color(); - if ( ! $background && ! $color ) + if ( $color === get_theme_support( 'custom-background', 'default-color' ) ) { + $color = false; + } + + if ( ! $background && ! $color ) { + if ( is_customize_preview() ) { + echo ''; + } return; + } $style = $color ? "background-color: #$color;" : ''; if ( $background ) { - $image = " background-image: url('$background');"; + $image = " background-image: url(" . wp_json_encode( $background ) . ");"; + + // Background Position. + $position_x = get_theme_mod( 'background_position_x', get_theme_support( 'custom-background', 'default-position-x' ) ); + $position_y = get_theme_mod( 'background_position_y', get_theme_support( 'custom-background', 'default-position-y' ) ); + + if ( ! in_array( $position_x, array( 'left', 'center', 'right' ), true ) ) { + $position_x = 'left'; + } + + if ( ! in_array( $position_y, array( 'top', 'center', 'bottom' ), true ) ) { + $position_y = 'top'; + } + + $position = " background-position: $position_x $position_y;"; + + // Background Size. + $size = get_theme_mod( 'background_size', get_theme_support( 'custom-background', 'default-size' ) ); - $repeat = get_theme_mod( 'background_repeat', 'repeat' ); - if ( ! in_array( $repeat, array( 'no-repeat', 'repeat-x', 'repeat-y', 'repeat' ) ) ) + if ( ! in_array( $size, array( 'auto', 'contain', 'cover' ), true ) ) { + $size = 'auto'; + } + + $size = " background-size: $size;"; + + // Background Repeat. + $repeat = get_theme_mod( 'background_repeat', get_theme_support( 'custom-background', 'default-repeat' ) ); + + if ( ! in_array( $repeat, array( 'repeat-x', 'repeat-y', 'repeat', 'no-repeat' ), true ) ) { $repeat = 'repeat'; + } + $repeat = " background-repeat: $repeat;"; - $position = get_theme_mod( 'background_position_x', 'left' ); - if ( ! in_array( $position, array( 'center', 'right', 'left' ) ) ) - $position = 'left'; - $position = " background-position: top $position;"; + // Background Scroll. + $attachment = get_theme_mod( 'background_attachment', get_theme_support( 'custom-background', 'default-attachment' ) ); - $attachment = get_theme_mod( 'background_attachment', 'scroll' ); - if ( ! in_array( $attachment, array( 'fixed', 'scroll' ) ) ) + if ( 'fixed' !== $attachment ) { $attachment = 'scroll'; + } + $attachment = " background-attachment: $attachment;"; - $style .= $image . $repeat . $position . $attachment; + $style .= $image . $position . $size . $repeat . $attachment; } ?> + 'custom_css', + 'post_status' => get_post_stati(), + 'name' => sanitize_title( $stylesheet ), + 'posts_per_page' => 1, + 'no_found_rows' => true, + 'cache_results' => true, + 'update_post_meta_cache' => false, + 'update_term_meta_cache' => false, + ); + + $post = null; + if ( get_stylesheet() === $stylesheet ) { + $post_id = get_theme_mod( 'custom_css_post_id' ); + + if ( $post_id > 0 && get_post( $post_id ) ) { + $post = get_post( $post_id ); + } else { + $query = new WP_Query( $custom_css_query_vars ); + $post = $query->post; + /* + * Cache the lookup. See WP_Customize_Custom_CSS_Setting::update(). + * @todo This should get cleared if a custom_css post is added/removed. + */ + if ( $post ) { + set_theme_mod( 'custom_css_post_id', $post->ID ); + } elseif ( -1 !== $post_id ) { + set_theme_mod( 'custom_css_post_id', -1 ); + } + } + } else { + $query = new WP_Query( $custom_css_query_vars ); + $post = $query->post; + } + + return $post; +} + +/** + * Fetch the saved Custom CSS content for rendering. + * + * @since 4.7.0 + * @access public + * + * @param string $stylesheet Optional. A theme object stylesheet name. Defaults to the current theme. + * @return string The Custom CSS Post content. + */ +function wp_get_custom_css( $stylesheet = '' ) { + $css = ''; + + if ( empty( $stylesheet ) ) { + $stylesheet = get_stylesheet(); + } + + $post = wp_get_custom_css_post( $stylesheet ); + if ( $post ) { + $css = $post->post_content; + } + + /** + * Modify the Custom CSS Output into the . + * + * @since 4.7.0 + * + * @param string $css CSS pulled in from the Custom CSS CPT. + * @param string $stylesheet The theme stylesheet name. + */ + $css = apply_filters( 'wp_get_custom_css', $css, $stylesheet ); + + return $css; +} + +/** + * Update the `custom_css` post for a given theme. + * + * Inserts a `custom_css` post when one doesn't yet exist. + * + * @since 4.7.0 + * @access public + * + * @param string $css CSS, stored in `post_content`. + * @param array $args { + * Args. + * + * @type string $preprocessed Pre-processed CSS, stored in `post_content_filtered`. Normally empty string. Optional. + * @type string $stylesheet Stylesheet (child theme) to update. Optional, defaults to current theme/stylesheet. + * } + * @return WP_Post|WP_Error Post on success, error on failure. + */ +function wp_update_custom_css_post( $css, $args = array() ) { + $args = wp_parse_args( $args, array( + 'preprocessed' => '', + 'stylesheet' => get_stylesheet(), + ) ); + + $data = array( + 'css' => $css, + 'preprocessed' => $args['preprocessed'], + ); + + /** + * Filters the `css` (`post_content`) and `preprocessed` (`post_content_filtered`) args for a `custom_css` post being updated. + * + * This filter can be used by plugin that offer CSS pre-processors, to store the original + * pre-processed CSS in `post_content_filtered` and then store processed CSS in `post_content`. + * When used in this way, the `post_content_filtered` should be supplied as the setting value + * instead of `post_content` via a the `customize_value_custom_css` filter, for example: + * + * + * add_filter( 'customize_value_custom_css', function( $value, $setting ) { + * $post = wp_get_custom_css_post( $setting->stylesheet ); + * if ( $post && ! empty( $post->post_content_filtered ) ) { + * $css = $post->post_content_filtered; + * } + * return $css; + * }, 10, 2 ); + * + * + * @since 4.7.0 + * @param array $data { + * Custom CSS data. + * + * @type string $css CSS stored in `post_content`. + * @type string $preprocessed Pre-processed CSS stored in `post_content_filtered`. Normally empty string. + * } + * @param array $args { + * The args passed into `wp_update_custom_css_post()` merged with defaults. + * + * @type string $css The original CSS passed in to be updated. + * @type string $preprocessed The original preprocessed CSS passed in to be updated. + * @type string $stylesheet The stylesheet (theme) being updated. + * } + */ + $data = apply_filters( 'update_custom_css_data', $data, array_merge( $args, compact( 'css' ) ) ); + + $post_data = array( + 'post_title' => $args['stylesheet'], + 'post_name' => sanitize_title( $args['stylesheet'] ), + 'post_type' => 'custom_css', + 'post_status' => 'publish', + 'post_content' => $data['css'], + 'post_content_filtered' => $data['preprocessed'], + ); + + // Update post if it already exists, otherwise create a new one. + $post = wp_get_custom_css_post( $args['stylesheet'] ); + if ( $post ) { + $post_data['ID'] = $post->ID; + $r = wp_update_post( wp_slash( $post_data ), true ); + } else { + $r = wp_insert_post( wp_slash( $post_data ), true ); + + // Trigger creation of a revision. This should be removed once #30854 is resolved. + if ( ! is_wp_error( $r ) && 0 === count( wp_get_post_revisions( $r ) ) ) { + wp_save_post_revision( $r ); + } + } + + if ( is_wp_error( $r ) ) { + return $r; + } + return get_post( $r ); +} + /** * Add callback for custom TinyMCE editor stylesheets. * @@ -1158,11 +1816,12 @@ body.custom-background { } * * @since 3.0.0 * - * @param mixed $stylesheet Optional. Stylesheet name or array thereof, relative to theme root. - * Defaults to 'editor-style.css' + * @global array $editor_styles + * + * @param array|string $stylesheet Optional. Stylesheet name or array thereof, relative to theme root. + * Defaults to 'editor-style.css' */ function add_editor_style( $stylesheet = 'editor-style.css' ) { - add_theme_support( 'editor-style' ); if ( ! is_admin() ) @@ -1184,6 +1843,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() { @@ -1196,14 +1857,347 @@ function remove_editor_styles() { } /** - * Allows a theme to register its support of a certain feature + * Retrieve any registered editor stylesheets + * + * @since 4.0.0 + * + * @global array $editor_styles Registered editor stylesheets + * + * @return array If registered, a list of editor stylesheet URLs. + */ +function get_editor_stylesheets() { + $stylesheets = array(); + // load editor_style.css if the current theme supports it + if ( ! empty( $GLOBALS['editor_styles'] ) && is_array( $GLOBALS['editor_styles'] ) ) { + $editor_styles = $GLOBALS['editor_styles']; + + $editor_styles = array_unique( array_filter( $editor_styles ) ); + $style_uri = get_stylesheet_directory_uri(); + $style_dir = get_stylesheet_directory(); + + // Support externally referenced styles (like, say, fonts). + foreach ( $editor_styles as $key => $file ) { + if ( preg_match( '~^(https?:)?//~', $file ) ) { + $stylesheets[] = esc_url_raw( $file ); + unset( $editor_styles[ $key ] ); + } + } + + // Look in a parent theme first, that way child theme CSS overrides. + if ( is_child_theme() ) { + $template_uri = get_template_directory_uri(); + $template_dir = get_template_directory(); + + foreach ( $editor_styles as $key => $file ) { + if ( $file && file_exists( "$template_dir/$file" ) ) { + $stylesheets[] = "$template_uri/$file"; + } + } + } + + foreach ( $editor_styles as $file ) { + if ( $file && file_exists( "$style_dir/$file" ) ) { + $stylesheets[] = "$style_uri/$file"; + } + } + } + + /** + * Filters 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 ); +} + +/** + * Expand a theme's starter content configuration using core-provided data. + * + * @since 4.7.0 + * + * @return array Array of starter content. + */ +function get_theme_starter_content() { + $theme_support = get_theme_support( 'starter-content' ); + if ( is_array( $theme_support ) && ! empty( $theme_support[0] ) && is_array( $theme_support[0] ) ) { + $config = $theme_support[0]; + } else { + $config = array(); + } + + $core_content = array( + 'widgets' => array( + 'text_business_info' => array( 'text', array( + 'title' => _x( 'Find Us', 'Theme starter content' ), + 'text' => join( '', array( + '

' . _x( 'Address', 'Theme starter content' ) . '
', + _x( '123 Main Street', 'Theme starter content' ) . '
' . _x( 'New York, NY 10001', 'Theme starter content' ) . '

', + '

' . _x( 'Hours', 'Theme starter content' ) . '
', + _x( 'Monday—Friday: 9:00AM–5:00PM', 'Theme starter content' ) . '
' . _x( 'Saturday & Sunday: 11:00AM–3:00PM', 'Theme starter content' ) . '

' + ) ), + ) ), + 'text_about' => array( 'text', array( + 'title' => _x( 'About This Site', 'Theme starter content' ), + 'text' => _x( 'This may be a good place to introduce yourself and your site or include some credits.', 'Theme starter content' ), + ) ), + 'archives' => array( 'archives', array( + 'title' => _x( 'Archives', 'Theme starter content' ), + ) ), + 'calendar' => array( 'calendar', array( + 'title' => _x( 'Calendar', 'Theme starter content' ), + ) ), + 'categories' => array( 'categories', array( + 'title' => _x( 'Categories', 'Theme starter content' ), + ) ), + 'meta' => array( 'meta', array( + 'title' => _x( 'Meta', 'Theme starter content' ), + ) ), + 'recent-comments' => array( 'recent-comments', array( + 'title' => _x( 'Recent Comments', 'Theme starter content' ), + ) ), + 'recent-posts' => array( 'recent-posts', array( + 'title' => _x( 'Recent Posts', 'Theme starter content' ), + ) ), + 'search' => array( 'search', array( + 'title' => _x( 'Search', 'Theme starter content' ), + ) ), + ), + 'nav_menus' => array( + 'page_home' => array( + 'type' => 'post_type', + 'object' => 'page', + 'object_id' => '{{home}}', + ), + 'page_about' => array( + 'type' => 'post_type', + 'object' => 'page', + 'object_id' => '{{about}}', + ), + 'page_blog' => array( + 'type' => 'post_type', + 'object' => 'page', + 'object_id' => '{{blog}}', + ), + 'page_news' => array( + 'type' => 'post_type', + 'object' => 'page', + 'object_id' => '{{news}}', + ), + 'page_contact' => array( + 'type' => 'post_type', + 'object' => 'page', + 'object_id' => '{{contact}}', + ), + + 'link_email' => array( + 'title' => _x( 'Email', 'Theme starter content' ), + 'url' => 'mailto:wordpress@example.com', + ), + 'link_facebook' => array( + 'title' => _x( 'Facebook', 'Theme starter content' ), + 'url' => 'https://www.facebook.com/wordpress', + ), + 'link_foursquare' => array( + 'title' => _x( 'Foursquare', 'Theme starter content' ), + 'url' => 'https://foursquare.com/', + ), + 'link_github' => array( + 'title' => _x( 'GitHub', 'Theme starter content' ), + 'url' => 'https://github.com/wordpress/', + ), + 'link_instagram' => array( + 'title' => _x( 'Instagram', 'Theme starter content' ), + 'url' => 'https://www.instagram.com/explore/tags/wordcamp/', + ), + 'link_linkedin' => array( + 'title' => _x( 'LinkedIn', 'Theme starter content' ), + 'url' => 'https://www.linkedin.com/company/1089783', + ), + 'link_pinterest' => array( + 'title' => _x( 'Pinterest', 'Theme starter content' ), + 'url' => 'https://www.pinterest.com/', + ), + 'link_twitter' => array( + 'title' => _x( 'Twitter', 'Theme starter content' ), + 'url' => 'https://twitter.com/wordpress', + ), + 'link_yelp' => array( + 'title' => _x( 'Yelp', 'Theme starter content' ), + 'url' => 'https://www.yelp.com', + ), + 'link_youtube' => array( + 'title' => _x( 'YouTube', 'Theme starter content' ), + 'url' => 'https://www.youtube.com/channel/UCdof4Ju7amm1chz1gi1T2ZA', + ), + ), + 'posts' => array( + 'home' => array( + 'post_type' => 'page', + 'post_title' => _x( 'Home', 'Theme starter content' ), + 'post_content' => _x( 'Welcome to your site! This is your homepage, which is what most visitors will see when they come to your site for the first time.', 'Theme starter content' ), + ), + 'about' => array( + 'post_type' => 'page', + 'post_title' => _x( 'About', 'Theme starter content' ), + 'post_content' => _x( 'You might be an artist who would like to introduce yourself and your work here or maybe you’re a business with a mission to describe.', 'Theme starter content' ), + ), + 'contact' => array( + 'post_type' => 'page', + 'post_title' => _x( 'Contact', 'Theme starter content' ), + 'post_content' => _x( 'This is a page with some basic contact information, such as an address and phone number. You might also try a plugin to add a contact form.', 'Theme starter content' ), + ), + 'blog' => array( + 'post_type' => 'page', + 'post_title' => _x( 'Blog', 'Theme starter content' ), + ), + 'news' => array( + 'post_type' => 'page', + 'post_title' => _x( 'News', 'Theme starter content' ), + ), + + 'homepage-section' => array( + 'post_type' => 'page', + 'post_title' => _x( 'A homepage section', 'Theme starter content' ), + 'post_content' => _x( 'This is an example of a homepage section. Homepage sections can be any page other than the homepage itself, including the page that shows your latest blog posts.', 'Theme starter content' ), + ), + ), + ); + + $content = array(); + + foreach ( $config as $type => $args ) { + switch( $type ) { + // Use options and theme_mods as-is. + case 'options' : + case 'theme_mods' : + $content[ $type ] = $config[ $type ]; + break; + + // Widgets are grouped into sidebars. + case 'widgets' : + foreach ( $config[ $type ] as $sidebar_id => $widgets ) { + foreach ( $widgets as $id => $widget ) { + if ( is_array( $widget ) ) { + + // Item extends core content. + if ( ! empty( $core_content[ $type ][ $id ] ) ) { + $widget = array( + $core_content[ $type ][ $id ][0], + array_merge( $core_content[ $type ][ $id ][1], $widget ), + ); + } + + $content[ $type ][ $sidebar_id ][] = $widget; + } elseif ( is_string( $widget ) && ! empty( $core_content[ $type ] ) && ! empty( $core_content[ $type ][ $widget ] ) ) { + $content[ $type ][ $sidebar_id ][] = $core_content[ $type ][ $widget ]; + } + } + } + break; + + // And nav menu items are grouped into nav menus. + case 'nav_menus' : + foreach ( $config[ $type ] as $nav_menu_location => $nav_menu ) { + + // Ensure nav menus get a name. + if ( empty( $nav_menu['name'] ) ) { + $nav_menu['name'] = $nav_menu_location; + } + + $content[ $type ][ $nav_menu_location ]['name'] = $nav_menu['name']; + + foreach ( $nav_menu['items'] as $id => $nav_menu_item ) { + if ( is_array( $nav_menu_item ) ) { + + // Item extends core content. + if ( ! empty( $core_content[ $type ][ $id ] ) ) { + $nav_menu_item = array_merge( $core_content[ $type ][ $id ], $nav_menu_item ); + } + + $content[ $type ][ $nav_menu_location ]['items'][] = $nav_menu_item; + } elseif ( is_string( $nav_menu_item ) && ! empty( $core_content[ $type ] ) && ! empty( $core_content[ $type ][ $nav_menu_item ] ) ) { + $content[ $type ][ $nav_menu_location ]['items'][] = $core_content[ $type ][ $nav_menu_item ]; + } + } + } + break; + + // Attachments are posts but have special treatment. + case 'attachments' : + foreach ( $config[ $type ] as $id => $item ) { + if ( ! empty( $item['file'] ) ) { + $content[ $type ][ $id ] = $item; + } + } + break; + + // All that's left now are posts (besides attachments). Not a default case for the sake of clarity and future work. + case 'posts' : + foreach ( $config[ $type ] as $id => $item ) { + if ( is_array( $item ) ) { + + // Item extends core content. + if ( ! empty( $core_content[ $type ][ $id ] ) ) { + $item = array_merge( $core_content[ $type ][ $id ], $item ); + } + + // Enforce a subset of fields. + $content[ $type ][ $id ] = wp_array_slice_assoc( + $item, + array( + 'post_type', + 'post_title', + 'post_excerpt', + 'post_name', + 'post_content', + 'menu_order', + 'comment_status', + 'thumbnail', + 'template', + ) + ); + } elseif ( is_string( $item ) && ! empty( $core_content[ $type ][ $item ] ) ) { + $content[ $type ][ $item ] = $core_content[ $type ][ $item ]; + } + } + break; + } + } + + /** + * Filters the expanded array of starter content. + * + * @since 4.7.0 + * + * @param array $content Array of starter content. + * @param array $config Array of theme-specific starter content configuration. + */ + return apply_filters( 'get_theme_starter_content', $content, $config ); +} + +/** + * Registers theme support for a given feature. * * Must be called in the theme's functions.php file to work. - * If attached to a hook, it must be after_setup_theme. - * The init hook may be too late for some features. + * If attached to a hook, it must be {@see 'after_setup_theme'}. + * The {@see 'init'} hook may be too late for some features. * * @since 2.9.0 - * @param string $feature the feature being added + * @since 3.6.0 The `html5` feature was added + * @since 3.9.0 The `html5` feature now also accepts 'gallery' and 'caption' + * @since 4.1.0 The `title-tag` feature was added + * @since 4.5.0 The `customize-selective-refresh-widgets` feature was added + * @since 4.7.0 The `starter-content` feature was added + * + * @global array $_wp_theme_features + * + * @param string $feature The feature being added. Likely core values include 'post-formats', + * 'post-thumbnails', 'html5', 'custom-logo', 'custom-header-uploads', + * 'custom-header', 'custom-background', 'title-tag', 'starter-content', etc. + * @param mixed $args,... Optional extra arguments to pass along with certain features. + * @return void|bool False on failure, void otherwise. */ function add_theme_support( $feature ) { global $_wp_theme_features; @@ -1214,14 +2208,68 @@ function add_theme_support( $feature ) { $args = array_slice( func_get_args(), 1 ); switch ( $feature ) { + case 'post-thumbnails': + // All post types are already supported. + if ( true === get_theme_support( 'post-thumbnails' ) ) { + return; + } + + /* + * Merge post types with any that already declared their support + * for post thumbnails. + */ + if ( is_array( $args[0] ) && isset( $_wp_theme_features['post-thumbnails'] ) ) { + $args[0] = array_unique( array_merge( $_wp_theme_features['post-thumbnails'][0], $args[0] ) ); + } + + break; + case 'post-formats' : - if ( is_array( $args[0] ) ) - $args[0] = array_intersect( $args[0], array_keys( get_post_format_slugs() ) ); + if ( is_array( $args[0] ) ) { + $post_formats = get_post_format_slugs(); + unset( $post_formats['standard'] ); + + $args[0] = array_intersect( $args[0], array_keys( $post_formats ) ); + } + break; + + case 'html5' : + // You can't just pass 'html5', you need to pass an array of types. + if ( empty( $args[0] ) ) { + // Build an array of types for back-compat. + $args = array( 0 => array( 'comment-list', 'comment-form', 'search-form' ) ); + } elseif ( ! is_array( $args[0] ) ) { + _doing_it_wrong( "add_theme_support( 'html5' )", __( 'You need to pass an array of types.' ), '3.6.1' ); + return false; + } + + // Calling 'html5' again merges, rather than overwrites. + if ( isset( $_wp_theme_features['html5'] ) ) + $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 ) ); - break; case 'custom-header' : if ( ! is_array( $args ) ) @@ -1240,6 +2288,8 @@ function add_theme_support( $feature ) { 'wp-head-callback' => '', 'admin-head-callback' => '', 'admin-preview-callback' => '', + 'video' => false, + 'video-active-callback' => 'is_front_page', ); $jit = isset( $args[0]['__jit'] ); @@ -1259,7 +2309,7 @@ function add_theme_support( $feature ) { // the constant is always accurate (and is not defined later, overriding our value). // As stated above, the first value wins. // Once we get to wp_loaded (just-in-time), define any constants we haven't already. - // Constants are lame. Don't reference them. This is just for backwards compatibility. + // Constants are lame. Don't reference them. This is just for backward compatibility. if ( defined( 'NO_HEADER_TEXT' ) ) $args[0]['header-text'] = ! NO_HEADER_TEXT; @@ -1305,10 +2355,16 @@ function add_theme_support( $feature ) { $args = array( 0 => array() ); $defaults = array( - 'default-image' => '', - 'default-color' => '', - 'wp-head-callback' => '_custom_background_cb', - 'admin-head-callback' => '', + 'default-image' => '', + 'default-preset' => 'default', + 'default-position-x' => 'left', + 'default-position-y' => 'top', + 'default-size' => 'auto', + 'default-repeat' => 'repeat', + 'default-attachment' => 'scroll', + 'default-color' => '', + 'wp-head-callback' => '_custom_background_cb', + 'admin-head-callback' => '', 'admin-preview-callback' => '', ); @@ -1333,6 +2389,17 @@ function add_theme_support( $feature ) { define( 'BACKGROUND_IMAGE', $args[0]['default-image'] ); break; + + // Ensure that 'title-tag' is accessible in the admin. + case 'title-tag' : + // Can be called in functions.php but must happen before wp_loaded, i.e. not in header.php. + if ( did_action( 'wp_loaded' ) ) { + /* translators: 1: Theme support 2: hook name */ + _doing_it_wrong( "add_theme_support( 'title-tag' )", sprintf( __( 'Theme support for %1$s should be registered before the %2$s hook.' ), + 'title-tag', 'wp_loaded' ), '4.1.0' ); + + return false; + } } $_wp_theme_features[ $feature ] = $args; @@ -1343,6 +2410,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; @@ -1374,14 +2444,40 @@ function _custom_header_background_just_in_time() { } } } -add_action( 'wp_loaded', '_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 ); + + ?> + + + exists() ) - do_action( 'after_switch_theme', $old_theme->get('Name'), $old_theme ); - else + // Prevent retrieve_widgets() from running since Customizer already called it up front + if ( get_option( 'theme_switched_via_customizer' ) ) { + remove_action( 'after_switch_theme', '_wp_sidebars_changed' ); + update_option( 'theme_switched_via_customizer', false ); + } + + if ( $old_theme->exists() ) { + /** + * Fires on the first WP load after a theme switch if the old theme still exists. + * + * This action fires multiple times and the parameters differs + * according to the context, if the old theme exists or not. + * If the old theme is missing, the parameter will be the slug + * of the old theme. + * + * @since 3.3.0 + * + * @param string $old_name Old theme name. + * @param WP_Theme $old_theme WP_Theme instance of the old theme. + */ + do_action( 'after_switch_theme', $old_theme->get( 'Name' ), $old_theme ); + } else { + /** This action is documented in wp-includes/theme.php */ do_action( 'after_switch_theme', $stylesheet ); + } + flush_rewrite_rules(); update_option( 'theme_switched', false ); } @@ -1574,21 +2739,192 @@ function check_theme_switched() { /** * Includes and instantiates the WP_Customize_Manager class. * - * Fires when ?wp_customize=on or on wp-admin/customize.php. + * Loads the Customizer at plugins_loaded when accessing the customize.php admin + * page or when any request includes a wp_customize=on param or a customize_changeset + * param (a UUID). This param is a signal for whether to bootstrap the Customizer when + * WordPress is loading, especially in the Customizer preview + * or when making Customizer Ajax requests for widgets or menus. * * @since 3.4.0 + * + * @global WP_Customize_Manager $wp_customize */ function _wp_customize_include() { - if ( ! ( ( isset( $_REQUEST['wp_customize'] ) && 'on' == $_REQUEST['wp_customize'] ) - || ( is_admin() && 'customize.php' == basename( $_SERVER['PHP_SELF'] ) ) - ) ) + + $is_customize_admin_page = ( is_admin() && 'customize.php' == basename( $_SERVER['PHP_SELF'] ) ); + $should_include = ( + $is_customize_admin_page + || + ( isset( $_REQUEST['wp_customize'] ) && 'on' == $_REQUEST['wp_customize'] ) + || + ( ! empty( $_GET['customize_changeset_uuid'] ) || ! empty( $_POST['customize_changeset_uuid'] ) ) + ); + + if ( ! $should_include ) { return; + } + + /* + * Note that wp_unslash() is not being used on the input vars because it is + * called before wp_magic_quotes() gets called. Besides this fact, none of + * the values should contain any characters needing slashes anyway. + */ + $keys = array( 'changeset_uuid', 'customize_changeset_uuid', 'customize_theme', 'theme', 'customize_messenger_channel' ); + $input_vars = array_merge( + wp_array_slice_assoc( $_GET, $keys ), + wp_array_slice_assoc( $_POST, $keys ) + ); + + $theme = null; + $changeset_uuid = null; + $messenger_channel = null; + + if ( $is_customize_admin_page && isset( $input_vars['changeset_uuid'] ) ) { + $changeset_uuid = sanitize_key( $input_vars['changeset_uuid'] ); + } elseif ( ! empty( $input_vars['customize_changeset_uuid'] ) ) { + $changeset_uuid = sanitize_key( $input_vars['customize_changeset_uuid'] ); + } + + // Note that theme will be sanitized via WP_Theme. + if ( $is_customize_admin_page && isset( $input_vars['theme'] ) ) { + $theme = $input_vars['theme']; + } elseif ( isset( $input_vars['customize_theme'] ) ) { + $theme = $input_vars['customize_theme']; + } + if ( isset( $input_vars['customize_messenger_channel'] ) ) { + $messenger_channel = sanitize_key( $input_vars['customize_messenger_channel'] ); + } + + require_once ABSPATH . WPINC . '/class-wp-customize-manager.php'; + $GLOBALS['wp_customize'] = new WP_Customize_Manager( compact( 'changeset_uuid', 'theme', 'messenger_channel' ) ); +} + +/** + * Publish a snapshot's changes. + * + * @param string $new_status New post status. + * @param string $old_status Old post status. + * @param WP_Post $changeset_post Changeset post object. + */ +function _wp_customize_publish_changeset( $new_status, $old_status, $changeset_post ) { + global $wp_customize, $wpdb; + + $is_publishing_changeset = ( + 'customize_changeset' === $changeset_post->post_type + && + 'publish' === $new_status + && + 'publish' !== $old_status + ); + if ( ! $is_publishing_changeset ) { + return; + } + + if ( empty( $wp_customize ) ) { + require_once ABSPATH . WPINC . '/class-wp-customize-manager.php'; + $wp_customize = new WP_Customize_Manager( array( 'changeset_uuid' => $changeset_post->post_name ) ); + } + + if ( ! did_action( 'customize_register' ) ) { + /* + * When running from CLI or Cron, the customize_register action will need + * to be triggered in order for core, themes, and plugins to register their + * settings. Normally core will add_action( 'customize_register' ) at + * priority 10 to register the core settings, and if any themes/plugins + * also add_action( 'customize_register' ) at the same priority, they + * will have a $wp_customize with those settings registered since they + * call add_action() afterward, normally. However, when manually doing + * the customize_register action after the setup_theme, then the order + * will be reversed for two actions added at priority 10, resulting in + * the core settings no longer being available as expected to themes/plugins. + * So the following manually calls the method that registers the core + * settings up front before doing the action. + */ + remove_action( 'customize_register', array( $wp_customize, 'register_controls' ) ); + $wp_customize->register_controls(); + + /** This filter is documented in /wp-includes/class-wp-customize-manager.php */ + do_action( 'customize_register', $wp_customize ); + } + $wp_customize->_publish_changeset_values( $changeset_post->ID ) ; + + /* + * Trash the changeset post if revisions are not enabled. Unpublished + * changesets by default get garbage collected due to the auto-draft status. + * When a changeset post is published, however, it would no longer get cleaned + * out. Ths is a problem when the changeset posts are never displayed anywhere, + * since they would just be endlessly piling up. So here we use the revisions + * feature to indicate whether or not a published changeset should get trashed + * and thus garbage collected. + */ + if ( ! wp_revisions_enabled( $changeset_post ) ) { + $post = $changeset_post; + $post_id = $changeset_post->ID; + + /* + * The following re-formulates the logic from wp_trash_post() as done in + * wp_publish_post(). The reason for bypassing wp_trash_post() is that it + * will mutate the the post_content and the post_name when they should be + * untouched. + */ + if ( ! EMPTY_TRASH_DAYS ) { + wp_delete_post( $post_id, true ); + } else { + /** This action is documented in wp-includes/post.php */ + do_action( 'wp_trash_post', $post_id ); + + add_post_meta( $post_id, '_wp_trash_meta_status', $post->post_status ); + add_post_meta( $post_id, '_wp_trash_meta_time', time() ); + + $old_status = $post->post_status; + $new_status = 'trash'; + $wpdb->update( $wpdb->posts, array( 'post_status' => $new_status ), array( 'ID' => $post->ID ) ); + clean_post_cache( $post->ID ); + + $post->post_status = $new_status; + wp_transition_post_status( $new_status, $old_status, $post ); + + /** This action is documented in wp-includes/post.php */ + do_action( 'edit_post', $post->ID, $post ); + + /** This action is documented in wp-includes/post.php */ + do_action( "save_post_{$post->post_type}", $post->ID, $post, true ); + + /** This action is documented in wp-includes/post.php */ + do_action( 'save_post', $post->ID, $post, true ); + + /** This action is documented in wp-includes/post.php */ + do_action( 'wp_insert_post', $post->ID, $post, true ); - require( ABSPATH . WPINC . '/class-wp-customize-manager.php' ); - // Init Customize class - $GLOBALS['wp_customize'] = new WP_Customize_Manager; + /** This action is documented in wp-includes/post.php */ + do_action( 'trashed_post', $post_id ); + } + } +} + +/** + * Filters changeset post data upon insert to ensure post_name is intact. + * + * This is needed to prevent the post_name from being dropped when the post is + * transitioned into pending status by a contributor. + * + * @since 4.7.0 + * @see wp_insert_post() + * + * @param array $post_data An array of slashed post data. + * @param array $supplied_post_data An array of sanitized, but otherwise unmodified post data. + * @returns array Filtered data. + */ +function _wp_customize_changeset_filter_insert_post_data( $post_data, $supplied_post_data ) { + if ( isset( $post_data['post_type'] ) && 'customize_changeset' === $post_data['post_type'] ) { + + // Prevent post_name from being dropped, such as when contributor saves a changeset post as pending. + if ( empty( $post_data['post_name'] ) && ! empty( $supplied_post_data['post_name'] ) ) { + $post_data['post_name'] = $supplied_post_data['post_name']; + } + } + return $post_data; } -add_action( 'plugins_loaded', '_wp_customize_include' ); /** * Adds settings for the customize-loader script. @@ -1596,8 +2932,6 @@ add_action( 'plugins_loaded', '_wp_customize_include' ); * @since 3.4.0 */ function _wp_customize_loader_settings() { - global $wp_scripts; - $admin_origin = parse_url( admin_url() ); $home_origin = parse_url( home_url() ); $cross_domain = ( strtolower( $admin_origin[ 'host' ] ) != strtolower( $home_origin[ 'host' ] ) ); @@ -1611,25 +2945,30 @@ function _wp_customize_loader_settings() { 'url' => esc_url( admin_url( 'customize.php' ) ), 'isCrossDomain' => $cross_domain, 'browser' => $browser, + 'l10n' => array( + 'saveAlert' => __( 'The changes you made will be lost if you navigate away from this page.' ), + 'mainIframeTitle' => __( 'Customizer' ), + ), ); - $script = 'var _wpCustomizeLoaderSettings = ' . json_encode( $settings ) . ';'; + $script = 'var _wpCustomizeLoaderSettings = ' . wp_json_encode( $settings ) . ';'; + $wp_scripts = wp_scripts(); $data = $wp_scripts->get_data( 'customize-loader', 'data' ); if ( $data ) $script = "$data\n$script"; $wp_scripts->add_data( 'customize-loader', 'data', $script ); } -add_action( 'admin_enqueue_scripts', '_wp_customize_loader_settings' ); /** - * Returns a URL to load the theme customizer. + * Returns a URL to load the Customizer. * * @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' ); @@ -1639,7 +2978,7 @@ function wp_customize_url( $stylesheet = null ) { } /** - * Prints a script to check whether or not the customizer is supported, + * Prints a script to check whether or not the Customizer is supported, * and apply either the no-customize-support or customize-support class * to the body. * @@ -1652,6 +2991,7 @@ function wp_customize_url( $stylesheet = null ) { * to the body tag by default. * * @since 3.4.0 + * @since 4.7.0 Support for IE8 and below is explicitly removed via conditional comments. */ function wp_customize_support_script() { $admin_origin = parse_url( admin_url() ); @@ -1659,19 +2999,42 @@ function wp_customize_support_script() { $cross_domain = ( strtolower( $admin_origin[ 'host' ] ) != strtolower( $home_origin[ 'host' ] ) ); ?> - + + + + is_preview(); +}