2006-04-18 00:44:33 -04:00
< ? php
2008-08-12 16:18:05 -04:00
/**
2008-09-01 01:44:16 -04:00
* Theme , template , and stylesheet functions .
*
2008-08-12 16:18:05 -04:00
* @ package WordPress
2008-09-01 01:44:16 -04:00
* @ subpackage Template
*/
2010-05-03 16:56:57 -04:00
/**
* Whether a child theme is in use .
*
* @ since 3.0 . 0
*
* @ return bool true if a child theme is in use , false otherwise .
**/
function is_child_theme () {
return ( TEMPLATEPATH !== STYLESHEETPATH );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve name of the current stylesheet .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* The theme name that the administrator has currently set the front end theme
2008-09-01 01:44:16 -04:00
* as .
*
2008-09-24 01:24:33 -04:00
* For all extensive purposes , the template name and the stylesheet name are
* going to be the same for most cases .
*
2008-09-01 01:44:16 -04:00
* @ since 1.5 . 0
2008-09-24 01:24:33 -04:00
* @ uses apply_filters () Calls 'stylesheet' filter on stylesheet name .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return string Stylesheet name .
2006-04-18 00:44:33 -04:00
*/
function get_stylesheet () {
2006-08-30 17:46:31 -04:00
return apply_filters ( 'stylesheet' , get_option ( 'stylesheet' ));
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve stylesheet directory path for current theme .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
2008-09-24 01:24:33 -04:00
* @ uses apply_filters () Calls 'stylesheet_directory' filter on stylesheet directory and theme name .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return string Path to current theme directory .
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_stylesheet_directory () {
$stylesheet = get_stylesheet ();
2009-10-13 15:06:35 -04:00
$theme_root = get_theme_root ( $stylesheet );
$stylesheet_dir = " $theme_root / $stylesheet " ;
return apply_filters ( 'stylesheet_directory' , $stylesheet_dir , $stylesheet , $theme_root );
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve stylesheet directory URI .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_stylesheet_directory_uri () {
2006-10-16 01:57:33 -04:00
$stylesheet = get_stylesheet ();
2009-10-13 15:06:35 -04:00
$theme_root_uri = get_theme_root_uri ( $stylesheet );
$stylesheet_dir_uri = " $theme_root_uri / $stylesheet " ;
return apply_filters ( 'stylesheet_directory_uri' , $stylesheet_dir_uri , $stylesheet , $theme_root_uri );
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve URI of current theme stylesheet .
2008-09-01 01:44:16 -04:00
*
2008-12-09 13:03:31 -05:00
* The stylesheet file name is 'style.css' which is appended to { @ link
2008-09-24 01:24:33 -04:00
* get_stylesheet_directory_uri () stylesheet directory URI } path .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
2008-09-24 01:24:33 -04:00
* @ uses apply_filters () Calls 'stylesheet_uri' filter on stylesheet URI path and stylesheet directory URI .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
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 );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve localized stylesheet URI .
2008-09-01 01:44:16 -04:00
*
2008-09-25 10:12:58 -04:00
* 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
* locale followed by '.css' . If that does not exist , then the text direction
* 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 .
* 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 .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
2008-09-24 01:24:33 -04:00
* @ uses apply_filters () Calls 'locale_stylesheet_uri' filter on stylesheet URI path and stylesheet directory URI .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-09-18 19:40:19 -04:00
function get_locale_stylesheet_uri () {
global $wp_locale ;
$stylesheet_dir_uri = get_stylesheet_directory_uri ();
$dir = get_stylesheet_directory ();
$locale = get_locale ();
if ( file_exists ( " $dir / $locale .css " ) )
$stylesheet_uri = " $stylesheet_dir_uri / $locale .css " ;
2006-10-13 06:33:44 -04:00
elseif ( ! empty ( $wp_locale -> text_direction ) && file_exists ( " $dir / { $wp_locale -> text_direction } .css " ) )
2006-09-18 19:40:19 -04:00
$stylesheet_uri = " $stylesheet_dir_uri / { $wp_locale -> text_direction } .css " ;
else
$stylesheet_uri = '' ;
return apply_filters ( 'locale_stylesheet_uri' , $stylesheet_uri , $stylesheet_dir_uri );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve name of the current theme .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
2008-09-24 01:24:33 -04:00
* @ uses apply_filters () Calls 'template' filter on template option .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return string Template name .
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_template () {
2006-08-30 17:46:31 -04:00
return apply_filters ( 'template' , get_option ( 'template' ));
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve current theme directory .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
2008-09-24 01:24:33 -04:00
* @ uses apply_filters () Calls 'template_directory' filter on template directory path and template name .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return string Template directory path .
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_template_directory () {
$template = get_template ();
2009-10-13 15:06:35 -04:00
$theme_root = get_theme_root ( $template );
$template_dir = " $theme_root / $template " ;
2009-10-15 16:26:21 -04:00
2009-10-13 15:06:35 -04:00
return apply_filters ( 'template_directory' , $template_dir , $template , $theme_root );
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve theme directory URI .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
2008-09-24 01:24:33 -04:00
* @ uses apply_filters () Calls 'template_directory_uri' filter on template directory URI path and template name .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return string Template directory URI .
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_template_directory_uri () {
$template = get_template ();
2009-10-13 15:06:35 -04:00
$theme_root_uri = get_theme_root_uri ( $template );
$template_dir_uri = " $theme_root_uri / $template " ;
2009-10-15 16:26:21 -04:00
2009-10-13 15:06:35 -04:00
return apply_filters ( 'template_directory_uri' , $template_dir_uri , $template , $theme_root_uri );
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve theme data from parsed theme file .
2008-09-01 01:44:16 -04:00
*
2008-09-25 10:12:58 -04:00
* The description will have the tags filtered with the following HTML elements
* whitelisted . The < b > 'a' </ b > element with the < em > href </ em > and < em > title </ em >
* attributes . The < b > abbr </ b > element with the < em > title </ em > attribute . The
* < b > acronym < b > element with the < em > title </ em > attribute allowed . The
* < b > code </ b > , < b > em </ b > , and < b > strong </ b > elements also allowed .
*
* The style . css file must contain theme name , theme URI , and description . The
* data can also contain author URI , author , template ( parent template ),
* version , status , and finally tags . Some of these are not used by WordPress
* administration panels , but are used by theme directory web sites which list
* the theme .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2008-09-24 01:24:33 -04:00
* @ param string $theme_file Theme file path .
* @ return array Theme data .
2008-09-01 01:44:16 -04:00
*/
2006-11-29 18:18:35 -05:00
function get_theme_data ( $theme_file ) {
2010-01-15 17:11:12 -05:00
$default_headers = array (
'Name' => 'Theme Name' ,
'URI' => 'Theme URI' ,
'Description' => 'Description' ,
'Author' => 'Author' ,
2009-10-15 17:07:00 -04:00
'AuthorURI' => 'Author URI' ,
2010-01-15 17:11:12 -05:00
'Version' => 'Version' ,
'Template' => 'Template' ,
'Status' => 'Status' ,
2009-10-15 17:07:00 -04:00
'Tags' => 'Tags'
);
2007-05-10 23:44:03 -04:00
$themes_allowed_tags = array (
'a' => array (
'href' => array (), 'title' => array ()
),
'abbr' => array (
'title' => array ()
),
'acronym' => array (
'title' => array ()
),
'code' => array (),
'em' => array (),
'strong' => array ()
);
2007-06-13 22:25:30 -04:00
2009-10-15 17:07:00 -04:00
$theme_data = get_file_data ( $theme_file , $default_headers , 'theme' );
2009-03-19 20:52:42 -04:00
2009-10-15 17:07:00 -04:00
$theme_data [ 'Name' ] = $theme_data [ 'Title' ] = wp_kses ( $theme_data [ 'Name' ], $themes_allowed_tags );
2009-04-20 14:18:39 -04:00
2009-10-15 17:07:00 -04:00
$theme_data [ 'URI' ] = esc_url ( $theme_data [ 'URI' ] );
2008-01-10 15:51:07 -05:00
2009-10-15 17:07:00 -04:00
$theme_data [ 'Description' ] = wptexturize ( wp_kses ( $theme_data [ 'Description' ], $themes_allowed_tags ) );
2008-01-10 15:51:07 -05:00
2009-10-15 17:07:00 -04:00
$theme_data [ 'AuthorURI' ] = esc_url ( $theme_data [ 'AuthorURI' ] );
2007-06-13 22:25:30 -04:00
2009-10-15 17:07:00 -04:00
$theme_data [ 'Template' ] = wp_kses ( $theme_data [ 'Template' ], $themes_allowed_tags );
$theme_data [ 'Version' ] = wp_kses ( $theme_data [ 'Version' ], $themes_allowed_tags );
2007-06-13 22:25:30 -04:00
2009-10-15 17:07:00 -04:00
if ( $theme_data [ 'Status' ] == '' )
$theme_data [ 'Status' ] = 'publish' ;
2006-04-18 00:44:33 -04:00
else
2009-10-15 17:07:00 -04:00
$theme_data [ 'Status' ] = wp_kses ( $theme_data [ 'Status' ], $themes_allowed_tags );
2007-06-13 22:25:30 -04:00
2009-10-15 17:07:00 -04:00
if ( $theme_data [ 'Tags' ] == '' )
$theme_data [ 'Tags' ] = array ();
2007-12-31 13:39:43 -05:00
else
2009-10-15 17:07:00 -04:00
$theme_data [ 'Tags' ] = array_map ( 'trim' , explode ( ',' , wp_kses ( $theme_data [ 'Tags' ], array () ) ) );
2007-12-31 13:39:43 -05:00
2009-10-15 17:07:00 -04:00
if ( $theme_data [ 'Author' ] == '' ) {
$theme_data [ 'Author' ] = __ ( 'Anonymous' );
} else {
if ( empty ( $theme_data [ 'AuthorURI' ] ) ) {
$theme_data [ 'Author' ] = wp_kses ( $theme_data [ 'Author' ], $themes_allowed_tags );
2008-01-10 15:51:07 -05:00
} else {
2009-10-15 17:07:00 -04:00
$theme_data [ 'Author' ] = sprintf ( '<a href="%1$s" title="%2$s">%3$s</a>' , $theme_data [ 'AuthorURI' ], __ ( 'Visit author homepage' ), wp_kses ( $theme_data [ 'Author' ], $themes_allowed_tags ) );
2008-01-10 15:51:07 -05:00
}
2006-04-18 00:44:33 -04:00
}
2009-10-15 17:07:00 -04:00
return $theme_data ;
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve list of themes with theme data in theme directory .
2008-09-01 01:44:16 -04:00
*
2008-09-25 10:12:58 -04:00
* The theme is broken , if it doesn ' t have a parent theme and is missing either
* style . css and , or index . php . If the theme has a parent theme then it is
* broken , if it is missing style . css ; index . php is optional . The broken theme
* list is saved in the { @ link $wp_broken_themes } global , which is displayed on
* the theme list in the administration panels .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
2008-09-25 10:12:58 -04:00
* @ global array $wp_broken_themes Stores the broken themes .
* @ global array $wp_themes Stores the working themes .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return array Theme list with theme data .
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_themes () {
2006-10-13 06:33:44 -04:00
global $wp_themes , $wp_broken_themes ;
2006-04-18 00:44:33 -04:00
if ( isset ( $wp_themes ) )
return $wp_themes ;
2009-10-15 16:45:32 -04:00
/* Register the default root as a theme directory */
register_theme_directory ( get_theme_root () );
2006-04-18 00:44:33 -04:00
2009-10-13 15:06:35 -04:00
if ( ! $theme_files = search_theme_directories () )
2006-10-16 01:57:33 -04:00
return false ;
2009-10-15 16:26:21 -04:00
2009-10-13 15:06:35 -04:00
asort ( $theme_files );
2009-10-15 16:26:21 -04:00
2009-10-29 20:18:15 -04:00
$wp_themes = array ();
2006-10-13 06:33:44 -04:00
foreach ( ( array ) $theme_files as $theme_file ) {
2009-10-13 15:06:35 -04:00
$theme_root = $theme_file [ 'theme_root' ];
$theme_file = $theme_file [ 'theme_file' ];
2006-10-13 06:33:44 -04:00
if ( ! is_readable ( " $theme_root / $theme_file " ) ) {
2006-04-18 00:44:33 -04:00
$wp_broken_themes [ $theme_file ] = array ( 'Name' => $theme_file , 'Title' => $theme_file , 'Description' => __ ( 'File not readable.' ));
continue ;
}
$theme_data = get_theme_data ( " $theme_root / $theme_file " );
2006-10-13 06:33:44 -04:00
$name = $theme_data [ 'Name' ];
$title = $theme_data [ 'Title' ];
2006-04-18 00:44:33 -04:00
$description = wptexturize ( $theme_data [ 'Description' ]);
2006-10-13 06:33:44 -04:00
$version = $theme_data [ 'Version' ];
$author = $theme_data [ 'Author' ];
$template = $theme_data [ 'Template' ];
$stylesheet = dirname ( $theme_file );
2006-04-18 00:44:33 -04:00
2007-05-14 19:30:17 -04:00
$screenshot = false ;
2006-10-13 06:33:44 -04:00
foreach ( array ( 'png' , 'gif' , 'jpg' , 'jpeg' ) as $ext ) {
2006-04-18 00:44:33 -04:00
if ( file_exists ( " $theme_root / $stylesheet /screenshot. $ext " )) {
$screenshot = " screenshot. $ext " ;
break ;
}
}
if ( empty ( $name ) ) {
$name = dirname ( $theme_file );
$title = $name ;
}
2010-02-07 18:19:39 -05:00
$parent_template = $template ;
2006-04-18 00:44:33 -04:00
if ( empty ( $template ) ) {
2009-10-27 13:17:23 -04:00
if ( file_exists ( " $theme_root / $stylesheet /index.php " ) )
$template = $stylesheet ;
2006-10-13 06:33:44 -04:00
else
2006-04-18 00:44:33 -04:00
continue ;
}
2009-10-15 16:26:21 -04:00
2009-10-13 15:06:35 -04:00
$template = trim ( $template );
2006-04-18 00:44:33 -04:00
if ( ! file_exists ( " $theme_root / $template /index.php " ) ) {
2006-10-18 16:24:59 -04:00
$parent_dir = dirname ( dirname ( $theme_file ));
if ( file_exists ( " $theme_root / $parent_dir / $template /index.php " ) ) {
2009-10-27 13:17:23 -04:00
$template = " $parent_dir / $template " ;
2009-10-29 20:18:15 -04:00
$template_directory = " $theme_root / $template " ;
2006-10-18 16:24:59 -04:00
} else {
2009-10-15 16:26:21 -04:00
/**
* The parent theme doesn 't exist in the current theme' s folder or sub folder
* so lets use the theme root for the parent template .
2009-10-13 15:06:35 -04:00
*/
2009-11-19 11:35:17 -05:00
if ( isset ( $theme_files [ $template ]) && file_exists ( $theme_files [ $template ][ 'theme_root' ] . " / $template /index.php " ) ) {
$template_directory = $theme_files [ $template ][ 'theme_root' ] . " / $template " ;
2009-10-13 15:06:35 -04:00
} else {
2010-02-07 18:19:39 -05:00
if ( empty ( $parent_template ) )
$wp_broken_themes [ $name ] = array ( 'Name' => $name , 'Title' => $title , 'Description' => __ ( 'Template is missing.' ), 'error' => 'no_template' );
else
$wp_broken_themes [ $name ] = array ( 'Name' => $name , 'Title' => $title , 'Description' => sprintf ( __ ( 'The parent theme is missing. Please install the "%s" parent theme.' ), $parent_template ), 'error' => 'no_parent' , 'parent' => $parent_template );
2009-10-13 15:06:35 -04:00
continue ;
}
2009-10-15 16:26:21 -04:00
2006-10-18 16:24:59 -04:00
}
2009-10-13 15:06:35 -04:00
} else {
2009-10-27 13:17:23 -04:00
$template_directory = trim ( $theme_root . '/' . $template );
2006-04-18 00:44:33 -04:00
}
2009-10-15 16:26:21 -04:00
2006-04-18 00:44:33 -04:00
$stylesheet_files = array ();
2008-07-30 02:21:14 -04:00
$template_files = array ();
2008-08-09 01:36:14 -04:00
2006-04-18 00:44:33 -04:00
$stylesheet_dir = @ dir ( " $theme_root / $stylesheet " );
if ( $stylesheet_dir ) {
2006-10-13 06:33:44 -04:00
while ( ( $file = $stylesheet_dir -> read ()) !== false ) {
2008-07-30 02:21:14 -04:00
if ( ! preg_match ( '|^\.+$|' , $file ) ) {
if ( preg_match ( '|\.css$|' , $file ) )
2009-10-13 15:06:35 -04:00
$stylesheet_files [] = " $theme_root / $stylesheet / $file " ;
2008-07-30 02:21:14 -04:00
elseif ( preg_match ( '|\.php$|' , $file ) )
2009-10-13 15:06:35 -04:00
$template_files [] = " $theme_root / $stylesheet / $file " ;
2008-07-30 02:21:14 -04:00
}
2006-04-18 00:44:33 -04:00
}
2009-03-25 12:51:08 -04:00
@ $stylesheet_dir -> close ();
2006-04-18 00:44:33 -04:00
}
2009-04-20 14:18:39 -04:00
2009-10-27 13:17:23 -04:00
$template_dir = @ dir ( " $template_directory " );
2006-04-18 00:44:33 -04:00
if ( $template_dir ) {
2009-03-25 12:51:08 -04:00
while ( ( $file = $template_dir -> read ()) !== false ) {
if ( preg_match ( '|^\.+$|' , $file ) )
continue ;
if ( preg_match ( '|\.php$|' , $file ) ) {
2009-10-27 13:17:23 -04:00
$template_files [] = " $template_directory / $file " ;
} elseif ( is_dir ( " $template_directory / $file " ) ) {
$template_subdir = @ dir ( " $template_directory / $file " );
2009-12-17 14:56:05 -05:00
if ( ! $template_subdir )
continue ;
2009-03-25 12:51:08 -04:00
while ( ( $subfile = $template_subdir -> read ()) !== false ) {
if ( preg_match ( '|^\.+$|' , $subfile ) )
continue ;
if ( preg_match ( '|\.php$|' , $subfile ) )
2009-10-27 13:17:23 -04:00
$template_files [] = " $template_directory / $file / $subfile " ;
2009-03-25 12:51:08 -04:00
}
@ $template_subdir -> close ();
}
2006-04-18 00:44:33 -04:00
}
2009-04-20 14:18:39 -04:00
@ $template_dir -> close ();
2006-04-18 00:44:33 -04:00
}
2009-11-19 15:45:37 -05:00
//Make unique and remove duplicates when stylesheet and template are the same i.e. most themes
$template_files = array_unique ( $template_files );
$stylesheet_files = array_unique ( $stylesheet_files );
2010-01-15 17:11:12 -05:00
2006-04-18 00:44:33 -04:00
$template_dir = dirname ( $template_files [ 0 ]);
$stylesheet_dir = dirname ( $stylesheet_files [ 0 ]);
if ( empty ( $template_dir ) )
$template_dir = '/' ;
if ( empty ( $stylesheet_dir ) )
$stylesheet_dir = '/' ;
// Check for theme name collision. This occurs if a theme is copied to
// a new theme directory and the theme header is not updated. Whichever
// theme is first keeps the name. Subsequent themes get a suffix applied.
// The Default and Classic themes always trump their pretenders.
2009-10-29 20:18:15 -04:00
if ( isset ( $wp_themes [ $name ]) ) {
2006-04-18 00:44:33 -04:00
if ( ( 'WordPress Default' == $name || 'WordPress Classic' == $name ) &&
( 'default' == $stylesheet || 'classic' == $stylesheet ) ) {
// If another theme has claimed to be one of our default themes, move
// them aside.
2009-10-29 20:18:15 -04:00
$suffix = $wp_themes [ $name ][ 'Stylesheet' ];
2006-04-18 00:44:33 -04:00
$new_name = " $name / $suffix " ;
2009-10-29 20:18:15 -04:00
$wp_themes [ $new_name ] = $wp_themes [ $name ];
$wp_themes [ $new_name ][ 'Name' ] = $new_name ;
2006-04-18 00:44:33 -04:00
} else {
$name = " $name / $stylesheet " ;
}
}
2009-10-13 15:06:35 -04:00
$theme_roots [ $stylesheet ] = str_replace ( WP_CONTENT_DIR , '' , $theme_root );
2009-10-29 20:18:15 -04:00
$wp_themes [ $name ] = array ( 'Name' => $name , 'Title' => $title , 'Description' => $description , 'Author' => $author , 'Version' => $version , 'Template' => $template , 'Stylesheet' => $stylesheet , 'Template Files' => $template_files , 'Stylesheet Files' => $stylesheet_files , 'Template Dir' => $template_dir , 'Stylesheet Dir' => $stylesheet_dir , 'Status' => $theme_data [ 'Status' ], 'Screenshot' => $screenshot , 'Tags' => $theme_data [ 'Tags' ], 'Theme Root' => $theme_root , 'Theme Root URI' => str_replace ( WP_CONTENT_DIR , content_url (), $theme_root ) );
2006-04-18 00:44:33 -04:00
}
2009-10-29 20:18:15 -04:00
unset ( $theme_files );
2009-10-13 15:06:35 -04:00
/* Store theme roots in the DB */
2009-10-29 17:53:57 -04:00
if ( get_site_transient ( 'theme_roots' ) != $theme_roots )
set_site_transient ( 'theme_roots' , $theme_roots , 7200 ); // cache for two hours
2009-10-29 20:18:15 -04:00
unset ( $theme_roots );
2006-04-18 00:44:33 -04:00
2009-10-29 20:18:15 -04:00
/* Resolve theme dependencies. */
$theme_names = array_keys ( $wp_themes );
2006-10-13 06:33:44 -04:00
foreach ( ( array ) $theme_names as $theme_name ) {
2009-10-29 20:18:15 -04:00
$wp_themes [ $theme_name ][ 'Parent Theme' ] = '' ;
if ( $wp_themes [ $theme_name ][ 'Stylesheet' ] != $wp_themes [ $theme_name ][ 'Template' ] ) {
2006-10-13 06:33:44 -04:00
foreach ( ( array ) $theme_names as $parent_theme_name ) {
2009-10-29 20:18:15 -04:00
if ( ( $wp_themes [ $parent_theme_name ][ 'Stylesheet' ] == $wp_themes [ $parent_theme_name ][ 'Template' ]) && ( $wp_themes [ $parent_theme_name ][ 'Template' ] == $wp_themes [ $theme_name ][ 'Template' ]) ) {
$wp_themes [ $theme_name ][ 'Parent Theme' ] = $wp_themes [ $parent_theme_name ][ 'Name' ];
2006-04-18 00:44:33 -04:00
break ;
}
}
}
}
2009-10-29 20:18:15 -04:00
return $wp_themes ;
2006-04-18 00:44:33 -04:00
}
2009-10-13 15:06:35 -04:00
/**
* Retrieve theme roots .
*
* @ since 2.9 . 0
*
* @ return array Theme roots
*/
function get_theme_roots () {
2009-10-29 17:53:57 -04:00
$theme_roots = get_site_transient ( 'theme_roots' );
2009-10-13 15:06:35 -04:00
if ( false === $theme_roots ) {
get_themes ();
2009-10-29 17:53:57 -04:00
$theme_roots = get_site_transient ( 'theme_roots' ); // this is set in get_theme()
2009-10-13 15:06:35 -04:00
}
return $theme_roots ;
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve theme data .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2008-09-24 01:24:33 -04:00
* @ param string $theme Theme name .
* @ return array | null Null , if theme name does not exist . Theme data , if exists .
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_theme ( $theme ) {
$themes = get_themes ();
if ( array_key_exists ( $theme , $themes ) )
return $themes [ $theme ];
2008-09-24 01:24:33 -04:00
return null ;
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve current theme display name .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* If the 'current_theme' option has already been set , then it will be returned
* instead . If it is not set , then each theme will be iterated over until both
* the current stylesheet and current template name .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_current_theme () {
2007-11-13 00:07:44 -05:00
if ( $theme = get_option ( 'current_theme' ) )
return $theme ;
2006-04-18 00:44:33 -04:00
$themes = get_themes ();
$theme_names = array_keys ( $themes );
2006-08-30 17:46:31 -04:00
$current_template = get_option ( 'template' );
$current_stylesheet = get_option ( 'stylesheet' );
2006-04-18 00:44:33 -04:00
$current_theme = 'WordPress Default' ;
if ( $themes ) {
2006-10-13 06:33:44 -04:00
foreach ( ( array ) $theme_names as $theme_name ) {
2006-04-18 00:44:33 -04:00
if ( $themes [ $theme_name ][ 'Stylesheet' ] == $current_stylesheet &&
$themes [ $theme_name ][ 'Template' ] == $current_template ) {
$current_theme = $themes [ $theme_name ][ 'Name' ];
break ;
}
}
}
2007-11-13 00:07:44 -05:00
update_option ( 'current_theme' , $current_theme );
2006-04-18 00:44:33 -04:00
return $current_theme ;
}
2009-10-13 15:06:35 -04:00
/**
2009-10-15 16:45:32 -04:00
* Register a directory that contains themes .
2009-10-13 15:06:35 -04:00
*
* @ since 2.9 . 0
*
2009-10-15 16:45:32 -04:00
* @ param string $directory Either the full filesystem path to a theme folder or a folder within WP_CONTENT_DIR
2009-10-13 15:06:35 -04:00
* @ return bool
*/
2009-10-15 16:45:32 -04:00
function register_theme_directory ( $directory ) {
2009-10-13 15:06:35 -04:00
global $wp_theme_directories ;
2009-12-08 16:29:12 -05:00
2009-10-15 16:45:32 -04:00
/* If this folder does not exist, return and do not register */
if ( ! file_exists ( $directory ) )
/* Try prepending as the theme directory could be relative to the content directory */
$registered_directory = WP_CONTENT_DIR . '/' . $directory ;
else
$registered_directory = $directory ;
2009-12-08 16:29:12 -05:00
2009-10-13 15:06:35 -04:00
/* If this folder does not exist, return and do not register */
if ( ! file_exists ( $registered_directory ) )
return false ;
2009-10-15 16:26:21 -04:00
2009-10-13 15:06:35 -04:00
$wp_theme_directories [] = $registered_directory ;
2009-10-15 16:26:21 -04:00
2009-10-13 15:06:35 -04:00
return true ;
}
/**
* Search all registered theme directories for complete and valid themes .
*
* @ since 2.9 . 0
*
* @ return array Valid themes found
*/
function search_theme_directories () {
global $wp_theme_directories , $wp_broken_themes ;
if ( empty ( $wp_theme_directories ) )
return false ;
$theme_files = array ();
$wp_broken_themes = array ();
/* Loop the registered theme directories and extract all themes */
foreach ( ( array ) $wp_theme_directories as $theme_root ) {
$theme_loc = $theme_root ;
2009-10-15 16:26:21 -04:00
2009-10-13 15:06:35 -04:00
/* We don't want to replace all forward slashes, see Trac #4541 */
2009-10-15 16:26:21 -04:00
if ( '/' != WP_CONTENT_DIR )
2009-10-13 15:06:35 -04:00
$theme_loc = str_replace ( WP_CONTENT_DIR , '' , $theme_root );
/* Files in the root of the current theme directory and one subdir down */
$themes_dir = @ opendir ( $theme_root );
if ( ! $themes_dir )
return false ;
while ( ( $theme_dir = readdir ( $themes_dir )) !== false ) {
if ( is_dir ( $theme_root . '/' . $theme_dir ) && is_readable ( $theme_root . '/' . $theme_dir ) ) {
2009-10-22 16:15:54 -04:00
if ( $theme_dir { 0 } == '.' || $theme_dir == 'CVS' )
2009-10-13 15:06:35 -04:00
continue ;
2009-10-22 16:15:54 -04:00
$stylish_dir = @ opendir ( $theme_root . '/' . $theme_dir );
2009-10-13 15:06:35 -04:00
$found_stylesheet = false ;
2009-10-15 16:26:21 -04:00
2009-10-13 15:06:35 -04:00
while ( ( $theme_file = readdir ( $stylish_dir )) !== false ) {
if ( $theme_file == 'style.css' ) {
$theme_files [ $theme_dir ] = array ( 'theme_file' => $theme_dir . '/' . $theme_file , 'theme_root' => $theme_root );
$found_stylesheet = true ;
break ;
}
}
@ closedir ( $stylish_dir );
2009-10-15 16:26:21 -04:00
2009-10-13 15:06:35 -04:00
if ( ! $found_stylesheet ) { // look for themes in that dir
$subdir = " $theme_root / $theme_dir " ;
$subdir_name = $theme_dir ;
2009-10-22 16:15:54 -04:00
$theme_subdirs = @ opendir ( $subdir );
2009-10-15 16:26:21 -04:00
2009-10-27 13:32:12 -04:00
$found_subdir_themes = false ;
2009-10-22 16:15:54 -04:00
while ( ( $theme_subdir = readdir ( $theme_subdirs )) !== false ) {
if ( is_dir ( $subdir . '/' . $theme_subdir ) && is_readable ( $subdir . '/' . $theme_subdir ) ) {
if ( $theme_subdir { 0 } == '.' || $theme_subdir == 'CVS' )
2009-10-13 15:06:35 -04:00
continue ;
2009-10-15 16:26:21 -04:00
2009-10-22 16:15:54 -04:00
$stylish_dir = @ opendir ( $subdir . '/' . $theme_subdir );
2009-10-13 15:06:35 -04:00
$found_stylesheet = false ;
2009-10-15 16:26:21 -04:00
2009-10-13 15:06:35 -04:00
while ( ( $theme_file = readdir ( $stylish_dir )) !== false ) {
if ( $theme_file == 'style.css' ) {
2009-10-27 12:45:30 -04:00
$theme_files [ " $theme_dir / $theme_subdir " ] = array ( 'theme_file' => $subdir_name . '/' . $theme_subdir . '/' . $theme_file , 'theme_root' => $theme_root );
2009-10-13 15:06:35 -04:00
$found_stylesheet = true ;
2009-10-27 13:32:12 -04:00
$found_subdir_themes = true ;
2009-10-13 15:06:35 -04:00
break ;
}
}
@ closedir ( $stylish_dir );
}
}
@ closedir ( $theme_subdir );
2009-10-27 13:32:12 -04:00
if ( ! $found_subdir_themes )
$wp_broken_themes [ $theme_dir ] = array ( 'Name' => $theme_dir , 'Title' => $theme_dir , 'Description' => __ ( 'Stylesheet is missing.' ));
2009-10-13 15:06:35 -04:00
}
}
}
if ( is_dir ( $theme_dir ) )
@ closedir ( $theme_dir );
}
return $theme_files ;
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve path to themes directory .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* Does not have trailing slash .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
2009-10-13 15:06:35 -04:00
* @ param $stylesheet_or_template The stylesheet or template name of the theme
2008-09-24 01:24:33 -04:00
* @ uses apply_filters () Calls 'theme_root' filter on path .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return string Theme path .
2008-09-01 01:44:16 -04:00
*/
2009-10-13 15:06:35 -04:00
function get_theme_root ( $stylesheet_or_template = false ) {
2009-10-15 16:45:32 -04:00
if ( $stylesheet_or_template ) {
$theme_roots = get_theme_roots ();
2009-10-28 17:58:15 -04:00
2010-02-19 10:04:46 -05:00
if ( ! empty ( $theme_roots [ $stylesheet_or_template ] ) )
2009-10-28 17:58:15 -04:00
$theme_root = WP_CONTENT_DIR . $theme_roots [ $stylesheet_or_template ];
2009-10-15 16:45:32 -04:00
else
$theme_root = WP_CONTENT_DIR . '/themes' ;
} else {
2009-10-13 15:06:35 -04:00
$theme_root = WP_CONTENT_DIR . '/themes' ;
2009-10-15 16:45:32 -04:00
}
2009-12-08 16:29:12 -05:00
2009-10-13 15:06:35 -04:00
return apply_filters ( 'theme_root' , $theme_root );
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve URI for themes directory .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* Does not have trailing slash .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
2009-10-13 15:06:35 -04:00
* @ param $stylesheet_or_template The stylesheet or template name of the theme
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return string Themes URI .
2008-09-01 01:44:16 -04:00
*/
2009-10-13 15:06:35 -04:00
function get_theme_root_uri ( $stylesheet_or_template = false ) {
$theme_roots = get_theme_roots ();
2009-10-15 16:26:21 -04:00
2010-04-01 03:43:04 -04:00
if ( isset ( $theme_roots [ $stylesheet_or_template ] ) && $theme_roots [ $stylesheet_or_template ] )
2009-10-13 15:06:35 -04:00
$theme_root_uri = content_url ( $theme_roots [ $stylesheet_or_template ] );
else
$theme_root_uri = content_url ( 'themes' );
return apply_filters ( 'theme_root_uri' , $theme_root_uri , get_option ( 'siteurl' ), $stylesheet_or_template );
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve path to file without the use of extension .
*
* Used to quickly retrieve the path of file without including the file
* extension . It will also check the parent template , if the file exists , with
* the use of { @ link locate_template ()} . Allows for more generic file location
* without the use of the other get_ * _template () functions .
*
* Can be used with include () or require () to retrieve path .
* < code >
* if ( '' != get_query_template ( '404' ) )
* include ( get_query_template ( '404' ) );
* </ code >
* or the same can be accomplished with
* < code >
* if ( '' != get_404_template () )
* include ( get_404_template () );
* </ code >
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2008-09-24 01:24:33 -04:00
* @ param string $type Filename without extension .
* @ return string Full path to file .
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_query_template ( $type ) {
2008-03-10 20:43:07 -04:00
$type = preg_replace ( '|[^a-z0-9-]+|' , '' , $type );
2008-08-12 16:18:05 -04:00
return apply_filters ( " { $type } _template " , locate_template ( array ( " { $type } .php " )));
2006-04-18 00:44:33 -04:00
}
2010-03-26 09:52:43 -04:00
/**
* Retrieve path of index template in current or parent template .
*
* @ since 3.0 . 0
*
* @ return string
*/
function get_index_template () {
return get_query_template ( 'index' );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve path of 404 template in current or parent template .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_404_template () {
return get_query_template ( '404' );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve path of archive template in current or parent template .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_archive_template () {
return get_query_template ( 'archive' );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve path of author template in current or parent template .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_author_template () {
2010-01-31 16:32:39 -05:00
$author_id = absint ( get_query_var ( 'author' ) );
2010-02-07 16:07:35 -05:00
$author = get_user_by ( 'id' , $author_id );
$author = $author -> user_nicename ;
2010-01-31 16:32:39 -05:00
$templates = array ();
if ( $author )
$templates [] = " author- { $author } .php " ;
if ( $author_id )
$templates [] = " author- { $author_id } .php " ;
$templates [] = 'author.php' ;
$template = locate_template ( $templates );
return apply_filters ( 'author_template' , $template );
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve path of category template in current or parent template .
2008-09-01 01:44:16 -04:00
*
2009-08-14 12:56:51 -04:00
* Works by first retrieving the current slug for example 'category-default.php' and then
* trying category ID , for example 'category-1.php' and will finally fallback to category . php
* template , if those files don ' t exist .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
2008-09-24 01:24:33 -04:00
* @ uses apply_filters () Calls 'category_template' on file path of category template .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_category_template () {
2009-08-14 12:56:51 -04:00
$cat_ID = absint ( get_query_var ( 'cat' ) );
$category = get_category ( $cat_ID );
$templates = array ();
2009-09-14 10:03:32 -04:00
2009-08-14 12:56:51 -04:00
if ( ! is_wp_error ( $category ) )
$templates [] = " category- { $category -> slug } .php " ;
$templates [] = " category- $cat_ID .php " ;
2009-09-14 10:03:32 -04:00
$templates [] = " category.php " ;
2009-08-14 12:56:51 -04:00
$template = locate_template ( $templates );
2006-04-18 00:44:33 -04:00
return apply_filters ( 'category_template' , $template );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve path of tag template in current or parent template .
2008-09-01 01:44:16 -04:00
*
2009-10-08 13:27:51 -04:00
* Works by first retrieving the current tag name , for example 'tag-wordpress.php' and then
* trying tag ID , for example 'tag-1.php' and will finally fallback to tag . php
* template , if those files don ' t exist .
2009-10-15 16:26:21 -04:00
*
2008-09-01 01:44:16 -04:00
* @ since 2.3 . 0
2008-09-24 01:24:33 -04:00
* @ uses apply_filters () Calls 'tag_template' on file path of tag template .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2007-03-31 02:16:12 -04:00
function get_tag_template () {
2009-10-08 13:27:51 -04:00
$tag_id = absint ( get_query_var ( 'tag_id' ) );
$tag_name = get_query_var ( 'tag' );
$templates = array ();
if ( $tag_name )
$templates [] = " tag- $tag_name .php " ;
if ( $tag_id )
$templates [] = " tag- $tag_id .php " ;
$templates [] = " tag.php " ;
2009-10-15 16:26:21 -04:00
2009-10-08 13:27:51 -04:00
$template = locate_template ( $templates );
2007-03-31 02:16:12 -04:00
return apply_filters ( 'tag_template' , $template );
}
2008-09-25 10:12:58 -04:00
/**
* Retrieve path of taxonomy template in current or parent template .
*
* Retrieves the taxonomy and term , if term is available . The template is
* prepended with 'taxonomy-' and followed by both the taxonomy string and
* the taxonomy string followed by a dash and then followed by the term .
*
* The taxonomy and term template is checked and used first , if it exists .
* Second , just the taxonomy template is checked , and then finally , taxonomy . php
* template is used . If none of the files exist , then it will fall back on to
* index . php .
*
* @ since unknown ( 2.6 . 0 most likely )
* @ uses apply_filters () Calls 'taxonomy_template' filter on found path .
*
* @ return string
*/
2008-03-23 13:02:11 -04:00
function get_taxonomy_template () {
$taxonomy = get_query_var ( 'taxonomy' );
$term = get_query_var ( 'term' );
2008-08-12 16:18:05 -04:00
$templates = array ();
if ( $taxonomy && $term )
$templates [] = " taxonomy- $taxonomy - $term .php " ;
if ( $taxonomy )
$templates [] = " taxonomy- $taxonomy .php " ;
2008-09-24 01:24:33 -04:00
2008-08-12 16:18:05 -04:00
$templates [] = " taxonomy.php " ;
$template = locate_template ( $templates );
2008-03-23 13:02:11 -04:00
return apply_filters ( 'taxonomy_template' , $template );
}
2007-03-31 02:16:12 -04:00
2008-09-24 01:24:33 -04:00
/**
* Retrieve path of date template in current or parent template .
*
* @ since 1.5 . 0
*
* @ return string
*/
2006-04-18 00:44:33 -04:00
function get_date_template () {
return get_query_template ( 'date' );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve path of home template in current or parent template .
2010-05-03 16:26:11 -04:00
*
2010-04-28 03:48:09 -04:00
* This is the template used for the page containing the blog posts
2010-05-03 16:26:11 -04:00
*
2008-09-24 01:24:33 -04:00
* Attempts to locate 'home.php' first before falling back to 'index.php' .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
2008-09-24 01:24:33 -04:00
* @ uses apply_filters () Calls 'home_template' on file path of home template .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_home_template () {
2008-09-24 01:24:33 -04:00
$template = locate_template ( array ( 'home.php' , 'index.php' ));
2006-04-18 00:44:33 -04:00
return apply_filters ( 'home_template' , $template );
}
2010-04-28 03:48:09 -04:00
/**
* Retrieve path of front - page template in current or parent template .
*
* Looks for 'front-page.php' .
*
* @ since 3.0 . 0
* @ uses apply_filters () Calls 'front_page_template' on file path of template .
*
* @ return string
*/
function get_front_page_template () {
return apply_filters ( 'front_page_template' , locate_template ( array ( 'front-page.php' ) ) );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve path of page template in current or parent template .
2008-09-01 01:44:16 -04:00
*
2009-11-01 05:18:34 -05:00
* Will first look for the specifically assigned page template
* The will search for 'page-{slug}.php' followed by 'page-id.php'
* and finally 'page.php'
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_page_template () {
global $wp_query ;
2010-02-08 17:05:05 -05:00
$id = ( int ) $wp_query -> get_queried_object_id ();
2006-04-18 00:44:33 -04:00
$template = get_post_meta ( $id , '_wp_page_template' , true );
2009-11-01 05:18:34 -05:00
$pagename = get_query_var ( 'pagename' );
2006-04-18 00:44:33 -04:00
2010-04-18 07:50:48 -04:00
if ( ! $pagename && $id > 0 ) {
// If a static page is set as the front page, $pagename will not be set. Retrieve it from the queried object
$post = $wp_query -> get_queried_object ();
$pagename = $post -> post_name ;
}
2006-04-18 00:44:33 -04:00
if ( 'default' == $template )
$template = '' ;
2008-08-12 16:18:05 -04:00
$templates = array ();
if ( ! empty ( $template ) && ! validate_file ( $template ) )
$templates [] = $template ;
2009-11-01 05:18:34 -05:00
if ( $pagename )
$templates [] = " page- $pagename .php " ;
if ( $id )
$templates [] = " page- $id .php " ;
2008-08-12 16:18:05 -04:00
$templates [] = " page.php " ;
2006-04-18 00:44:33 -04:00
2008-08-12 16:18:05 -04:00
return apply_filters ( 'page_template' , locate_template ( $templates ));
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve path of paged template in current or parent template .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_paged_template () {
return get_query_template ( 'paged' );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve path of search template in current or parent template .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_search_template () {
return get_query_template ( 'search' );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve path of single template in current or parent template .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2008-09-25 10:12:58 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_single_template () {
2010-02-08 17:05:05 -05:00
global $wp_query ;
$object = $wp_query -> get_queried_object ();
$templates = array ( 'single-' . $object -> post_type . '.php' , 'single.php' );
return apply_filters ( 'single_template' , locate_template ( $templates ));
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve path of attachment template in current or parent template .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* The attachment path first checks if the first part of the mime type exists .
* The second check is for the second part of the mime type . The last check is
* for both types separated by an underscore . If neither are found then the file
* 'attachment.php' is checked and returned .
*
* Some examples for the 'text/plain' mime type are 'text.php' , 'plain.php' , and
* finally 'text_plain.php' .
2008-09-01 01:44:16 -04:00
*
* @ since 2.0 . 0
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_attachment_template () {
global $posts ;
$type = explode ( '/' , $posts [ 0 ] -> post_mime_type );
if ( $template = get_query_template ( $type [ 0 ]) )
return $template ;
elseif ( $template = get_query_template ( $type [ 1 ]) )
return $template ;
elseif ( $template = get_query_template ( " $type[0] _ $type[1] " ) )
return $template ;
else
return get_query_template ( 'attachment' );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve path of comment popup template in current or parent template .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* Checks for comment popup template in current template , if it exists or in the
2010-05-03 05:57:24 -04:00
* parent template .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
2008-09-24 01:24:33 -04:00
* @ uses apply_filters () Calls 'comments_popup_template' filter on path .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_comments_popup_template () {
2008-08-12 16:18:05 -04:00
$template = locate_template ( array ( " comments-popup.php " ));
2010-05-03 05:57:24 -04:00
// Backward compat code will be removed in a future release
2008-08-12 16:18:05 -04:00
if ( '' == $template )
2010-05-03 05:57:24 -04:00
$template = WPINC . '/theme-compat/comments-popup.php' ;
2006-04-18 00:44:33 -04:00
return apply_filters ( 'comments_popup_template' , $template );
}
2008-08-12 16:18:05 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve the name of the highest priority template file that exists .
2008-12-09 13:03:31 -05:00
*
2008-08-12 16:18:05 -04:00
* Searches in the STYLESHEETPATH before TEMPLATEPATH so that themes which
* inherit from a parent theme can just overload one file .
*
2008-09-24 01:24:33 -04:00
* @ since 2.7 . 0
*
* @ param array $template_names Array of template files to search for in priority order .
2008-08-12 16:18:05 -04:00
* @ param bool $load If true the template file will be loaded if it is found .
2010-04-11 13:26:03 -04:00
* @ param bool $require_once Whether to require_once or require . Default true . Has no effect if $load is false .
2008-08-12 16:18:05 -04:00
* @ return string The template filename if one is located .
*/
2010-04-11 13:26:03 -04:00
function locate_template ( $template_names , $load = false , $require_once = true ) {
2010-02-08 17:05:05 -05:00
if ( ! is_array ( $template_names ) )
2008-08-12 16:18:05 -04:00
return '' ;
2008-09-24 01:24:33 -04:00
2008-08-12 16:18:05 -04:00
$located = '' ;
2010-02-08 17:05:05 -05:00
foreach ( $template_names as $template_name ) {
2010-04-28 03:48:09 -04:00
if ( ! $template_name )
continue ;
2008-08-12 16:18:05 -04:00
if ( file_exists ( STYLESHEETPATH . '/' . $template_name )) {
$located = STYLESHEETPATH . '/' . $template_name ;
break ;
} else if ( file_exists ( TEMPLATEPATH . '/' . $template_name ) ) {
$located = TEMPLATEPATH . '/' . $template_name ;
break ;
}
}
2008-09-24 01:24:33 -04:00
2010-02-08 17:05:05 -05:00
if ( $load && '' != $located )
2010-04-11 13:26:03 -04:00
load_template ( $located , $require_once );
2008-09-24 01:24:33 -04:00
2008-08-12 16:18:05 -04:00
return $located ;
}
2008-09-01 01:44:16 -04:00
/**
2010-04-11 13:26:03 -04:00
* Require the template file with WordPress environment .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* The globals are set up for the template file to ensure that the WordPress
* environment is available from within the function . The query variables are
* also available .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2008-09-24 01:24:33 -04:00
* @ param string $_template_file Path to template file .
2010-04-11 13:26:03 -04:00
* @ param bool $require_once Whether to require_once or require . Default true .
2008-09-01 01:44:16 -04:00
*/
2010-04-11 13:26:03 -04:00
function load_template ( $_template_file , $require_once = true ) {
2007-12-06 14:49:33 -05:00
global $posts , $post , $wp_did_header , $wp_did_template_redirect , $wp_query , $wp_rewrite , $wpdb , $wp_version , $wp , $id , $comment , $user_ID ;
2006-04-18 00:44:33 -04:00
2010-04-11 13:26:03 -04:00
if ( is_array ( $wp_query -> query_vars ) )
extract ( $wp_query -> query_vars , EXTR_SKIP );
2006-04-18 00:44:33 -04:00
2010-04-11 13:26:03 -04:00
if ( $require_once )
require_once ( $_template_file );
else
require ( $_template_file );
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Display localized stylesheet link element .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
*/
2006-09-18 19:40:19 -04:00
function locale_stylesheet () {
$stylesheet = get_locale_stylesheet_uri ();
if ( empty ( $stylesheet ) )
return ;
echo '<link rel="stylesheet" href="' . $stylesheet . '" type="text/css" media="screen" />' ;
}
2008-09-01 01:44:16 -04:00
/**
2008-09-25 10:12:58 -04:00
* Start preview theme output buffer .
2008-09-01 01:44:16 -04:00
*
2008-09-25 10:12:58 -04:00
* Will only preform task if the user has permissions and template and preview
* query variables exist .
2008-09-01 01:44:16 -04:00
*
2009-09-22 03:16:19 -04:00
* @ since 2.6 . 0
2008-09-01 01:44:16 -04:00
*/
2008-05-20 13:19:33 -04:00
function preview_theme () {
if ( ! ( isset ( $_GET [ 'template' ]) && isset ( $_GET [ 'preview' ])) )
return ;
if ( ! current_user_can ( 'switch_themes' ) )
return ;
2009-03-19 20:30:32 -04:00
$_GET [ 'template' ] = preg_replace ( '|[^a-z0-9_./-]|i' , '' , $_GET [ 'template' ]);
2008-07-29 13:03:00 -04:00
2008-08-12 17:13:25 -04:00
if ( validate_file ( $_GET [ 'template' ]) )
2008-07-29 13:03:00 -04:00
return ;
2008-05-20 13:19:33 -04:00
2009-09-21 17:43:41 -04:00
add_filter ( 'template' , '_preview_theme_template_filter' );
2008-05-20 13:19:33 -04:00
if ( isset ( $_GET [ 'stylesheet' ]) ) {
2009-03-19 20:30:32 -04:00
$_GET [ 'stylesheet' ] = preg_replace ( '|[^a-z0-9_./-]|i' , '' , $_GET [ 'stylesheet' ]);
2008-08-12 17:13:25 -04:00
if ( validate_file ( $_GET [ 'stylesheet' ]) )
2008-07-29 13:03:00 -04:00
return ;
2009-09-21 17:43:41 -04:00
add_filter ( 'stylesheet' , '_preview_theme_stylesheet_filter' );
2008-05-20 13:19:33 -04:00
}
2009-05-24 19:47:49 -04:00
// Prevent theme mods to current theme being used on theme being previewed
2009-04-22 18:32:35 -04:00
add_filter ( 'pre_option_mods_' . get_current_theme (), create_function ( '' , " return array(); " ) );
2008-05-20 13:19:33 -04:00
ob_start ( 'preview_theme_ob_filter' );
}
add_action ( 'setup_theme' , 'preview_theme' );
2009-09-21 17:43:41 -04:00
/**
* Private function to modify the current template when previewing a theme
2009-09-22 03:16:19 -04:00
*
* @ since 2.9 . 0
* @ access private
2009-09-24 13:19:13 -04:00
*
2009-09-21 17:43:41 -04:00
* @ return string
*/
function _preview_theme_template_filter () {
return isset ( $_GET [ 'template' ]) ? $_GET [ 'template' ] : '' ;
}
/**
* Private function to modify the current stylesheet when previewing a theme
2009-09-24 13:19:13 -04:00
*
2009-09-22 03:16:19 -04:00
* @ since 2.9 . 0
* @ access private
2009-09-24 13:19:13 -04:00
*
2009-09-21 17:43:41 -04:00
* @ return string
*/
function _preview_theme_stylesheet_filter () {
return isset ( $_GET [ 'stylesheet' ]) ? $_GET [ 'stylesheet' ] : '' ;
}
2008-09-25 10:12:58 -04:00
/**
* Callback function for ob_start () to capture all links in the theme .
*
2009-09-22 03:16:19 -04:00
* @ since 2.6 . 0
2008-09-25 10:12:58 -04:00
* @ access private
*
* @ param string $content
* @ return string
*/
2008-05-20 13:19:33 -04:00
function preview_theme_ob_filter ( $content ) {
return preg_replace_callback ( " |(<a.*?href=([ \" ']))(.*?)([ \" '].*?>)| " , 'preview_theme_ob_filter_callback' , $content );
}
2008-09-25 10:12:58 -04:00
/**
* Manipulates preview theme links in order to control and maintain location .
*
* Callback function for preg_replace_callback () to accept and filter matches .
*
2009-09-22 03:16:19 -04:00
* @ since 2.6 . 0
2008-09-25 10:12:58 -04:00
* @ access private
*
* @ param array $matches
* @ return string
*/
2008-05-20 13:19:33 -04:00
function preview_theme_ob_filter_callback ( $matches ) {
2008-11-14 21:20:26 -05:00
if ( strpos ( $matches [ 4 ], 'onclick' ) !== false )
$matches [ 4 ] = preg_replace ( '#onclick=([\'"]).*?(?<!\\\)\\1#i' , '' , $matches [ 4 ]); //Strip out any onclicks from rest of <a>. (?<!\\\) means to ignore the '" if its escaped by \ to prevent breaking mid-attribute.
2008-05-20 13:19:33 -04:00
if (
( false !== strpos ( $matches [ 3 ], '/wp-admin/' ) )
||
2010-01-04 12:23:29 -05:00
( false !== strpos ( $matches [ 3 ], '://' ) && 0 !== strpos ( $matches [ 3 ], home_url () ) )
2008-05-20 13:19:33 -04:00
||
( false !== strpos ( $matches [ 3 ], '/feed/' ) )
||
( false !== strpos ( $matches [ 3 ], '/trackback/' ) )
)
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' ] ), $matches [ 3 ] );
if ( 0 === strpos ( $link , 'preview=1' ) )
$link = " ? $link " ;
2009-05-05 15:43:53 -04:00
return $matches [ 1 ] . esc_attr ( $link ) . $matches [ 4 ];
2008-05-20 13:19:33 -04:00
}
2008-09-25 10:12:58 -04:00
/**
* Switches current theme to new template and stylesheet names .
*
* @ since unknown
* @ uses do_action () Calls 'switch_theme' action on updated theme display name .
*
* @ param string $template Template name
* @ param string $stylesheet Stylesheet name .
*/
2007-11-13 00:07:44 -05:00
function switch_theme ( $template , $stylesheet ) {
update_option ( 'template' , $template );
update_option ( 'stylesheet' , $stylesheet );
delete_option ( 'current_theme' );
$theme = get_current_theme ();
do_action ( 'switch_theme' , $theme );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Checks that current theme files 'index.php' and 'style.css' exists .
2008-09-01 01:44:16 -04:00
*
2010-05-06 15:53:40 -04:00
* Does not check the default theme , which is the fallback and should always exist .
2010-04-21 13:14:25 -04:00
* Will switch theme to the fallback theme if current theme does not validate .
2008-10-06 11:29:47 -04:00
* You can use the 'validate_current_theme' filter to return FALSE to
* disable this functionality .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
2010-05-06 15:53:40 -04:00
* @ see WP_DEFAULT_THEME
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return bool
2008-09-01 01:44:16 -04:00
*/
2006-07-11 18:44:56 -04:00
function validate_current_theme () {
2006-07-21 15:00:04 -04:00
// Don't validate during an install/upgrade.
2008-10-06 11:29:47 -04:00
if ( defined ( 'WP_INSTALLING' ) || ! apply_filters ( 'validate_current_theme' , true ) )
2006-07-21 15:00:04 -04:00
return true ;
2010-05-06 15:53:40 -04:00
if ( get_template () != WP_DEFAULT_THEME && ! file_exists ( get_template_directory () . '/index.php' ) ) {
switch_theme ( WP_DEFAULT_THEME , WP_DEFAULT_THEME );
2006-07-11 18:44:56 -04:00
return false ;
}
2010-05-06 15:53:40 -04:00
if ( get_stylesheet () != WP_DEFAULT_THEME && ! file_exists ( get_template_directory () . '/style.css' ) ) {
switch_theme ( WP_DEFAULT_THEME , WP_DEFAULT_THEME );
2006-07-11 18:44:56 -04:00
return false ;
}
return true ;
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve theme modification value for the current theme .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* 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
* string the template directory URI and the second string the stylesheet
* directory URI .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
2008-09-24 01:24:33 -04:00
* @ uses apply_filters () Calls 'theme_mod_$name' filter on the value .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ param string $name Theme modification name .
* @ param bool | string $default
* @ return string
2008-09-01 01:44:16 -04:00
*/
2006-10-16 02:06:18 -04:00
function get_theme_mod ( $name , $default = false ) {
$theme = get_current_theme ();
2010-03-11 16:49:56 -05:00
$mods = get_option ( " mods_ $theme " );
2006-10-16 02:06:18 -04:00
if ( isset ( $mods [ $name ]) )
2007-03-11 20:07:54 -04:00
return apply_filters ( " theme_mod_ $name " , $mods [ $name ] );
2006-10-16 02:06:18 -04:00
2007-12-19 12:47:06 -05:00
return apply_filters ( " theme_mod_ $name " , sprintf ( $default , get_template_directory_uri (), get_stylesheet_directory_uri ()) );
2006-10-16 02:06:18 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Update theme modification value for the current theme .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
*
2008-09-24 01:24:33 -04:00
* @ param string $name Theme modification name .
* @ param string $value theme modification value .
2008-09-01 01:44:16 -04:00
*/
2006-10-16 02:06:18 -04:00
function set_theme_mod ( $name , $value ) {
$theme = get_current_theme ();
$mods = get_option ( " mods_ $theme " );
$mods [ $name ] = $value ;
update_option ( " mods_ $theme " , $mods );
wp_cache_delete ( " mods_ $theme " , 'options' );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Remove theme modification name from current theme list .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* If removing the name also removes all elements , then the entire option will
* be removed .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
*
2008-09-24 01:24:33 -04:00
* @ param string $name Theme modification name .
* @ return null
2008-09-01 01:44:16 -04:00
*/
2007-01-03 18:49:34 -05:00
function remove_theme_mod ( $name ) {
$theme = get_current_theme ();
$mods = get_option ( " mods_ $theme " );
if ( ! isset ( $mods [ $name ]) )
return ;
unset ( $mods [ $name ]);
if ( empty ( $mods ) )
return remove_theme_mods ();
update_option ( " mods_ $theme " , $mods );
wp_cache_delete ( " mods_ $theme " , 'options' );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Remove theme modifications option for current theme .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
*/
2006-10-16 02:06:18 -04:00
function remove_theme_mods () {
$theme = get_current_theme ();
delete_option ( " mods_ $theme " );
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve text color for custom header .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
2008-09-24 01:24:33 -04:00
* @ uses HEADER_TEXTCOLOR
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2007-01-03 18:49:34 -05:00
function get_header_textcolor () {
2010-05-13 17:44:37 -04:00
$default = defined ( 'HEADER_TEXTCOLOR' ) ? HEADER_TEXTCOLOR : '' ;
return get_theme_mod ( 'header_textcolor' , $default );
2007-01-03 18:49:34 -05:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Display text color for custom header .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
*/
2007-01-03 18:49:34 -05:00
function header_textcolor () {
2007-02-27 10:24:54 -05:00
echo get_header_textcolor ();
2007-01-03 18:49:34 -05:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Retrieve header image for custom header .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
2008-09-24 01:24:33 -04:00
* @ uses HEADER_IMAGE
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return string
2008-09-01 01:44:16 -04:00
*/
2007-01-03 18:49:34 -05:00
function get_header_image () {
2010-05-13 17:44:37 -04:00
$default = defined ( 'HEADER_IMAGE' ) ? HEADER_IMAGE : '' ;
return get_theme_mod ( 'header_image' , $default );
2007-01-03 18:49:34 -05:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Display header image path .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
*/
2007-01-03 18:49:34 -05:00
function header_image () {
2007-02-27 10:24:54 -05:00
echo get_header_image ();
2007-01-03 18:49:34 -05:00
}
2008-09-01 01:44:16 -04:00
/**
2008-09-24 01:24:33 -04:00
* Add callbacks for image header display .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* The parameter $header_callback callback will be required to display the
* content for the 'wp_head' action . The parameter $admin_header_callback
* callback will be added to Custom_Image_Header class and that will be added
* to the 'admin_menu' action .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
2008-09-24 01:24:33 -04:00
* @ uses Custom_Image_Header Sets up for $admin_header_callback for administration panel display .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ param callback $header_callback Call on 'wp_head' action .
2010-01-28 14:00:16 -05:00
* @ param callback $admin_header_callback Call on custom header administration screen .
* @ param callback $admin_image_div_callback Output a custom header image div on the custom header administration screen . Optional .
2008-09-01 01:44:16 -04:00
*/
2010-01-28 14:00:16 -05:00
function add_custom_image_header ( $header_callback , $admin_header_callback , $admin_image_div_callback = '' ) {
2007-01-03 18:49:34 -05:00
if ( ! empty ( $header_callback ) )
add_action ( 'wp_head' , $header_callback );
2010-02-25 17:04:59 -05:00
add_theme_support ( 'custom-header' );
2007-01-03 18:49:34 -05:00
if ( ! is_admin () )
return ;
require_once ( ABSPATH . 'wp-admin/custom-header.php' );
2010-01-28 14:00:16 -05:00
$GLOBALS [ 'custom_image_header' ] =& new Custom_Image_Header ( $admin_header_callback , $admin_image_div_callback );
2007-01-03 18:49:34 -05:00
add_action ( 'admin_menu' , array ( & $GLOBALS [ 'custom_image_header' ], 'init' ));
}
2010-02-25 14:18:44 -05:00
/**
* Register a selection of default headers to be displayed by the custom header admin UI .
*
* @ since 3.0 . 0
*
2010-04-01 23:15:18 -04:00
* @ param array $headers Array of headers keyed by a string id . The ids point to arrays containing 'url' , 'thumbnail_url' , and 'description' keys .
2010-02-25 14:18:44 -05:00
*/
function register_default_headers ( $headers ) {
global $_wp_default_headers ;
2010-04-01 23:15:18 -04:00
$_wp_default_headers = array_merge ( ( array ) $_wp_default_headers , ( array ) $headers );
}
/**
* Unregister default headers .
*
* This function must be called after register_default_headers () has already added the
* header you want to remove .
*
* @ see register_default_headers ()
* @ since 3.0 . 0
*
* @ param string | array The header string id ( key of array ) to remove , or an array thereof .
* @ return True on success , false on failure .
*/
function unregister_default_headers ( $header ) {
global $_wp_default_headers ;
if ( is_array ( $header ) ) {
array_map ( 'unregister_default_headers' , $header );
} elseif ( isset ( $_wp_default_headers [ $header ] ) ) {
unset ( $_wp_default_headers [ $header ] );
return true ;
} else {
return false ;
}
2010-02-25 14:18:44 -05:00
}
2010-02-09 15:37:12 -05:00
/**
* Retrieve background image for custom background .
*
* @ since 3.0 . 0
*
* @ return string
*/
function get_background_image () {
2010-03-03 12:10:43 -05:00
$default = defined ( 'BACKGROUND_IMAGE' ) ? BACKGROUND_IMAGE : '' ;
2010-02-09 15:37:12 -05:00
return get_theme_mod ( 'background_image' , $default );
}
/**
* Display background image path .
*
* @ since 3.0 . 0
*/
function background_image () {
echo get_background_image ();
}
2010-03-03 12:10:43 -05:00
/**
* Retrieve value for custom background color .
*
* @ since 3.0 . 0
* @ uses BACKGROUND_COLOR
*
* @ return string
*/
function get_background_color () {
$default = defined ( 'BACKGROUND_COLOR' ) ? BACKGROUND_COLOR : '' ;
return get_theme_mod ( 'background_color' , $default );
}
/**
* Display background color value .
*
* @ since 3.0 . 0
*/
function background_color () {
echo get_background_color ();
}
2010-02-09 15:37:12 -05:00
/**
* Add callbacks for background image display .
*
* The parameter $header_callback callback will be required to display the
* content for the 'wp_head' action . The parameter $admin_header_callback
* callback will be added to Custom_Background class and that will be added
* to the 'admin_menu' action .
*
* @ since 3.0 . 0
* @ uses Custom_Background Sets up for $admin_header_callback for administration panel display .
*
* @ param callback $header_callback Call on 'wp_head' action .
* @ param callback $admin_header_callback Call on custom background administration screen .
* @ param callback $admin_image_div_callback Output a custom background image div on the custom background administration screen . Optional .
*/
function add_custom_background ( $header_callback = '' , $admin_header_callback = '' , $admin_image_div_callback = '' ) {
2010-02-17 22:12:05 -05:00
if ( isset ( $GLOBALS [ 'custom_background' ]) )
return ;
2010-02-09 15:37:12 -05:00
if ( empty ( $header_callback ) )
$header_callback = '_custom_background_cb' ;
add_action ( 'wp_head' , $header_callback );
2010-02-25 17:04:59 -05:00
add_theme_support ( 'custom-background' );
2010-02-09 15:37:12 -05:00
if ( ! is_admin () )
return ;
require_once ( ABSPATH . 'wp-admin/custom-background.php' );
$GLOBALS [ 'custom_background' ] =& new Custom_Background ( $admin_header_callback , $admin_image_div_callback );
add_action ( 'admin_menu' , array ( & $GLOBALS [ 'custom_background' ], 'init' ));
}
/**
* Default custom background callback .
*
* @ since 3.0 . 0
* @ see add_custom_background ()
* @ access protected
*/
function _custom_background_cb () {
$background = get_background_image ();
2010-03-11 15:21:58 -05:00
$color = get_background_color ();
if ( ! $background && ! $color )
2010-02-09 15:37:12 -05:00
return ;
2010-03-27 22:53:04 -04:00
switch ( get_theme_mod ( 'background_repeat' , 'repeat' ) ) {
case 'no-repeat' :
$repeat = 'background-repeat: no-repeat;' ;
break ;
case 'repeat-x' :
$repeat = 'background-repeat: repeat-x;' ;
break ;
case 'repeat-y' :
$repeat = 'background-repeat: repeat-y;' ;
break ;
default :
$repeat = 'background-repeat: repeat;' ;
}
switch ( get_theme_mod ( 'background_position' , 'left' ) ) {
case 'center' :
$position = 'background-position: top center;' ;
break ;
case 'right' :
$position = 'background-position: top right;' ;
break ;
default :
$position = 'background-position: top left;' ;
}
if ( 'scroll' == get_theme_mod ( 'background_attachment' , 'fixed' ) )
2010-02-17 19:14:56 -05:00
$attachment = 'background-attachment: scroll;' ;
else
$attachment = 'background-attachment: fixed;' ;
2010-03-11 15:21:58 -05:00
if ( ! empty ( $background ) )
$image = " background-image: url(' $background '); " ;
else
$image = '' ;
if ( ! empty ( $color ) )
$color = " background-color: # $color ; " ;
else
$color = '' ;
2010-02-09 15:37:12 -05:00
?>
< style type = " text/css " >
body {
2010-03-11 15:21:58 -05:00
< ? php echo $image ; ?>
< ? php echo $color ; ?>
2010-02-17 19:14:56 -05:00
< ? php echo $repeat ; ?>
< ? php echo $position ; ?>
< ? php echo $attachment ; ?>
2010-02-09 15:37:12 -05:00
}
</ style >
< ? php
}
2010-02-26 15:12:06 -05:00
/**
2010-02-26 16:07:41 -05:00
* Add callback for custom TinyMCE editor stylesheets .
2010-02-26 15:12:06 -05:00
*
* The parameter $stylesheet is the name of the stylesheet , relative to
2010-02-26 16:07:41 -05:00
* the theme root . It also accepts an array of stylesheets .
* It is optional and defaults to 'editor-style.css' .
2010-02-26 15:12:06 -05:00
*
* @ since 3.0 . 0
*
2010-02-26 16:07:41 -05:00
* @ param mixed $stylesheet Optional . Stylesheet name or array thereof , relative to theme root .
* Defaults to 'editor-style.css'
2010-02-26 15:12:06 -05:00
*/
function add_editor_style ( $stylesheet = 'editor-style.css' ) {
add_theme_support ( 'editor-style' );
if ( ! is_admin () )
return ;
2010-02-27 02:36:35 -05:00
global $editor_styles ;
$editor_styles = ( array ) $editor_styles ;
$stylesheet = ( array ) $stylesheet ;
2010-05-03 01:49:19 -04:00
if ( is_rtl () ) {
2010-04-26 10:56:57 -04:00
$rtl_stylesheet = str_replace ( '.css' , '-rtl.css' , $stylesheet [ 0 ]);
$stylesheet [] = $rtl_stylesheet ;
}
2010-02-27 02:36:35 -05:00
$editor_styles = array_merge ( $editor_styles , $stylesheet );
2010-02-26 15:12:06 -05:00
}
2009-11-01 01:27:39 -04:00
/**
* Allows a theme to register its support of a certain feature
2010-01-15 17:11:12 -05:00
*
2010-03-31 05:06:11 -04:00
* 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 .
2009-11-01 01:27:39 -04:00
*
2010-03-26 15:23:39 -04:00
* @ since 2.9 . 0
2009-11-01 01:27:39 -04:00
* @ param string $feature the feature being added
*/
function add_theme_support ( $feature ) {
global $_wp_theme_features ;
2009-12-09 10:39:20 -05:00
if ( func_num_args () == 1 )
$_wp_theme_features [ $feature ] = true ;
else
$_wp_theme_features [ $feature ] = array_slice ( func_get_args (), 1 );
2009-11-01 01:27:39 -04:00
}
2010-03-29 12:26:54 -04:00
/**
* Allows a theme to de - register its support of a certain feature
*
2010-03-31 05:06:11 -04:00
* Should be called in the theme ' s functions . php file . Generally would
* be used for child themes to override support from the parent theme .
2010-03-29 12:26:54 -04:00
*
* @ since 3.0 . 0
2010-03-31 05:06:11 -04:00
* @ see add_theme_support ()
2010-03-29 12:26:54 -04:00
* @ param string $feature the feature being added
2010-03-31 05:06:11 -04:00
* @ return bool Whether feature was removed .
2010-03-29 12:26:54 -04:00
*/
function remove_theme_support ( $feature ) {
2010-03-31 05:06:11 -04:00
// Blacklist: for internal registrations not used directly by themes.
if ( in_array ( $feature , array ( 'custom-background' , 'custom-header' , 'editor-style' , 'widgets' ) ) )
return false ;
2010-03-29 12:26:54 -04:00
global $_wp_theme_features ;
2010-03-31 05:06:11 -04:00
if ( ! isset ( $_wp_theme_features [ $feature ] ) )
return false ;
unset ( $_wp_theme_features [ $feature ] );
return true ;
2010-03-29 12:26:54 -04:00
}
2009-11-01 01:27:39 -04:00
/**
* Checks a theme ' s support for a given feature
*
2010-03-26 15:23:39 -04:00
* @ since 2.9 . 0
2009-11-01 01:27:39 -04:00
* @ param string $feature the feature being checked
* @ return boolean
*/
function current_theme_supports ( $feature ) {
global $_wp_theme_features ;
2009-12-09 10:39:20 -05:00
if ( ! isset ( $_wp_theme_features [ $feature ] ) )
return false ;
// If no args passed then no extra checks need be performed
if ( func_num_args () <= 1 )
return true ;
$args = array_slice ( func_get_args (), 1 );
// @todo Allow pluggable arg checking
switch ( $feature ) {
2009-12-10 01:14:36 -05:00
case 'post-thumbnails' :
2009-12-09 10:39:20 -05:00
// post-thumbnails can be registered for only certain content/post types by passing
// an array of types to add_theme_support(). If no array was passed, then
// any type is accepted
if ( true === $_wp_theme_features [ $feature ] ) // Registered for all types
return true ;
$content_type = $args [ 0 ];
if ( in_array ( $content_type , $_wp_theme_features [ $feature ][ 0 ]) )
return true ;
else
return false ;
break ;
}
return true ;
2009-11-01 01:27:39 -04:00
}
2009-11-01 05:10:06 -05:00
/**
* Checks a theme ' s support for a given feature before loading the functions which implement it .
*
2010-03-26 15:23:39 -04:00
* @ since 2.9 . 0
2009-11-01 05:10:06 -05:00
* @ param string $feature the feature being checked
* @ param string $include the file containing the functions that implement the feature
*/
function require_if_theme_supports ( $feature , $include ) {
if ( current_theme_supports ( $feature ) )
require ( $include );
}
2007-01-21 15:03:02 -05:00
?>