/** * WP_Theme Class * * @package WordPress * @subpackage Theme */ final class WP_Theme implements ArrayAccess { /** * Headers for style.css files. * * @static * @access private * @var array */ private static $file_headers = array( 'Name' => 'Theme Name', 'ThemeURI' => 'Theme URI', 'Description' => 'Description', 'Author' => 'Author', 'AuthorURI' => 'Author URI', 'Version' => 'Version', 'Template' => 'Template', 'Status' => 'Status', 'Tags' => 'Tags', 'TextDomain' => 'Text Domain', 'DomainPath' => 'Domain Path', ); /** * Default themes. * * @static * @access private * @var array */ private static $default_themes = array( 'classic' => 'WordPress Classic', 'default' => 'WordPress Default', 'twentyten' => 'Twenty Ten', 'twentyeleven' => 'Twenty Eleven', 'twentytwelve' => 'Twenty Twelve', 'twentythirteen' => 'Twenty Thirteen', 'twentyfourteen' => 'Twenty Fourteen', 'twentyfifteen' => 'Twenty Fifteen', ); /** * Renamed theme tags. * * @static * @access private * @var array */ private static $tag_map = array( 'fixed-width' => 'fixed-layout', 'flexible-width' => 'fluid-layout', ); /** * Absolute path to the theme root, usually wp-content/themes * * @access private * @var string */ private $theme_root; /** * Header data from the theme's style.css file. * * @access private * @var array */ private $headers = array(); /** * Header data from the theme's style.css file after being sanitized. * * @access private * @var array */ private $headers_sanitized; /** * Header name from the theme's style.css after being translated. * * Cached due to sorting functions running over the translated name. * * @access private * @var string */ private $name_translated; /** * Errors encountered when initializing the theme. * * @access private * @var WP_Error */ private $errors; /** * The directory name of the theme's files, inside the theme root. * * In the case of a child theme, this is directory name of the child theme. * Otherwise, 'stylesheet' is the same as 'template'. * * @access private * @var string */ private $stylesheet; /** * The directory name of the theme's files, inside the theme root. * * In the case of a child theme, this is the directory name of the parent theme. * Otherwise, 'template' is the same as 'stylesheet'. * * @access private * @var string */ private $template; /** * A reference to the parent theme, in the case of a child theme. * * @access private * @var WP_Theme */ private $parent; /** * URL to the theme root, usually an absolute URL to wp-content/themes * * @access private * var string */ private $theme_root_uri; /** * Flag for whether the theme's textdomain is loaded. * * @access private * @var bool */ private $textdomain_loaded; /** * Stores an md5 hash of the theme root, to function as the cache key. * * @access private * @var string */ private $cache_hash; /** * Flag for whether the themes cache bucket should be persistently cached. * * Default is false. Can be set with the wp_cache_themes_persistently filter. * * @static * @access private * @var bool */ private static $persistently_cache; /** * Expiration time for the themes cache bucket. * * By default the bucket is not cached, so this value is useless. * * @static * @access private * @var bool */ private static $cache_expiration = 1800; /** * Constructor for WP_Theme. * * @global array $wp_theme_directories * * @param string $theme_dir Directory of the theme within the theme_root. * @param string $theme_root Theme root. * @param WP_Error|void $_child If this theme is a parent theme, the child may be passed for validation purposes. */ public function __construct( $theme_dir, $theme_root, $_child = null ) { global $wp_theme_directories; // Initialize caching on first run. if ( ! isset( self::$persistently_cache ) ) { /** This action is documented in wp-includes/theme.php */ self::$persistently_cache = apply_filters( 'wp_cache_themes_persistently', false, 'WP_Theme' ); if ( self::$persistently_cache ) { wp_cache_add_global_groups( 'themes' ); if ( is_int( self::$persistently_cache ) ) self::$cache_expiration = self::$persistently_cache; } else { wp_cache_add_non_persistent_groups( 'themes' ); } } $this->theme_root = $theme_root; $this->stylesheet = $theme_dir; // Correct a situation where the theme is 'some-directory/some-theme' but 'some-directory' was passed in as part of the theme root instead. if ( ! in_array( $theme_root, (array) $wp_theme_directories ) && in_array( dirname( $theme_root ), (array) $wp_theme_directories ) ) { $this->stylesheet = basename( $this->theme_root ) . '/' . $this->stylesheet; $this->theme_root = dirname( $theme_root ); } $this->cache_hash = md5( $this->theme_root . '/' . $this->stylesheet ); $theme_file = $this->stylesheet . '/style.css'; $cache = $this->cache_get( 'theme' ); if ( is_array( $cache ) ) { foreach ( array( 'errors', 'headers', 'template' ) as $key ) { if ( isset( $cache[ $key ] ) ) $this->$key = $cache[ $key ]; } if ( $this->errors ) return; if ( isset( $cache['theme_root_template'] ) ) $theme_root_template = $cache['theme_root_template']; } elseif ( ! file_exists( $this->theme_root . '/' . $theme_file ) ) { $this->headers['Name'] = $this->stylesheet; if ( ! file_exists( $this->theme_root . '/' . $this->stylesheet ) ) $this->errors = new WP_Error( 'theme_not_found', sprintf( __( 'The theme directory "%s" does not exist.' ), esc_html( $this->stylesheet ) ) ); else $this->errors = new WP_Error( 'theme_no_stylesheet', __( 'Stylesheet is missing.' ) ); $this->template = $this->stylesheet; $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) ); if ( ! file_exists( $this->theme_root ) ) // Don't cache this one. $this->errors->add( 'theme_root_missing', __( 'ERROR: The themes directory is either empty or doesn’t exist. Please check your installation.' ) ); return; } elseif ( ! is_readable( $this->theme_root . '/' . $theme_file ) ) { $this->headers['Name'] = $this->stylesheet; $this->errors = new WP_Error( 'theme_stylesheet_not_readable', __( 'Stylesheet is not readable.' ) ); $this->template = $this->stylesheet; $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) ); return; } else { $this->headers = get_file_data( $this->theme_root . '/' . $theme_file, self::$file_headers, 'theme' ); // Default themes always trump their pretenders. // Properly identify default themes that are inside a directory within wp-content/themes. if ( $default_theme_slug = array_search( $this->headers['Name'], self::$default_themes ) ) { if ( basename( $this->stylesheet ) != $default_theme_slug ) $this->headers['Name'] .= '/' . $this->stylesheet; } } // (If template is set from cache [and there are no errors], we know it's good.) if ( ! $this->template && ! ( $this->template = $this->headers['Template'] ) ) { $this->template = $this->stylesheet; if ( ! file_exists( $this->theme_root . '/' . $this->stylesheet . '/index.php' ) ) { $this->errors = new WP_Error( 'theme_no_index', __( 'Template is missing.' ) ); $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) ); return; } } // If we got our data from cache, we can assume that 'template' is pointing to the right place. if ( ! is_array( $cache ) && $this->template != $this->stylesheet && ! file_exists( $this->theme_root . '/' . $this->template . '/index.php' ) ) { // If we're in a directory of themes inside /themes, look for the parent nearby. // wp-content/themes/directory-of-themes/* $parent_dir = dirname( $this->stylesheet ); if ( '.' != $parent_dir && file_exists( $this->theme_root . '/' . $parent_dir . '/' . $this->template . '/index.php' ) ) { $this->template = $parent_dir . '/' . $this->template; } elseif ( ( $directories = search_theme_directories() ) && isset( $directories[ $this->template ] ) ) { // Look for the template in the search_theme_directories() results, in case it is in another theme root. // We don't look into directories of themes, just the theme root. $theme_root_template = $directories[ $this->template ]['theme_root']; } else { // Parent theme is missing. $this->errors = new WP_Error( 'theme_no_parent', sprintf( __( 'The parent theme is missing. Please install the "%s" parent theme.' ), esc_html( $this->template ) ) ); $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) ); $this->parent = new WP_Theme( $this->template, $this->theme_root, $this ); return; } } // Set the parent, if we're a child theme. if ( $this->template != $this->stylesheet ) { // If we are a parent, then there is a problem. Only two generations allowed! Cancel things out. if ( $_child instanceof WP_Theme && $_child->template == $this->stylesheet ) { $_child->parent = null; $_child->errors = new WP_Error( 'theme_parent_invalid', sprintf( __( 'The "%s" theme is not a valid parent theme.' ), esc_html( $_child->template ) ) ); $_child->cache_add( 'theme', array( 'headers' => $_child->headers, 'errors' => $_child->errors, 'stylesheet' => $_child->stylesheet, 'template' => $_child->template ) ); // The two themes actually reference each other with the Template header. if ( $_child->stylesheet == $this->template ) { $this->errors = new WP_Error( 'theme_parent_invalid', sprintf( __( 'The "%s" theme is not a valid parent theme.' ), esc_html( $this->template ) ) ); $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) ); } return; } // Set the parent. Pass the current instance so we can do the crazy checks above and assess errors. $this->parent = new WP_Theme( $this->template, isset( $theme_root_template ) ? $theme_root_template : $this->theme_root, $this ); } // We're good. If we didn't retrieve from cache, set it. if ( ! is_array( $cache ) ) { $cache = array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ); // If the parent theme is in another root, we'll want to cache this. Avoids an entire branch of filesystem calls above. if ( isset( $theme_root_template ) ) $cache['theme_root_template'] = $theme_root_template; $this->cache_add( 'theme', $cache ); } } /** * When converting the object to a string, the theme name is returned. * * @return string Theme name, ready for display (translated) */ public function __toString() { return (string) $this->display('Name'); } /** * __isset() magic method for properties formerly returned by current_theme_info() * * @staticvar array $properties * * @return bool */ public function __isset( $offset ) { static $properties = array( 'name', 'title', 'version', 'parent_theme', 'template_dir', 'stylesheet_dir', 'template', 'stylesheet', 'screenshot', 'description', 'author', 'tags', 'theme_root', 'theme_root_uri', ); return in_array( $offset, $properties ); } /** * __get() magic method for properties formerly returned by current_theme_info() * * @return mixed */ public function __get( $offset ) { switch ( $offset ) { case 'name' : case 'title' : return $this->get('Name'); case 'version' : return $this->get('Version'); case 'parent_theme' : return $this->parent() ? $this->parent()->get('Name') : ''; case 'template_dir' : return $this->get_template_directory(); case 'stylesheet_dir' : return $this->get_stylesheet_directory(); case 'template' : return $this->get_template(); case 'stylesheet' : return $this->get_stylesheet(); case 'screenshot' : return $this->get_screenshot( 'relative' ); // 'author' and 'description' did not previously return translated data. case 'description' : return $this->display('Description'); case 'author' : return $this->display('Author'); case 'tags' : return $this->get( 'Tags' ); case 'theme_root' : return $this->get_theme_root(); case 'theme_root_uri' : return $this->get_theme_root_uri(); // For cases where the array was converted to an object. default : return $this->offsetGet( $offset ); } } /** * Method to implement ArrayAccess for keys formerly returned by get_themes() * * @param mixed $offset * @param mixed $value */ public function offsetSet( $offset, $value ) {} /** * Method to implement ArrayAccess for keys formerly returned by get_themes() * * @param mixed $offset */ public function offsetUnset( $offset ) {} /** * Method to implement ArrayAccess for keys formerly returned by get_themes() * * @staticvar array $keys * * @param mixed $offset * @return bool */ public function offsetExists( $offset ) { static $keys = array( 'Name', 'Version', 'Status', 'Title', 'Author', 'Author Name', 'Author URI', 'Description', 'Template', 'Stylesheet', 'Template Files', 'Stylesheet Files', 'Template Dir', 'Stylesheet Dir', 'Screenshot', 'Tags', 'Theme Root', 'Theme Root URI', 'Parent Theme', ); return in_array( $offset, $keys ); } /** * Method to implement ArrayAccess for keys formerly returned by get_themes(). * * Author, Author Name, Author URI, and Description did not previously return * translated data. We are doing so now as it is safe to do. However, as * Name and Title could have been used as the key for get_themes(), both remain * untranslated for back compatibility. This means that ['Name'] is not ideal, * and care should be taken to use $theme->display('Name') to get a properly * translated header. * * @param mixed $offset * @return mixed */ public function offsetGet( $offset ) { switch ( $offset ) { case 'Name' : case 'Title' : // See note above about using translated data. get() is not ideal. // It is only for backwards compatibility. Use display(). return $this->get('Name'); case 'Author' : return $this->display( 'Author'); case 'Author Name' : return $this->display( 'Author', false); case 'Author URI' : return $this->display('AuthorURI'); case 'Description' : return $this->display( 'Description'); case 'Version' : case 'Status' : return $this->get( $offset ); case 'Template' : return $this->get_template(); case 'Stylesheet' : return $this->get_stylesheet(); case 'Template Files' : return $this->get_files( 'php', 1, true ); case 'Stylesheet Files' : return $this->get_files( 'css', 0, false ); case 'Template Dir' : return $this->get_template_directory(); case 'Stylesheet Dir' : return $this->get_stylesheet_directory(); case 'Screenshot' : return $this->get_screenshot( 'relative' ); case 'Tags' : return $this->get('Tags'); case 'Theme Root' : return $this->get_theme_root(); case 'Theme Root URI' : return $this->get_theme_root_uri(); case 'Parent Theme' : return $this->parent() ? $this->parent()->get('Name') : ''; default : return null; } } /** * Returns errors property. * * @since 3.4.0 * @access public * * @return WP_Error|false WP_Error if there are errors, or false. */ public function errors() { return is_wp_error( $this->errors ) ? $this->errors : false; } /** * Whether the theme exists. * * A theme with errors exists. A theme with the error of 'theme_not_found', * meaning that the theme's directory was not found, does not exist. * * @since 3.4.0 * @access public * * @return bool Whether the theme exists. */ public function exists() { return ! ( $this->errors() && in_array( 'theme_not_found', $this->errors()->get_error_codes() ) ); } /** * Returns reference to the parent theme. * * @since 3.4.0 * @access public * * @return WP_Theme|false Parent theme, or false if the current theme is not a child theme. */ public function parent() { return isset( $this->parent ) ? $this->parent : false; } /** * Adds theme data to cache. * * Cache entries keyed by the theme and the type of data. * * @since 3.4.0 * @access private * * @param string $key Type of data to store (theme, screenshot, headers, page_templates) * @param string $data Data to store * @return bool Return value from wp_cache_add() */ private function cache_add( $key, $data ) { return wp_cache_add( $key . '-' . $this->cache_hash, $data, 'themes', self::$cache_expiration ); } /** * Gets theme data from cache. * * Cache entries are keyed by the theme and the type of data. * * @since 3.4.0 * @access private * * @param string $key Type of data to retrieve (theme, screenshot, headers, page_templates) * @return mixed Retrieved data */ private function cache_get( $key ) { return wp_cache_get( $key . '-' . $this->cache_hash, 'themes' ); } /** * Clears the cache for the theme. * * @since 3.4.0 * @access public */ public function cache_delete() { foreach ( array( 'theme', 'screenshot', 'headers', 'page_templates' ) as $key ) wp_cache_delete( $key . '-' . $this->cache_hash, 'themes' ); $this->template = $this->textdomain_loaded = $this->theme_root_uri = $this->parent = $this->errors = $this->headers_sanitized = $this->name_translated = null; $this->headers = array(); $this->__construct( $this->stylesheet, $this->theme_root ); } /** * Get a raw, unformatted theme header. * * The header is sanitized, but is not translated, and is not marked up for display. * To get a theme header for display, use the display() method. * * Use the get_template() method, not the 'Template' header, for finding the template. * The 'Template' header is only good for what was written in the style.css, while * get_template() takes into account where WordPress actually located the theme and * whether it is actually valid. * * @since 3.4.0 * @access public * * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. * @return string|false String on success, false on failure. */ public function get( $header ) { if ( ! isset( $this->headers[ $header ] ) ) return false; if ( ! isset( $this->headers_sanitized ) ) { $this->headers_sanitized = $this->cache_get( 'headers' ); if ( ! is_array( $this->headers_sanitized ) ) $this->headers_sanitized = array(); } if ( isset( $this->headers_sanitized[ $header ] ) ) return $this->headers_sanitized[ $header ]; // If themes are a persistent group, sanitize everything and cache it. One cache add is better than many cache sets. if ( self::$persistently_cache ) { foreach ( array_keys( $this->headers ) as $_header ) $this->headers_sanitized[ $_header ] = $this->sanitize_header( $_header, $this->headers[ $_header ] ); $this->cache_add( 'headers', $this->headers_sanitized ); } else { $this->headers_sanitized[ $header ] = $this->sanitize_header( $header, $this->headers[ $header ] ); } return $this->headers_sanitized[ $header ]; } /** * Gets a theme header, formatted and translated for display. * * @since 3.4.0 * @access public * * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. * @param bool $markup Optional. Whether to mark up the header. Defaults to true. * @param bool $translate Optional. Whether to translate the header. Defaults to true. * @return string|false Processed header, false on failure. */ public function display( $header, $markup = true, $translate = true ) { $value = $this->get( $header ); if ( false === $value ) { return false; } if ( $translate && ( empty( $value ) || ! $this->load_textdomain() ) ) $translate = false; if ( $translate ) $value = $this->translate_header( $header, $value ); if ( $markup ) $value = $this->markup_header( $header, $value, $translate ); return $value; } /** * Sanitize a theme header. * * @since 3.4.0 * @access private * * @staticvar array $header_tags * @staticvar array $header_tags_with_a * * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. * @param string $value Value to sanitize. * @return mixed */ private function sanitize_header( $header, $value ) { switch ( $header ) { case 'Status' : if ( ! $value ) { $value = 'publish'; break; } // Fall through otherwise. case 'Name' : static $header_tags = array( 'abbr' => array( 'title' => true ), 'acronym' => array( 'title' => true ), 'code' => true, 'em' => true, 'strong' => true, ); $value = wp_kses( $value, $header_tags ); break; case 'Author' : // There shouldn't be anchor tags in Author, but some themes like to be challenging. case 'Description' : static $header_tags_with_a = array( 'a' => array( 'href' => true, 'title' => true ), 'abbr' => array( 'title' => true ), 'acronym' => array( 'title' => true ), 'code' => true, 'em' => true, 'strong' => true, ); $value = wp_kses( $value, $header_tags_with_a ); break; case 'ThemeURI' : case 'AuthorURI' : $value = esc_url_raw( $value ); break; case 'Tags' : $value = array_filter( array_map( 'trim', explode( ',', strip_tags( $value ) ) ) ); break; case 'Version' : $value = strip_tags( $value ); break; } return $value; } /** * Mark up a theme header. * * @since 3.4.0 * @access private * * @staticvar string $comma * * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. * @param string $value Value to mark up. * @param string $translate Whether the header has been translated. * @return string Value, marked up. */ private function markup_header( $header, $value, $translate ) { switch ( $header ) { case 'Name' : if ( empty( $value ) ) { $value = esc_html( $this->get_stylesheet() ); } break; case 'Description' : $value = wptexturize( $value ); break; case 'Author' : if ( $this->get('AuthorURI') ) { $value = sprintf( '%2$s', $this->display( 'AuthorURI', true, $translate ), $value ); } elseif ( ! $value ) { $value = __( 'Anonymous' ); } break; case 'Tags' : static $comma = null; if ( ! isset( $comma ) ) { /* translators: used between list items, there is a space after the comma */ $comma = __( ', ' ); } $value = implode( $comma, $value ); break; case 'ThemeURI' : case 'AuthorURI' : $value = esc_url( $value ); break; } return $value; } /** * Translate a theme header. * * @since 3.4.0 * @access private * * @staticvar array $tags_list * * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. * @param string $value Value to translate. * @return string Translated value. */ private function translate_header( $header, $value ) { switch ( $header ) { case 'Name' : // Cached for sorting reasons. if ( isset( $this->name_translated ) ) return $this->name_translated; $this->name_translated = translate( $value, $this->get('TextDomain' ) ); return $this->name_translated; case 'Tags' : if ( empty( $value ) || ! function_exists( 'get_theme_feature_list' ) ) return $value; static $tags_list; if ( ! isset( $tags_list ) ) { $tags_list = array(); $feature_list = get_theme_feature_list( false ); // No API foreach ( $feature_list as $tags ) $tags_list += $tags; } foreach ( $value as &$tag ) { if ( isset( $tags_list[ $tag ] ) ) { $tag = $tags_list[ $tag ]; } elseif ( isset( self::$tag_map[ $tag ] ) ) { $tag = $tags_list[ self::$tag_map[ $tag ] ]; } } return $value; default : $value = translate( $value, $this->get('TextDomain') ); } return $value; } /** * The directory name of the theme's "stylesheet" files, inside the theme root. * * In the case of a child theme, this is directory name of the child theme. * Otherwise, get_stylesheet() is the same as get_template(). * * @since 3.4.0 * @access public * * @return string Stylesheet */ public function get_stylesheet() { return $this->stylesheet; } /** * The directory name of the theme's "template" files, inside the theme root. * * In the case of a child theme, this is the directory name of the parent theme. * Otherwise, the get_template() is the same as get_stylesheet(). * * @since 3.4.0 * @access public * * @return string Template */ public function get_template() { return $this->template; } /** * Returns the absolute path to the directory of a theme's "stylesheet" files. * * In the case of a child theme, this is the absolute path to the directory * of the child theme's files. * * @since 3.4.0 * @access public * * @return string Absolute path of the stylesheet directory. */ public function get_stylesheet_directory() { if ( $this->errors() && in_array( 'theme_root_missing', $this->errors()->get_error_codes() ) ) return ''; return $this->theme_root . '/' . $this->stylesheet; } /** * Returns the absolute path to the directory of a theme's "template" files. * * In the case of a child theme, this is the absolute path to the directory * of the parent theme's files. * * @since 3.4.0 * @access public * * @return string Absolute path of the template directory. */ public function get_template_directory() { if ( $this->parent() ) $theme_root = $this->parent()->theme_root; else $theme_root = $this->theme_root; return $theme_root . '/' . $this->template; } /** * Returns the URL to the directory of a theme's "stylesheet" files. * * In the case of a child theme, this is the URL to the directory of the * child theme's files. * * @since 3.4.0 * @access public * * @return string URL to the stylesheet directory. */ public function get_stylesheet_directory_uri() { return $this->get_theme_root_uri() . '/' . str_replace( '%2F', '/', rawurlencode( $this->stylesheet ) ); } /** * Returns the URL to the directory of a theme's "template" files. * * In the case of a child theme, this is the URL to the directory of the * parent theme's files. * * @since 3.4.0 * @access public * * @return string URL to the template directory. */ public function get_template_directory_uri() { if ( $this->parent() ) $theme_root_uri = $this->parent()->get_theme_root_uri(); else $theme_root_uri = $this->get_theme_root_uri(); return $theme_root_uri . '/' . str_replace( '%2F', '/', rawurlencode( $this->template ) ); } /** * The absolute path to the directory of the theme root. * * This is typically the absolute path to wp-content/themes. * * @since 3.4.0 * @access public * * @return string Theme root. */ public function get_theme_root() { return $this->theme_root; } /** * Returns the URL to the directory of the theme root. * * This is typically the absolute URL to wp-content/themes. This forms the basis * for all other URLs returned by WP_Theme, so we pass it to the public function * get_theme_root_uri() and allow it to run the theme_root_uri filter. * * @since 3.4.0 * @access public * * @return string Theme root URI. */ public function get_theme_root_uri() { if ( ! isset( $this->theme_root_uri ) ) $this->theme_root_uri = get_theme_root_uri( $this->stylesheet, $this->theme_root ); return $this->theme_root_uri; } /** * Returns the main screenshot file for the theme. * * The main screenshot is called screenshot.png. gif and jpg extensions are also allowed. * * Screenshots for a theme must be in the stylesheet directory. (In the case of child * themes, parent theme screenshots are not inherited.) * * @since 3.4.0 * @access public * * @param string $uri Type of URL to return, either 'relative' or an absolute URI. Defaults to absolute URI. * @return string|false Screenshot file. False if the theme does not have a screenshot. */ public function get_screenshot( $uri = 'uri' ) { $screenshot = $this->cache_get( 'screenshot' ); if ( $screenshot ) { if ( 'relative' == $uri ) return $screenshot; return $this->get_stylesheet_directory_uri() . '/' . $screenshot; } elseif ( 0 === $screenshot ) { return false; } foreach ( array( 'png', 'gif', 'jpg', 'jpeg' ) as $ext ) { if ( file_exists( $this->get_stylesheet_directory() . "/screenshot.$ext" ) ) { $this->cache_add( 'screenshot', 'screenshot.' . $ext ); if ( 'relative' == $uri ) return 'screenshot.' . $ext; return $this->get_stylesheet_directory_uri() . '/' . 'screenshot.' . $ext; } } $this->cache_add( 'screenshot', 0 ); return false; } /** * Return files in the theme's directory. * * @since 3.4.0 * @access public * * @param mixed $type Optional. Array of extensions to return. Defaults to all files (null). * @param int $depth Optional. How deep to search for files. Defaults to a flat scan (0 depth). -1 depth is infinite. * @param bool $search_parent Optional. Whether to return parent files. Defaults to false. * @return array Array of files, keyed by the path to the file relative to the theme's directory, with the values * being absolute paths. */ public function get_files( $type = null, $depth = 0, $search_parent = false ) { $files = (array) self::scandir( $this->get_stylesheet_directory(), $type, $depth ); if ( $search_parent && $this->parent() ) $files += (array) self::scandir( $this->get_template_directory(), $type, $depth ); return $files; } /** * Returns the theme's page templates. * * @since 3.4.0 * @access public * * @param WP_Post|null $post Optional. The post being edited, provided for context. * @return array Array of page templates, keyed by filename, with the value of the translated header name. */ public function get_page_templates( $post = null ) { // If you screw up your current theme and we invalidate your parent, most things still work. Let it slide. if ( $this->errors() && $this->errors()->get_error_codes() !== array( 'theme_parent_invalid' ) ) return array(); $page_templates = $this->cache_get( 'page_templates' ); if ( ! is_array( $page_templates ) ) { $page_templates = array(); $files = (array) $this->get_files( 'php', 1 ); foreach ( $files as $file => $full_path ) { if ( ! preg_match( '|Template Name:(.*)$|mi', file_get_contents( $full_path ), $header ) ) continue; $page_templates[ $file ] = _cleanup_header_comment( $header[1] ); } $this->cache_add( 'page_templates', $page_templates ); } if ( $this->load_textdomain() ) { foreach ( $page_templates as &$page_template ) { $page_template = $this->translate_header( 'Template Name', $page_template ); } } if ( $this->parent() ) $page_templates += $this->parent()->get_page_templates( $post ); /** * Filter list of page templates for a theme. * * This filter does not currently allow for page templates to be added. * * @since 3.9.0 * * @param array $page_templates Array of page templates. Keys are filenames, * values are translated names. * @param WP_Theme $this The theme object. * @param WP_Post|null $post The post being edited, provided for context, or null. */ $return = apply_filters( 'theme_page_templates', $page_templates, $this, $post ); return array_intersect_assoc( $return, $page_templates ); } /** * Scans a directory for files of a certain extension. * * @since 3.4.0 * * @static * @access private * * @param string $path Absolute path to search. * @param array|string|null $extensions Optional. Array of extensions to find, string of a single extension, * or null for all extensions. Default null. * @param int $depth Optional. How many levels deep to search for files. Accepts 0, 1+, or * -1 (infinite depth). Default 0. * @param string $relative_path Optional. The basename of the absolute path. Used to control the * returned path for the found files, particularly when this function * recurses to lower depths. Default empty. * @return array|false Array of files, keyed by the path to the file relative to the `$path` directory prepended * with `$relative_path`, with the values being absolute paths. False otherwise. */ private static function scandir( $path, $extensions = null, $depth = 0, $relative_path = '' ) { if ( ! is_dir( $path ) ) return false; if ( $extensions ) { $extensions = (array) $extensions; $_extensions = implode( '|', $extensions ); } $relative_path = trailingslashit( $relative_path ); if ( '/' == $relative_path ) $relative_path = ''; $results = scandir( $path ); $files = array(); foreach ( $results as $result ) { if ( '.' == $result[0] ) continue; if ( is_dir( $path . '/' . $result ) ) { if ( ! $depth || 'CVS' == $result ) continue; $found = self::scandir( $path . '/' . $result, $extensions, $depth - 1 , $relative_path . $result ); $files = array_merge_recursive( $files, $found ); } elseif ( ! $extensions || preg_match( '~\.(' . $_extensions . ')$~', $result ) ) { $files[ $relative_path . $result ] = $path . '/' . $result; } } return $files; } /** * Loads the theme's textdomain. * * Translation files are not inherited from the parent theme. Todo: if this fails for the * child theme, it should probably try to load the parent theme's translations. * * @since 3.4.0 * @access public * * @return bool True if the textdomain was successfully loaded or has already been loaded. * False if no textdomain was specified in the file headers, or if the domain could not be loaded. */ public function load_textdomain() { if ( isset( $this->textdomain_loaded ) ) return $this->textdomain_loaded; $textdomain = $this->get('TextDomain'); if ( ! $textdomain ) { $this->textdomain_loaded = false; return false; } if ( is_textdomain_loaded( $textdomain ) ) { $this->textdomain_loaded = true; return true; } $path = $this->get_stylesheet_directory(); if ( $domainpath = $this->get('DomainPath') ) $path .= $domainpath; else $path .= '/languages'; $this->textdomain_loaded = load_theme_textdomain( $textdomain, $path ); return $this->textdomain_loaded; } /** * Whether the theme is allowed (multisite only). * * @since 3.4.0 * @access public * * @param string $check Optional. Whether to check only the 'network'-wide settings, the 'site' * settings, or 'both'. Defaults to 'both'. * @param int $blog_id Optional. Ignored if only network-wide settings are checked. Defaults to current blog. * @return bool Whether the theme is allowed for the network. Returns true in single-site. */ public function is_allowed( $check = 'both', $blog_id = null ) { if ( ! is_multisite() ) return true; if ( 'both' == $check || 'network' == $check ) { $allowed = self::get_allowed_on_network(); if ( ! empty( $allowed[ $this->get_stylesheet() ] ) ) return true; } if ( 'both' == $check || 'site' == $check ) { $allowed = self::get_allowed_on_site( $blog_id ); if ( ! empty( $allowed[ $this->get_stylesheet() ] ) ) return true; } return false; } /** * Returns array of stylesheet names of themes allowed on the site or network. * * @since 3.4.0 * * @static * @access public * * @param int $blog_id Optional. Defaults to current blog. * @return array Array of stylesheet names. */ public static function get_allowed( $blog_id = null ) { /** * Filter the array of themes allowed on the site or network. * * @since MU * * @param array $allowed_themes An array of theme stylesheet names. */ $network = (array) apply_filters( 'allowed_themes', self::get_allowed_on_network() ); return $network + self::get_allowed_on_site( $blog_id ); } /** * Returns array of stylesheet names of themes allowed on the network. * * @since 3.4.0 * * @static * @access public * * @staticvar array $allowed_themes * * @return array Array of stylesheet names. */ public static function get_allowed_on_network() { static $allowed_themes; if ( ! isset( $allowed_themes ) ) $allowed_themes = (array) get_site_option( 'allowedthemes' ); return $allowed_themes; } /** * Returns array of stylesheet names of themes allowed on the site. * * @since 3.4.0 * * @static * @access public * * @staticvar array $allowed_themes * * @param int $blog_id Optional. Defaults to current blog. * @return array Array of stylesheet names. */ public static function get_allowed_on_site( $blog_id = null ) { static $allowed_themes = array(); if ( ! $blog_id || ! is_multisite() ) $blog_id = get_current_blog_id(); if ( isset( $allowed_themes[ $blog_id ] ) ) return $allowed_themes[ $blog_id ]; $current = $blog_id == get_current_blog_id(); if ( $current ) { $allowed_themes[ $blog_id ] = get_option( 'allowedthemes' ); } else { switch_to_blog( $blog_id ); $allowed_themes[ $blog_id ] = get_option( 'allowedthemes' ); restore_current_blog(); } // This is all super old MU back compat joy. // 'allowedthemes' keys things by stylesheet. 'allowed_themes' keyed things by name. if ( false === $allowed_themes[ $blog_id ] ) { if ( $current ) { $allowed_themes[ $blog_id ] = get_option( 'allowed_themes' ); } else { switch_to_blog( $blog_id ); $allowed_themes[ $blog_id ] = get_option( 'allowed_themes' ); restore_current_blog(); } if ( ! is_array( $allowed_themes[ $blog_id ] ) || empty( $allowed_themes[ $blog_id ] ) ) { $allowed_themes[ $blog_id ] = array(); } else { $converted = array(); $themes = wp_get_themes(); foreach ( $themes as $stylesheet => $theme_data ) { if ( isset( $allowed_themes[ $blog_id ][ $theme_data->get('Name') ] ) ) $converted[ $stylesheet ] = true; } $allowed_themes[ $blog_id ] = $converted; } // Set the option so we never have to go through this pain again. if ( is_admin() && $allowed_themes[ $blog_id ] ) { if ( $current ) { update_option( 'allowedthemes', $allowed_themes[ $blog_id ] ); delete_option( 'allowed_themes' ); } else { switch_to_blog( $blog_id ); update_option( 'allowedthemes', $allowed_themes[ $blog_id ] ); delete_option( 'allowed_themes' ); restore_current_blog(); } } } return (array) $allowed_themes[ $blog_id ]; } /** * Sort themes by name. * * @since 3.4.0 * * @static * @access public */ public static function sort_by_name( &$themes ) { if ( 0 === strpos( get_locale(), 'en_' ) ) { uasort( $themes, array( 'WP_Theme', '_name_sort' ) ); } else { uasort( $themes, array( 'WP_Theme', '_name_sort_i18n' ) ); } } /** * Callback function for usort() to naturally sort themes by name. * * Accesses the Name header directly from the class for maximum speed. * Would choke on HTML but we don't care enough to slow it down with strip_tags(). * * @since 3.4.0 * * @static * @access private * * @return int */ private static function _name_sort( $a, $b ) { return strnatcasecmp( $a->headers['Name'], $b->headers['Name'] ); } /** * Name sort (with translation). * * @since 3.4.0 * * @static * @access private * * @return int */ private static function _name_sort_i18n( $a, $b ) { // Don't mark up; Do translate. return strnatcasecmp( $a->display( 'Name', false, true ), $b->display( 'Name', false, true ) ); } } 重新认识margin和负margin的实际应用 》 html5jscss

重新认识margin和负margin的实际应用

margin是我们再熟悉不过的属性了,在限定模块之间的距离、制作流动性布局、解决IE6\7 bug以及margin负值时发挥了很大作用,所以有必要总结一下,特别是要对负margin的理解,因为它对日常工作的一些问题能很好的解决。

然后,在了解 负margin 之前,我们首先得非常清楚margin是啥玩样。

Margin 是什么

The margin clears an area around an element (outside the border). The margin does not have a background color, and is completely transparent.——w3schools.

因为 margin 是 outside the border’s element,所以我们一般称呼 margin 为 外边距 (padding is inside the border,所以也被称呼为 内边距),margin的最基本用途就是:控制元素周围空间的间隔。

margin的特性

  1. margin始终是透明的,所以设置 margin 来用来控制元素空间的间隔。
  2. 提供了缺省数值的缩写(这里就不介绍了),所以在实战中我一般都采用此种写法,一来方便修改,二来节省字符。
  3. 垂直外边据合并:当两个盒子垂直外边距相遇时,只有数值大的那个外边据的值才是起作用的(这跟padding有明显的区别,如果垂直方向设置了padding且相遇,则两个盒子之间的空白等于两者之和)。
  4. 一个盒子如果没有上补白(padding-top)和上边框(border-top),那么这个盒子的上边距会和其内部文档流中的第一个子元素的上边距重叠。
  5. margin 属性可以应用于几乎所有的元素,除了表格显示类型(不包括 table-caption, table and inline-table)的元素,而且垂直外边距对非置换内联元素不起作用。

以上举的第四个特性,看如下事例代码:

css代码

.example{background:#efc}
.margin-merge1{margin:20px 0 0;}
.margin-merge2{border-top:1px solid #000}
.margin-merge3{margin:40px;background-color:red}

html代码

<div class=”example”>..</div>
<div class=”example”>
<div class=”example margin-merge1″>..</div>
</div>

margin合并后的效果

不设置宽高是为了让所有浏览器的实验条件相同,因为设置宽高处罚了IE的layout,IE中这个bug也就消失了
因为没有上补白(padding-top)和上边框(border-top),那么这个盒子的上边距会和其内部文档流中的第一个子元素的上边距重叠。

想要的效果

不设置宽高是为了让所有浏览器的实验条件相同,因为设置宽高处罚了IE的layout,IE中这个bug也就消失了
因为没有上补白(padding-top)和上边框(border-top),那么这个盒子的上边距会和其内部文档流中的第一个子元素的上边距重叠。
垂直方向上margin 合并

对于垂直外边距合并的解决方案就是,为父元素例子中的middle元素增加一个border-top或者padding-top即可解决这个问题。

产生以上情况的根本原因,也可以换句话这么说:子元素的父元素的的如果没设置border-top或者padding-top,父元素的第一个子元素就会不断一层一层的找自己祖先元素。所以只要给父元素设置border-top或者padding-top,就能解决这个问题。由此我们下次应该注意什么时候用 margin 什么时候用padding。不能因为这个bug,而给父元素增加没必要的border-top或者padding-top。解决这个问题的另外一个方法就是:分别设置_zoom:1;overflow:hidden分别触发 ie的layout创建CSS 2.1的Block Formatting Contexts来避免margin的重叠。

而究其根本原因,是因为:在margin属性中一共有两类参考线,top和left的参考线属于一类,right和bottom的参考线属于另一类。top和left是以外元素为参考,而 right和bottom是以元素本身为参考。所谓外元素就是本元素的边界元素(再白话点的解释就是元素的紧邻元素,父元素或者兄弟元素),而元素本身呢,确切含义是指以自身为参考来影响周围元素的位置(实质即为影响下边和右边相邻元素的参考线)。所以才会出现以上事例中 父元素中的第一个子元素越级将自己的margin-top当成父元素的margin-top执行的情况。

然后,如果是负值则是位移方向相反。所以得出以下结论:

当margin四个值都为正数值的话,那么margin按照正常逻辑同周围元素产生边距。当元素margin的top和left是负值时会引起元素的向上和向左位置移动。而当元素margin的bottom和right是负值时会影响右边和下边相邻元素的参考线。

margin 和 padding 的区别

  1. margin会重叠,而padding也不会重叠,而是相加。
  2. margin可以有正值和负值,而padding则只允许正值。
  3. margin是outside the border;而padding则是inside the border

常见的浏览器下margin出现的bug

margin作为布局中重要的属性,而浏览器下因margin出现的各种bug,记录如下,希望大家补充

  1. IE6中双边距Bug

    发生场合:当给父元素内第一个浮动元素设置margin-left(元素float:left)或margin-right(元素float:right)时margin加倍。

    解决方法:给浮动元素加上_display:inline或者用padding-left margin-left

    原理分析:块级对象默认的display属性值是block,当设置了浮动的同时,还设置了它的外边距就会出现这种情况。也许你会问:“为什么之后的对象和第一个对象之间就不存在双倍边距的Bug”?因为浮动都有其相对应的对象,只有相对于其父对象的浮动对象才会出现这样的问题。第一个对象是相对父对象的,而之后对象是相对第一个对象的,所以之后对象在设置后不会出现问题。为什么display:inline可以解决这个双边距bug,首先是inline元素或inline-block元素是不存在双边距问题的。然后,float:left等浮动属性可以让inline元素haslayout,会让inline元素表现得跟inline-block元素的特性一样,支持高宽,垂直margin和padding等,所以div class的所有样式可以用在这个display inline的元素上。

  2. IE6/7下ul/ol标记消失bug

    发生场合:当ul/ol触发了haslayout并且是在ul/ol上写margin-left,前面默认的ul/ol标记会消失。

    解决方法:给li设置margin-left,而不是给ul/ol设置margin-left、去掉触发haslayout的属性也可以设置list-style:inside;

    原理分析:IE6/7浏览器Bug

  3. IE6中浮动元素3px间隔Bug

    发生场合:发生在一个元素浮动,然后一个不浮动的元素自然上浮与之靠近会出现的3px的bug。

    解决方法:右边元素也一起浮动;或者为右边元素添加IE6 Hack _margin-left:-3px;从而消除3px间距。

    原理分析:IE6浏览器缺陷Bug。

  4. IE6/7负margin隐藏Bug

    发生场合:当给一个有hasLayout的父元素内的非hasLayout元素设置负margin时,超出父元素部分不可见。

    解决方法:去掉父元素的hasLayout;或者赋hasLayout给子元素,譬如position:relative

    原理分析:IE6/7独有的hasLayout产生问题。

  5. IE6/7下margin与absolute元素重叠bug

    发生场合:双栏自适应布局中,左侧元素absolute绝对定位,右侧的margin撑开距离定位。在IE6/7下左侧应用了absolute属性的块级元素与右边的自适应的文字内容重叠。

    解决方法:把左侧块级元素更改为内联元素,比如把 display:inline

    原理分析:这是由于IE6/IE7浏览器将inline水平标签元素和block水平的标签元素没有加以区分一视同仁渲染了。属于IE6/7浏览器渲染Bug。

  6. IE6/7/8下auto margin居中bug

    发生场合:给block元素设置margin auto无法居中

    解决方法:出现这种bug的原因通常是没有Doctype,然后触发了ie的quirks mode,加上Doctype声明就可以了。

    原理分析:缺少Doctype声明。

  7. IE8下input[button | submit] 设置margin:auto无法居中

    发生场合:ie8下,如果给像button这样的标签(如button input[type=”button”] input[type=”submit”])设置{ display: block; margin:0 auto; }如果不设置宽度的话无法居中。

    解决方法:可以给为input加上宽度。

    原理分析:IE8浏览器Bug。

负Margin的应用

了解完margin,把平时能将其应用到实战中例举出来。

对显示border的应用

在选项卡边框线的处理

html代码

<div id="demoTab" class="demoTab">
    <ul class="demoTabNav clearfix">
        <li class="demoTabList current">前端</li>
        <li class="demoTabList">实战</li>
        <li class="demoTabList">交互</li>
        <li class="demoTabList">优化</li>
    </ul>
    <ul class="demoTabBd">
        <li class="demoTabContent current">这是第一个选项卡的内容。</li>
        <li class="demoTabContent">这是第二个选项卡的内容。</li>
        <li class="demoTabContent">这是第三个选项卡的内容。</li>
        <li class="demoTabContent">这是第四个选项卡的内容。</li>
    </ul>
</div>

css代码

.demoTab{width:400px; font:14px/1.5 Microsoft YaHei,verdana,Helvetica,Arial,sans-serif;}
.demoTab .demoTabNav{height:28px; overflow:hidden; *zoom:1;margin-bottom:-1px; border:1px solid red; border-bottom:none; background:#EAF0FD;}
.demoTab .demoTabList{float:left; margin-left:-1px;  padding:0 22px; line-height:28px; border-left:1px solid red; border-right:1px solid red;  font-weight:bold; color:#005590; text-align:center; cursor:pointer;}
.demoTab .demoTabList.current{position:relative; background:#fff;}
.demoTab .demoTabBd{border:1px solid red;padding:15px;}
.demoTab .demoTabContent{display:none;}
.demoTab .demoTabContent.current{display:block;}

DEMO

负margin在选项卡边框线的应用

如上DEMO,使用margin-bottom:-1px;解决选项卡下边框显示的问题,使选项卡主体部分往上提了 -1px(或者也可以在主体部分使用margin-top:-1px;具体情况具体分析),而选项卡上的选项左右边框,可以让每个div都有左右1像素的边框,然后margin-right:-1px;或是margin-left:-1px;让之间的边框重叠来达到效果,像这种隐藏首末边框的不仅在水平方向上而且在竖直方向上也有应用,代码如下:

html代码

<ul class="cross">
    <li>这里是一条信息</li>
    <li>这里是一条信息</li>
    <li>这里是一条信息</li>
    <li>这里是一条信息</li>
    <li>这里是一条信息</li>
    <li>这里是一条信息</li>
</ul>

<ul class="vertical">
<li>这里是一条信息</li>
<li>这里是一条信息</li>
<li>这里是一条信息</li>
<li>这里是一条信息</li>
<li>这里是一条信息</li>
<li>这里是一条信息</li>
</ul>

css代码

.cross{overflow: hidden;zoom: 1;}
.cross li{float: left;padding: 0 11px 0 10px;border-left:1px solid #AAA;margin-left:-1px;}
.vertical{overflow: hidden;_zoom:1; }
.vertical li{border-top:1px dashed #CEE1EE;padding:5px 0;margin:-1px 0 0}

DEMO

  • 这里是一条信息
  • 这里是一条信息
  • 这里是一条信息
  • 这里是一条信息
  • 这里是一条信息
  • 这里是一条信息
  • 这里是一条信息
  • 这里是一条信息
  • 这里是一条信息
  • 这里是一条信息
隐藏首(末)边框

在流动性布局中的应用

在介绍 Block Formatting Context可以阻止元素覆盖浮动盒模型 中出现过一个流动布局,它是 利用 创建CSS2.0中的Block Formatting Context和IE触发layout 来实现的,而使用 负margin 实现的流体布局好处之一就是让 main部分显示在html结构最前面。

网很多介绍文章,我就直接贴代码了

css代码

.grid{width:960px;margin:0 auto;overflow:hidden;zoom:1;}
.main-wrap{width:100%}
.main{background-color:#FAFAFA}
.sub{width:300px;background-color:#FF3377}
.extra{width:100px;background-color:#fd5}
.main-wrap,.sub, .extra{float:left;}
.main,.sub,.extra{height:200px;}
.grid1 .main{margin:0 400px 0 0}
.grid1 .sub{margin:0 0 0 -400px;}
.grid1 .extra{margin:0 0 0 -100px}
.grid2 .main{margin:0 300px 0 100px}
.grid2 .sub{margin:0 0 0 -300px}
.grid2 .extra{margin:0 0 0 -960px}
.grid3 .main{margin:0 0 0 300px}
.grid3 .sub{margin:0 0 0 -960px;}
.grid4 .main{margin:0 0 0 -960px;}
.grid4 .extra{margin:0 0 0 -100px;}

html代码

<div class="grid grid1">
    <div class="main-wrap">
        <div class="main">main</div>
    </div>
    <div class="sub"> sub</div>
    <div class="extra"> extra</div>
</div>

DEMO

main
sub
extra
main
sub
extra
main
sub
main
extra
流动布局中负margin的应用

css代码

.grail{overflow:hidden;zoom:1}
.grail-main{float:left;width:100%;background-color:#FAFAFA}
.grail-sub{float:left;width:300px;margin:0 0 0 -300px;background-color:#FF3377}
.grail-extra{float:left;width:100px;margin:0 0 0 -100%;background-color:#fd5}

html代码

<div class="grail">
    <div class="grail-main">main</div>
    <div class="grail-sub"> sub</div>
    <div class="grail-extra"> extra</div>
</div>

DEMO

main
sub
extra
圣杯布局

其他应用

margin的其他应用:

  • 使用 使用margin负边距剪切图片 控制box的大小,进而控制其中img的显示区域。
  • 使用 负margin 来代替某块用 relative/absolute 定位。
  • 现在想不起来了,想到了就来更新

本文源链接:http://www.html5jscss.com/negative-margin.html

转载请注明《重新认识margin和负margin的实际应用》| html5jscss