* 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() {
- delete_site_transient('update_themes');
+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();
* 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'));
+ /**
+ * Filter 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.
*/
$theme_root = get_theme_root( $stylesheet );
$stylesheet_dir = "$theme_root/$stylesheet";
+ /**
+ * Filter the stylesheet directory path for current theme.
+ *
+ * @since 1.5.0
+ *
+ * @param string $stylesheet_dir Absolute path to the current them.
+ * @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 );
}
$theme_root_uri = get_theme_root_uri( $stylesheet );
$stylesheet_dir_uri = "$theme_root_uri/$stylesheet";
+ /**
+ * Filter 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 );
}
* get_stylesheet_directory_uri() stylesheet directory URI} path.
*
* @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);
+ /**
+ * Filter 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 );
}
/**
* 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.
*
* @return string
*/
$stylesheet_uri = "$stylesheet_dir_uri/{$wp_locale->text_direction}.css";
else
$stylesheet_uri = '';
- return apply_filters('locale_stylesheet_uri', $stylesheet_uri, $stylesheet_dir_uri);
+ /**
+ * Filter 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 );
}
/**
* @return string Template name.
*/
function get_template() {
- return apply_filters('template', get_option('template'));
+ /**
+ * Filter 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.
*/
$theme_root = get_theme_root( $template );
$template_dir = "$theme_root/$template";
+ /**
+ * Filter 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 );
}
* 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.
*/
$theme_root_uri = get_theme_root_uri( $template );
$template_dir_uri = "$theme_root_uri/$template";
+ /**
+ * Filter 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 );
}
$relative_theme_roots[ $theme_root ] = $theme_root;
}
+ /**
+ * Filter 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 ) ) {
// 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;
// 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;
* Does not have trailing slash.
*
* @since 1.5.0
- * @uses apply_filters() Calls 'theme_root' filter on path.
*
* @param string $stylesheet_or_template The stylesheet or template name of the theme
* @return string Theme path.
$theme_root = WP_CONTENT_DIR . '/themes';
}
+ /**
+ * Filter 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 );
}
$theme_root_uri = content_url( 'themes' );
}
- return apply_filters( 'theme_root_uri', $theme_root_uri, get_option('siteurl'), $stylesheet_or_template );
+ /**
+ * Filter 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 );
}
/**
)
return $matches[1] . "#$matches[2] onclick=$matches[2]return false;" . $matches[4];
- $link = add_query_arg( array( 'preview' => 1, 'template' => $_GET['template'], 'stylesheet' => @$_GET['stylesheet'], 'preview_iframe' => 1 ), $matches[3] );
+ $stylesheet = isset( $_GET['stylesheet'] ) ? $_GET['stylesheet'] : '';
+ $template = isset( $_GET['template'] ) ? $_GET['template'] : '';
+
+ $link = add_query_arg( array( 'preview' => 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];
* of two arguments: $template then $stylesheet. This is for backwards compatibility.
*
* @since 2.5.0
- * @uses do_action() Calls 'switch_theme' action, passing the new theme.
*
* @param string $stylesheet Stylesheet name
*/
}
update_option( 'theme_switched', $old_theme->get_stylesheet() );
+ /**
+ * Fires after the theme is switched.
+ *
+ * @since 1.5.0
+ *
+ * @param string $new_name Name of the new theme.
+ * @param WP_Theme $new_theme WP_Theme instance of the new theme.
+ */
do_action( 'switch_theme', $new_name, $new_theme );
}
* @return bool
*/
function validate_current_theme() {
- // Don't validate during an install/upgrade.
- if ( defined('WP_INSTALLING') || !apply_filters( 'validate_current_theme', true ) )
+ /**
+ * Filter whether to validate the current theme.
+ *
+ * @since 2.7.0
+ *
+ * @param bool true Validation flag to check the current theme.
+ */
+ if ( defined('WP_INSTALLING') || ! apply_filters( 'validate_current_theme', true ) )
return true;
if ( get_template() != WP_DEFAULT_THEME && !file_exists(get_template_directory() . '/index.php') ) {
* directory URI.
*
* @since 2.1.0
- * @uses apply_filters() Calls 'theme_mod_$name' filter on the value.
*
* @param string $name Theme modification name.
* @param bool|string $default
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] ) ) {
+ /**
+ * Filter 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 );
}
/**
if ( $background ) {
$image = " background-image: url('$background');";
- $repeat = get_theme_mod( 'background_repeat', 'repeat' );
+ $repeat = get_theme_mod( 'background_repeat', get_theme_support( 'custom-background', 'default-repeat' ) );
if ( ! in_array( $repeat, array( 'no-repeat', 'repeat-x', 'repeat-y', 'repeat' ) ) )
$repeat = 'repeat';
$repeat = " background-repeat: $repeat;";
- $position = get_theme_mod( 'background_position_x', 'left' );
+ $position = get_theme_mod( 'background_position_x', get_theme_support( 'custom-background', 'default-position-x' ) );
if ( ! in_array( $position, array( 'center', 'right', 'left' ) ) )
$position = 'left';
$position = " background-position: top $position;";
- $attachment = get_theme_mod( 'background_attachment', 'scroll' );
+ $attachment = get_theme_mod( 'background_attachment', get_theme_support( 'custom-background', 'default-attachment' ) );
if ( ! in_array( $attachment, array( 'fixed', 'scroll' ) ) )
$attachment = 'scroll';
$attachment = " background-attachment: $attachment;";
$args = array( 0 => array() );
$defaults = array(
- 'default-image' => '',
- 'default-color' => '',
- 'wp-head-callback' => '_custom_background_cb',
- 'admin-head-callback' => '',
+ 'default-image' => '',
+ 'default-repeat' => 'repeat',
+ 'default-position-x' => 'left',
+ 'default-attachment' => 'scroll',
+ 'default-color' => '',
+ 'wp-head-callback' => '_custom_background_cb',
+ 'admin-head-callback' => '',
'admin-preview-callback' => '',
);
break;
}
- return apply_filters('current_theme_supports-' . $feature, true, $args, $_wp_theme_features[$feature]);
+ /**
+ * Filter whether the current theme supports a specific feature.
+ *
+ * The dynamic portion of the hook name, $feature, refers to
+ * the specific theme feature. Possible values include 'post-formats',
+ * 'post-thumbnails', 'custom-background', 'custom-header', 'menus',
+ * 'automatic-feed-links', and 'html5'.
+ *
+ * @since 3.4.0
+ *
+ * @param bool true Whether the current theme supports the given feature. Default true.
+ * @param array $args Array of arguments for the feature.
+ * @param string $feature The theme feature.
+ */
+ return apply_filters( "current_theme_supports-{$feature}", true, $args, $_wp_theme_features[$feature] );
}
/**
if ( $stylesheet = get_option( 'theme_switched' ) ) {
$old_theme = wp_get_theme( $stylesheet );
- if ( $old_theme->exists() )
- do_action( 'after_switch_theme', $old_theme->get('Name'), $old_theme );
- else
+ 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 );
+ }
update_option( 'theme_switched', false );
}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff