2004-01-27 04:58:01 -05:00
< ? php
2008-09-05 15:19:01 -04:00
/**
* General template tags that can go anywhere in a template .
*
* @ package WordPress
* @ subpackage Template
*/
2004-01-27 04:58:01 -05:00
2008-09-05 15:19:01 -04:00
/**
2008-09-05 17:47:53 -04:00
* Load header template .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* Includes the header template for a theme or if a name is specified then a
* specialised header will be included . If the theme contains no header . php file
2010-02-18 17:09:06 -05:00
* then the header from the WP_FALLBACK_THEME theme will be included .
2008-09-06 02:38:26 -04:00
*
* For the parameter , if the file is called " header-special.php " then specify
* " special " .
2008-09-05 15:19:01 -04:00
*
* @ uses locate_template ()
* @ since 1.5 . 0
* @ uses do_action () Calls 'get_header' action .
2008-09-06 02:38:26 -04:00
*
* @ param string $name The name of the specialised header .
2008-09-05 15:19:01 -04:00
*/
2008-08-19 16:57:48 -04:00
function get_header ( $name = null ) {
2009-06-04 13:59:14 -04:00
do_action ( 'get_header' , $name );
2008-08-19 16:57:48 -04:00
$templates = array ();
if ( isset ( $name ) )
$templates [] = " header- { $name } .php " ;
$templates [] = " header.php " ;
if ( '' == locate_template ( $templates , true ))
2010-02-18 17:09:06 -05:00
load_template ( get_theme_root () . '/' . WP_FALLBACK_THEME . '/header.php' );
2004-12-30 05:58:06 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-05 17:47:53 -04:00
* Load footer template .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* Includes the footer template for a theme or if a name is specified then a
* specialised footer will be included . If the theme contains no footer . php file
* then the footer from the default theme will be included .
*
* For the parameter , if the file is called " footer-special.php " then specify
* " special " .
2008-09-05 15:19:01 -04:00
*
2008-09-05 17:47:53 -04:00
* @ uses locate_template ()
2008-09-05 15:19:01 -04:00
* @ since 1.5 . 0
2008-09-05 17:47:53 -04:00
* @ uses do_action () Calls 'get_footer' action .
2008-09-06 02:38:26 -04:00
*
* @ param string $name The name of the specialised footer .
2008-09-05 15:19:01 -04:00
*/
2008-08-19 16:57:48 -04:00
function get_footer ( $name = null ) {
2009-06-04 13:59:14 -04:00
do_action ( 'get_footer' , $name );
2008-08-19 16:57:48 -04:00
$templates = array ();
if ( isset ( $name ) )
$templates [] = " footer- { $name } .php " ;
$templates [] = " footer.php " ;
if ( '' == locate_template ( $templates , true ))
2010-02-18 17:09:06 -05:00
load_template ( get_theme_root () . '/' . WP_FALLBACK_THEME . '/footer.php' );
2004-12-30 05:58:06 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-05 17:47:53 -04:00
* Load sidebar template .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* Includes the sidebar template for a theme or if a name is specified then a
* specialised sidebar will be included . If the theme contains no sidebar . php
* file then the sidebar from the default theme will be included .
*
* For the parameter , if the file is called " sidebar-special.php " then specify
* " special " .
2008-09-05 15:19:01 -04:00
*
2008-09-05 17:47:53 -04:00
* @ uses locate_template ()
2008-09-05 15:19:01 -04:00
* @ since 1.5 . 0
2008-09-05 17:47:53 -04:00
* @ uses do_action () Calls 'get_sidebar' action .
2008-09-06 02:38:26 -04:00
*
* @ param string $name The name of the specialised sidebar .
2008-09-05 15:19:01 -04:00
*/
2008-01-13 23:51:29 -05:00
function get_sidebar ( $name = null ) {
2009-06-04 13:59:14 -04:00
do_action ( 'get_sidebar' , $name );
2008-08-19 16:57:48 -04:00
2008-08-12 16:18:05 -04:00
$templates = array ();
if ( isset ( $name ) )
$templates [] = " sidebar- { $name } .php " ;
2008-08-19 16:57:48 -04:00
2008-08-12 16:18:05 -04:00
$templates [] = " sidebar.php " ;
2008-08-19 16:57:48 -04:00
2008-08-12 16:18:05 -04:00
if ( '' == locate_template ( $templates , true ))
2010-02-18 17:09:06 -05:00
load_template ( get_theme_root () . '/' . WP_FALLBACK_THEME . '/sidebar.php' );
2004-12-30 05:58:06 -05:00
}
2010-02-14 04:32:23 -05:00
/**
* Load a generic template .
*
* Includes the named template for a theme or if a name is specified then a
* specialised template will be included . If the theme contains no { slug } . php file
* then no template will be included .
*
* For the parameter , if the file is called " { slug}-special.php " then specify
* " special " .
*
* @ uses locate_template ()
* @ since 3.0 . 0
* @ uses do_action () Calls 'get_generic_template_{$slug}' action .
*
* @ param string $slug The slug name for the generic template .
* @ param string $name The name of the specialised template .
*/
function get_generic_template ( $slug , $name = null ) {
do_action ( " get_generic_template_ { $slug } " , $name );
$templates = array ();
if ( isset ( $name ) )
$templates [] = " { $slug } - { $name } .php " ;
$templates [] = " { $slug } .php " ;
locate_template ( $templates , true );
}
2008-10-18 16:46:30 -04:00
/**
* Display search form .
*
* Will first attempt to locate the searchform . php file in either the child or
* the parent , then load it . If it doesn ' t exist , then the default search form
2009-01-22 16:17:52 -05:00
* will be displayed . The default search form is HTML , which will be displayed .
* There is a filter applied to the search form HTML in order to edit or replace
* it . The filter is 'get_search_form' .
*
* This function is primarily used by themes which want to hardcode the search
* form into the sidebar and also by the search widget in WordPress .
*
* There is also an action that is called whenever the function is run called ,
* 'get_search_form' . This can be useful for outputting JavaScript that the
* search relies on or various formatting that applies to the beginning of the
* search . To give a few examples of what it can be used for .
2008-10-18 16:46:30 -04:00
*
* @ since 2.7 . 0
2010-02-10 13:37:14 -05:00
* @ param boolean $echo Default to echo and not return the form .
2008-10-18 16:46:30 -04:00
*/
2010-02-10 13:37:14 -05:00
function get_search_form ( $echo = true ) {
2008-10-17 16:39:56 -04:00
do_action ( 'get_search_form' );
2009-05-22 12:04:49 -04:00
$search_form_template = locate_template ( array ( 'searchform.php' ));
if ( '' != $search_form_template ) {
require ( $search_form_template );
2008-10-17 16:39:56 -04:00
return ;
2009-05-22 12:04:49 -04:00
}
2008-10-17 16:39:56 -04:00
2010-01-04 12:23:29 -05:00
$form = '<form role="search" method="get" id="searchform" action="' . home_url () . ' / " >
2009-05-12 18:40:56 -04:00
< div >< label class = " screen-reader-text " for = " s " > ' . __(' Search for : ') . ' </ label >
2009-05-05 15:43:53 -04:00
< input type = " text " value = " ' . esc_attr(apply_filters('the_search_query', get_search_query())) . ' " name = " s " id = " s " />
< input type = " submit " id = " searchsubmit " value = " '. esc_attr__('Search') .' " />
2008-10-17 16:39:56 -04:00
</ div >
</ form > ' ;
2010-02-10 13:37:14 -05:00
if ( $echo )
echo apply_filters ( 'get_search_form' , $form );
else
return apply_filters ( 'get_search_form' , $form );
2008-10-17 16:39:56 -04:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Display the Log In / Out link .
2008-09-05 15:19:01 -04:00
*
2008-11-19 22:23:15 -05:00
* Displays a link , which allows the user to navigate to the Log In page to log in
* or log out depending on whether or not they are currently logged in .
2008-09-05 15:19:01 -04:00
*
* @ since 1.5 . 0
2008-09-06 02:38:26 -04:00
* @ uses apply_filters () Calls 'loginout' hook on HTML link content .
2009-04-27 16:00:59 -04:00
*
* @ param string $redirect Optional path to redirect to on login / logout .
2010-02-10 13:37:14 -05:00
* @ param boolean $echo Default to echo and not return the link .
2008-09-05 15:19:01 -04:00
*/
2010-02-10 13:37:14 -05:00
function wp_loginout ( $redirect = '' , $echo = true ) {
2006-02-22 14:08:55 -05:00
if ( ! is_user_logged_in () )
2009-05-18 12:00:33 -04:00
$link = '<a href="' . esc_url ( wp_login_url ( $redirect ) ) . '">' . __ ( 'Log in' ) . '</a>' ;
2005-10-17 19:41:28 -04:00
else
2009-05-18 12:00:33 -04:00
$link = '<a href="' . esc_url ( wp_logout_url ( $redirect ) ) . '">' . __ ( 'Log out' ) . '</a>' ;
2010-02-12 15:14:17 -05:00
2010-02-10 13:37:14 -05:00
if ( $echo )
echo apply_filters ( 'loginout' , $link );
else
return apply_filters ( 'loginout' , $link );
2004-07-10 19:34:47 -04:00
}
2008-09-28 17:05:37 -04:00
/**
* Returns the Log Out URL .
*
* Returns the URL that allows the user to log out of the site
*
* @ since 2.7
* @ uses wp_nonce_url () To protect against CSRF
* @ uses site_url () To generate the log in URL
2009-04-14 14:31:49 -04:00
* @ uses apply_filters () calls 'logout_url' hook on final logout url
2008-12-09 13:03:31 -05:00
*
2008-09-28 17:05:37 -04:00
* @ param string $redirect Path to redirect to on logout .
*/
function wp_logout_url ( $redirect = '' ) {
2009-04-14 14:31:49 -04:00
$args = array ( 'action' => 'logout' );
if ( ! empty ( $redirect ) ) {
2009-12-08 11:38:59 -05:00
$args [ 'redirect_to' ] = urlencode ( $redirect );
2009-04-14 14:31:49 -04:00
}
2008-12-09 13:03:31 -05:00
2009-04-14 14:31:49 -04:00
$logout_url = add_query_arg ( $args , site_url ( 'wp-login.php' , 'login' ));
$logout_url = wp_nonce_url ( $logout_url , 'log-out' );
return apply_filters ( 'logout_url' , $logout_url , $redirect );
2008-09-28 17:05:37 -04:00
}
/**
* Returns the Log In URL .
*
* Returns the URL that allows the user to log in to the site
*
* @ since 2.7
* @ uses site_url () To generate the log in URL
2009-04-14 14:31:49 -04:00
* @ uses apply_filters () calls 'login_url' hook on final login url
2008-12-09 13:03:31 -05:00
*
2008-09-28 17:05:37 -04:00
* @ param string $redirect Path to redirect to on login .
*/
function wp_login_url ( $redirect = '' ) {
2009-04-14 14:31:49 -04:00
$login_url = site_url ( 'wp-login.php' , 'login' );
if ( ! empty ( $redirect ) ) {
2009-05-14 12:11:01 -04:00
$login_url = add_query_arg ( 'redirect_to' , urlencode ( $redirect ), $login_url );
2009-04-14 14:31:49 -04:00
}
2008-12-09 13:03:31 -05:00
2009-04-14 14:31:49 -04:00
return apply_filters ( 'login_url' , $login_url , $redirect );
2008-09-28 17:05:37 -04:00
}
2010-01-11 16:48:43 -05:00
/**
* Provides a simple login form for use anywhere within WordPress . By default , it echos
* the HTML immediately . Pass array ( 'echo' => false ) to return the string instead .
*
2010-01-11 17:33:28 -05:00
* @ since 3.0 . 0
2010-01-11 16:48:43 -05:00
* @ param array $args Configuration options to modify the form output
* @ return Void , or string containing the form
*/
function wp_login_form ( $args = array () ) {
$defaults = array ( 'echo' => true ,
'redirect' => site_url ( $_SERVER [ 'REQUEST_URI' ] ), // Default redirect is back to the current page
'form_id' => 'loginform' ,
'label_username' => __ ( 'Username' ),
'label_password' => __ ( 'Password' ),
2010-01-15 17:11:12 -05:00
'label_remember' => __ ( 'Remember Me' ),
'label_log_in' => __ ( 'Log In' ),
'id_username' => 'user_login' ,
'id_password' => 'user_pass' ,
'id_remember' => 'rememberme' ,
'id_submit' => 'wp-submit' ,
'remember' => true ,
2010-01-11 16:48:43 -05:00
'value_username' => '' ,
'value_remember' => false , // Set this to true to default the "Remember me" checkbox to checked
);
$args = wp_parse_args ( $args , apply_filters ( 'login_form_defaults' , $defaults ) );
2010-01-15 17:11:12 -05:00
2010-01-11 16:48:43 -05:00
$form = '
< form name = " ' . $args['form_id'] . ' " id = " ' . $args['form_id'] . ' " action = " ' . site_url( 'wp-login.php', 'login' ) . ' " method = " post " >
' . do_action( ' login_form_top ' ) . '
< p class = " login-username " >
< label for = " ' . esc_attr( $args['id_username'] ) . ' " > ' . esc_html( $args[' label_username '] ) . ' </ label >
< input type = " text " name = " log " id = " ' . esc_attr( $args['id_username'] ) . ' " class = " input " value = " ' . esc_attr( $args['value_username'] ) . ' " size = " 20 " tabindex = " 10 " />
</ p >
< p class = " login-password " >
< label for = " ' . esc_attr( $args['id_password'] ) . ' " > ' . esc_html( $args[' label_password '] ) . ' </ label >
< input type = " password " name = " pwd " id = " ' . esc_attr( $args['id_password'] ) . ' " class = " input " value = " " size = " 20 " tabindex = " 20 " />
</ p >
' . do_action( ' login_form_middle ' ) . '
' . ( $args[' remember '] ? ' < p class = " login-remember " >< label >< input name = " rememberme " type = " checkbox " id = " ' . esc_attr( $args['id_remember'] ) . ' " value = " forever " tabindex = " 90 " ' . ( $args[' value_remember '] ? ' checked = " checked " ' : ' ' ) . ' /> ' . esc_html( $args[' label_remember '] ) . ' </ label ></ p > ' : ' ' ) . '
< p class = " login-submit " >
< input type = " submit " name = " wp-submit " id = " ' . esc_attr( $args['id_submit'] ) . ' " class = " button-primary " value = " ' . esc_attr( $args['label_log_in'] ) . ' " tabindex = " 100 " />
< input type = " hidden " name = " redirect_to " value = " ' . esc_attr( $args['redirect'] ) . ' " />
</ p >
' . do_action( ' login_form_bottom ' ) . '
</ form > ' ;
2010-01-15 17:11:12 -05:00
2010-01-11 16:48:43 -05:00
if ( $args [ 'echo' ] )
echo $form ;
else
return $form ;
}
2009-05-24 16:58:22 -04:00
/**
* Returns the Lost Password URL .
*
* Returns the URL that allows the user to retrieve the lost password
*
* @ since 2.8 . 0
* @ uses site_url () To generate the lost password URL
* @ uses apply_filters () calls 'lostpassword_url' hook on the lostpassword url
*
* @ param string $redirect Path to redirect to on login .
*/
function wp_lostpassword_url ( $redirect = '' ) {
2009-05-24 19:47:49 -04:00
$args = array ( 'action' => 'lostpassword' );
2009-05-24 16:58:22 -04:00
if ( ! empty ( $redirect ) ) {
$args [ 'redirect_to' ] = $redirect ;
}
$lostpassword_url = add_query_arg ( $args , site_url ( 'wp-login.php' , 'login' ));
return apply_filters ( 'lostpassword_url' , $lostpassword_url , $redirect );
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Display the Registration or Admin link .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* Display a link which allows the user to navigate to the registration page if
* not logged in and registration is enabled or to the dashboard if logged in .
2008-12-09 13:03:31 -05:00
*
2008-09-05 15:19:01 -04:00
* @ since 1.5 . 0
2008-09-06 02:38:26 -04:00
* @ uses apply_filters () Calls 'register' hook on register / admin link content .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* @ param string $before Text to output before the link ( defaults to < li > ) .
* @ param string $after Text to output after the link ( defaults to </ li > ) .
2010-02-10 13:37:14 -05:00
* @ param boolean $echo Default to echo and not return the link .
2008-09-05 15:19:01 -04:00
*/
2010-02-10 13:37:14 -05:00
function wp_register ( $before = '<li>' , $after = '</li>' , $echo = true ) {
2004-07-10 19:34:47 -04:00
2006-02-22 14:08:55 -05:00
if ( ! is_user_logged_in () ) {
2006-08-30 17:46:31 -04:00
if ( get_option ( 'users_can_register' ) )
2008-06-11 13:25:55 -04:00
$link = $before . '<a href="' . site_url ( 'wp-login.php?action=register' , 'login' ) . '">' . __ ( 'Register' ) . '</a>' . $after ;
2006-02-22 14:08:55 -05:00
else
$link = '' ;
} else {
2008-06-06 03:39:11 -04:00
$link = $before . '<a href="' . admin_url () . '">' . __ ( 'Site Admin' ) . '</a>' . $after ;
2006-02-22 14:08:55 -05:00
}
2010-02-12 15:14:17 -05:00
2010-02-10 13:37:14 -05:00
if ( $echo )
echo apply_filters ( 'register' , $link );
else
return apply_filters ( 'register' , $link );
2004-07-10 19:34:47 -04:00
}
2008-09-05 15:19:01 -04:00
/**
* Theme container function for the 'wp_meta' action .
*
* The 'wp_meta' action can have several purposes , depending on how you use it ,
* but one purpose might have been to allow for theme switching .
*
* @ since 1.5 . 0
2008-09-06 02:38:26 -04:00
* @ link http :// trac . wordpress . org / ticket / 1458 Explanation of 'wp_meta' action .
2008-09-05 15:19:01 -04:00
* @ uses do_action () Calls 'wp_meta' hook .
*/
2004-07-10 19:34:47 -04:00
function wp_meta () {
2005-02-01 01:20:54 -05:00
do_action ( 'wp_meta' );
2004-07-10 19:34:47 -04:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Display information about the blog .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* @ see get_bloginfo () For possible values for the parameter .
2008-09-05 15:19:01 -04:00
* @ since 0.71
*
2008-09-06 02:38:26 -04:00
* @ param string $show What to display .
2008-09-05 15:19:01 -04:00
*/
2004-01-27 04:58:01 -05:00
function bloginfo ( $show = '' ) {
2007-08-31 19:55:56 -04:00
echo get_bloginfo ( $show , 'display' );
2004-01-27 04:58:01 -05:00
}
2007-03-06 22:05:41 -05:00
/**
2008-09-06 02:38:26 -04:00
* Retrieve information about the blog .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* Some show parameter values are deprecated and will be removed in future
2009-12-30 12:05:02 -05:00
* versions . These options will trigger the _deprecated_argument () function .
* The deprecated blog info options are listed in the function contents .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* The possible values for the 'show' parameter are listed below .
* < ol >
* < li >< strong > url < strong > - Blog URI to homepage .</ li >
* < li >< strong > wpurl </ strong > - Blog URI path to WordPress .</ li >
* < li >< strong > description </ strong > - Secondary title </ li >
* </ ol >
*
* The feed URL options can be retrieved from 'rdf_url' ( RSS 0.91 ),
* 'rss_url' ( RSS 1.0 ), 'rss2_url' ( RSS 2.0 ), or 'atom_url' ( Atom feed ) . The
* comment feeds can be retrieved from the 'comments_atom_url' ( Atom comment
* feed ) or 'comments_rss2_url' ( RSS 2.0 comment feed ) .
*
2008-09-05 15:19:01 -04:00
* @ since 0.71
*
2008-09-06 02:38:26 -04:00
* @ param string $show Blog info to retrieve .
* @ param string $filter How to filter what is retrieved .
* @ return string Mostly string values , might be empty .
2007-03-06 22:05:41 -05:00
*/
2009-12-30 12:05:02 -05:00
function get_bloginfo ( $show = '' , $filter = 'raw' ) {
2004-02-05 15:55:50 -05:00
2009-12-30 12:05:02 -05:00
switch ( $show ) {
2007-03-06 22:05:41 -05:00
case 'home' : // DEPRECATED
case 'siteurl' : // DEPRECATED
2009-12-30 12:05:02 -05:00
_deprecated_argument ( __FUNCTION__ , '2.2' , sprintf ( __ ( 'The \'%1$s\' option is deprecated for the family of bloginfo() functions. Use the \'%2$s\' option instead.' ), $show , 'url' ) );
case 'url' :
2010-01-04 12:23:29 -05:00
$output = home_url ();
2005-10-17 19:41:28 -04:00
break ;
case 'wpurl' :
2006-08-30 17:46:31 -04:00
$output = get_option ( 'siteurl' );
2005-10-17 19:41:28 -04:00
break ;
case 'description' :
2006-08-30 17:46:31 -04:00
$output = get_option ( 'blogdescription' );
2005-10-17 19:41:28 -04:00
break ;
case 'rdf_url' :
$output = get_feed_link ( 'rdf' );
break ;
case 'rss_url' :
$output = get_feed_link ( 'rss' );
break ;
case 'rss2_url' :
$output = get_feed_link ( 'rss2' );
break ;
case 'atom_url' :
$output = get_feed_link ( 'atom' );
break ;
2007-02-23 03:18:30 -05:00
case 'comments_atom_url' :
$output = get_feed_link ( 'comments_atom' );
2007-05-31 18:44:21 -04:00
break ;
2005-10-17 19:41:28 -04:00
case 'comments_rss2_url' :
$output = get_feed_link ( 'comments_rss2' );
break ;
case 'pingback_url' :
2006-08-30 17:46:31 -04:00
$output = get_option ( 'siteurl' ) . '/xmlrpc.php' ;
2005-10-17 19:41:28 -04:00
break ;
case 'stylesheet_url' :
$output = get_stylesheet_uri ();
break ;
case 'stylesheet_directory' :
$output = get_stylesheet_directory_uri ();
break ;
case 'template_directory' :
case 'template_url' :
$output = get_template_directory_uri ();
break ;
case 'admin_email' :
2006-08-30 17:46:31 -04:00
$output = get_option ( 'admin_email' );
2005-10-17 19:41:28 -04:00
break ;
case 'charset' :
2006-08-30 17:46:31 -04:00
$output = get_option ( 'blog_charset' );
2005-10-17 19:41:28 -04:00
if ( '' == $output ) $output = 'UTF-8' ;
break ;
case 'html_type' :
$output = get_option ( 'html_type' );
break ;
case 'version' :
global $wp_version ;
$output = $wp_version ;
break ;
2006-09-24 15:29:32 -04:00
case 'language' :
$output = get_locale ();
$output = str_replace ( '_' , '-' , $output );
break ;
case 'text_direction' :
global $wp_locale ;
$output = $wp_locale -> text_direction ;
break ;
2005-10-17 19:41:28 -04:00
case 'name' :
default :
2006-08-30 17:46:31 -04:00
$output = get_option ( 'blogname' );
2005-10-17 19:41:28 -04:00
break ;
2004-09-30 13:56:16 -04:00
}
2007-08-31 19:55:56 -04:00
$url = true ;
if ( strpos ( $show , 'url' ) === false &&
strpos ( $show , 'directory' ) === false &&
strpos ( $show , 'home' ) === false )
$url = false ;
2007-09-03 19:19:20 -04:00
2007-08-31 19:55:56 -04:00
if ( 'display' == $filter ) {
if ( $url )
$output = apply_filters ( 'bloginfo_url' , $output , $show );
else
$output = apply_filters ( 'bloginfo' , $output , $show );
}
2004-09-30 13:56:16 -04:00
return $output ;
2004-01-27 04:58:01 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-12 00:31:41 -04:00
* Display or retrieve page title for all areas of blog .
2008-09-05 15:19:01 -04:00
*
2008-09-12 00:31:41 -04:00
* By default , the page title will display the separator before the page title ,
* so that the blog title will be before the page title . This is not good for
* title display , since the blog title shows up on most tabs and not what is
* important , which is the page that the user is looking at .
*
* There are also SEO benefits to having the blog title after or to the 'right'
* or the page title . However , it is mostly common sense to have the blog title
* to the right with most browsers supporting tabs . You can achieve this by
* using the seplocation parameter and setting the value to 'right' . This change
* was introduced around 2.5 . 0 , in case backwards compatibility of themes is
* important .
2008-09-05 15:19:01 -04:00
*
* @ since 1.0 . 0
*
2008-09-12 00:31:41 -04:00
* @ param string $sep Optional , default is '»' . How to separate the various items within the page title .
* @ param bool $display Optional , default is true . Whether to display or retrieve title .
* @ param string $seplocation Optional . Direction to display title , 'right' .
* @ return string | null String on retrieve , null when displaying .
2008-09-05 15:19:01 -04:00
*/
2008-01-02 15:45:17 -05:00
function wp_title ( $sep = '»' , $display = true , $seplocation = '' ) {
2007-03-08 23:06:23 -05:00
global $wpdb , $wp_locale , $wp_query ;
2005-10-17 19:41:28 -04:00
$cat = get_query_var ( 'cat' );
2007-05-22 23:57:20 -04:00
$tag = get_query_var ( 'tag_id' );
2005-10-17 19:41:28 -04:00
$category_name = get_query_var ( 'category_name' );
2005-11-10 19:48:31 -05:00
$author = get_query_var ( 'author' );
$author_name = get_query_var ( 'author_name' );
2007-03-08 23:06:23 -05:00
$m = get_query_var ( 'm' );
$year = get_query_var ( 'year' );
$monthnum = get_query_var ( 'monthnum' );
$day = get_query_var ( 'day' );
2009-02-27 12:46:13 -05:00
$search = get_query_var ( 's' );
2006-10-03 11:41:44 -04:00
$title = '' ;
2005-10-17 19:41:28 -04:00
2008-10-28 00:53:52 -04:00
$t_sep = '%WP_TITILE_SEP%' ; // Temporary separator, for accurate flipping, if necessary
2005-10-17 19:41:28 -04:00
// If there's a category
if ( ! empty ( $cat ) ) {
// category exclusion
if ( ! stristr ( $cat , '-' ) )
2006-08-24 19:50:24 -04:00
$title = apply_filters ( 'single_cat_title' , get_the_category_by_ID ( $cat ));
2007-03-06 20:29:07 -05:00
} elseif ( ! empty ( $category_name ) ) {
2005-10-17 19:41:28 -04:00
if ( stristr ( $category_name , '/' ) ) {
$category_name = explode ( '/' , $category_name );
if ( $category_name [ count ( $category_name ) - 1 ] )
$category_name = $category_name [ count ( $category_name ) - 1 ]; // no trailing slash
else
$category_name = $category_name [ count ( $category_name ) - 2 ]; // there was a trailling slash
}
2007-08-26 13:18:00 -04:00
$cat = get_term_by ( 'slug' , $category_name , 'category' , OBJECT , 'display' );
2007-05-27 15:32:45 -04:00
if ( $cat )
$title = apply_filters ( 'single_cat_title' , $cat -> name );
2005-10-17 19:41:28 -04:00
}
2007-05-22 23:57:20 -04:00
if ( ! empty ( $tag ) ) {
2007-08-26 13:18:00 -04:00
$tag = get_term ( $tag , 'post_tag' , OBJECT , 'display' );
2008-02-05 01:47:27 -05:00
if ( is_wp_error ( $tag ) )
2007-09-18 12:32:22 -04:00
return $tag ;
2007-05-22 23:57:20 -04:00
if ( ! empty ( $tag -> name ) )
2007-08-26 13:18:00 -04:00
$title = apply_filters ( 'single_tag_title' , $tag -> name );
2007-05-22 23:57:20 -04:00
}
2005-11-10 19:48:31 -05:00
// If there's an author
if ( ! empty ( $author ) ) {
$title = get_userdata ( $author );
$title = $title -> display_name ;
}
if ( ! empty ( $author_name ) ) {
// We do a direct query here because we don't cache by nicename.
2007-10-02 14:45:47 -04:00
$title = $wpdb -> get_var ( $wpdb -> prepare ( " SELECT display_name FROM $wpdb->users WHERE user_nicename = %s " , $author_name ));
2005-11-10 19:48:31 -05:00
}
2005-10-17 19:41:28 -04:00
// If there's a month
if ( ! empty ( $m ) ) {
$my_year = substr ( $m , 0 , 4 );
2007-03-28 22:06:16 -04:00
$my_month = $wp_locale -> get_month ( substr ( $m , 4 , 2 ));
2007-03-25 19:47:48 -04:00
$my_day = intval ( substr ( $m , 6 , 2 ));
2009-12-23 10:16:53 -05:00
$title = $my_year . ( $my_month ? $t_sep . $my_month : " " ) . ( $my_day ? $t_sep . $my_day : " " );
2005-10-17 19:41:28 -04:00
}
if ( ! empty ( $year ) ) {
$title = $year ;
if ( ! empty ( $monthnum ) )
2009-12-23 10:16:53 -05:00
$title .= $t_sep . $wp_locale -> get_month ( $monthnum );
2005-10-17 19:41:28 -04:00
if ( ! empty ( $day ) )
2009-12-23 10:16:53 -05:00
$title .= $t_sep . zeroise ( $day , 2 );
2005-10-17 19:41:28 -04:00
}
// If there is a post
2009-05-19 11:48:47 -04:00
if ( is_single () || ( is_home () && ! is_front_page () ) || ( is_page () && ! is_front_page () ) ) {
2007-03-08 23:13:42 -05:00
$post = $wp_query -> get_queried_object ();
2007-06-01 18:54:46 -04:00
$title = strip_tags ( apply_filters ( 'single_post_title' , $post -> post_title ) );
2005-10-17 19:41:28 -04:00
}
2008-05-15 23:57:09 -04:00
// If there's a taxonomy
if ( is_tax () ) {
$taxonomy = get_query_var ( 'taxonomy' );
$tax = get_taxonomy ( $taxonomy );
$tax = $tax -> label ;
$term = $wp_query -> get_queried_object ();
$term = $term -> name ;
2009-12-23 10:16:53 -05:00
$title = $tax . $t_sep . $term ;
2008-05-15 23:57:09 -04:00
}
2009-03-17 22:43:45 -04:00
2009-02-27 12:46:13 -05:00
//If it's a search
if ( is_search () ) {
2009-06-02 03:21:42 -04:00
/* translators: 1: separator, 2: search phrase */
$title = sprintf ( __ ( 'Search Results %1$s %2$s' ), $t_sep , strip_tags ( $search ));
2009-02-27 12:46:13 -05:00
}
2008-05-15 23:57:09 -04:00
2008-10-26 09:11:34 -04:00
if ( is_404 () ) {
2008-12-09 13:03:31 -05:00
$title = __ ( 'Page not found' );
2008-10-26 09:11:34 -04:00
}
2008-12-09 13:03:31 -05:00
2005-12-05 18:57:41 -05:00
$prefix = '' ;
2006-10-07 14:54:56 -04:00
if ( ! empty ( $title ) )
2005-12-05 18:57:41 -05:00
$prefix = " $sep " ;
2008-10-28 00:53:52 -04:00
// Determines position of the separator and direction of the breadcrumb
if ( 'right' == $seplocation ) { // sep on right, so reverse the order
$title_array = explode ( $t_sep , $title );
$title_array = array_reverse ( $title_array );
$title = implode ( " $sep " , $title_array ) . $prefix ;
} else {
$title_array = explode ( $t_sep , $title );
$title = $prefix . implode ( " $sep " , $title_array );
}
2008-02-05 01:47:27 -05:00
2008-07-23 12:44:06 -04:00
$title = apply_filters ( 'wp_title' , $title , $sep , $seplocation );
2005-12-05 18:57:41 -05:00
2005-10-17 19:41:28 -04:00
// Send it out
2005-12-05 18:57:41 -05:00
if ( $display )
echo $title ;
else
return $title ;
2008-01-02 15:45:17 -05:00
2004-01-27 04:58:01 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-12 00:31:41 -04:00
* Display or retrieve page title for post .
*
* This is optimized for single . php template file for displaying the post title .
* Only useful for posts , does not support pages for example .
2008-09-05 15:19:01 -04:00
*
2008-09-12 00:31:41 -04:00
* It does not support placing the separator after the title , but by leaving the
* prefix parameter empty , you can set the title separator manually . The prefix
* does not automatically place a space between the prefix , so if there should
* be a space , the parameter value will need to have it at the end .
2008-09-05 15:19:01 -04:00
*
* @ since 0.71
* @ uses $wpdb
*
2008-09-12 00:31:41 -04:00
* @ param string $prefix Optional . What to display before the title .
* @ param bool $display Optional , default is true . Whether to display or retrieve title .
* @ return string | null Title when retrieving , null when displaying or failure .
2008-09-05 15:19:01 -04:00
*/
2004-01-27 04:58:01 -05:00
function single_post_title ( $prefix = '' , $display = true ) {
2010-02-14 02:38:00 -05:00
global $wpdb , $post ;
if ( ! $post ) {
$p = get_query_var ( 'p' );
$name = get_query_var ( 'name' );
if ( intval ( $p ) || '' != $name ) {
if ( ! $p )
$p = $wpdb -> get_var ( $wpdb -> prepare ( " SELECT ID FROM $wpdb->posts WHERE post_name = %s " , $name ));
$post = & get_post ( $p );
}
2005-10-17 19:41:28 -04:00
}
2010-02-14 02:38:00 -05:00
$title = apply_filters ( 'single_post_title' , $post -> post_title , $post );
if ( $display )
echo $prefix . strip_tags ( $title );
else
return strip_tags ( $title );
2004-01-27 04:58:01 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-12 00:31:41 -04:00
* Display or retrieve page title for category archive .
2008-09-05 15:19:01 -04:00
*
2008-09-12 00:31:41 -04:00
* This is useful for category template file or files , because it is optimized
* for category page title and with less overhead than { @ link wp_title ()} .
*
* It does not support placing the separator after the title , but by leaving the
* prefix parameter empty , you can set the title separator manually . The prefix
* does not automatically place a space between the prefix , so if there should
* be a space , the parameter value will need to have it at the end .
2008-09-05 15:19:01 -04:00
*
* @ since 0.71
*
2008-09-12 00:31:41 -04:00
* @ param string $prefix Optional . What to display before the title .
* @ param bool $display Optional , default is true . Whether to display or retrieve title .
* @ return string | null Title when retrieving , null when displaying or failure .
2008-09-05 15:19:01 -04:00
*/
2004-01-27 04:58:01 -05:00
function single_cat_title ( $prefix = '' , $display = true ) {
2010-02-14 02:38:00 -05:00
global $wp_query ;
2010-02-19 05:45:29 -05:00
if ( is_tag () )
2007-09-11 14:06:52 -04:00
return single_tag_title ( $prefix , $display );
2010-02-19 05:45:29 -05:00
if ( ! is_category () )
return ;
$cat = $wp_query -> get_queried_object ();
$my_cat_name = apply_filters ( 'single_cat_title' , $cat -> name );
2010-02-14 02:38:00 -05:00
if ( ! empty ( $my_cat_name ) ) {
if ( $display )
echo $prefix . strip_tags ( $my_cat_name );
else
return strip_tags ( $my_cat_name );
2005-05-27 02:10:41 -04:00
}
2004-01-27 04:58:01 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-12 00:31:41 -04:00
* Display or retrieve page title for tag post archive .
*
* Useful for tag template files for displaying the tag page title . It has less
* overhead than { @ link wp_title ()}, because of its limited implementation .
2008-09-05 15:19:01 -04:00
*
2008-09-12 00:31:41 -04:00
* It does not support placing the separator after the title , but by leaving the
* prefix parameter empty , you can set the title separator manually . The prefix
* does not automatically place a space between the prefix , so if there should
* be a space , the parameter value will need to have it at the end .
2008-09-05 15:19:01 -04:00
*
* @ since 2.3 . 0
*
2008-09-12 00:31:41 -04:00
* @ param string $prefix Optional . What to display before the title .
* @ param bool $display Optional , default is true . Whether to display or retrieve title .
* @ return string | null Title when retrieving , null when displaying or failure .
2008-09-05 15:19:01 -04:00
*/
2007-08-21 14:39:45 -04:00
function single_tag_title ( $prefix = '' , $display = true ) {
2010-02-19 05:45:29 -05:00
global $wp_query ;
2007-09-11 14:06:52 -04:00
if ( ! is_tag () )
return ;
2010-02-19 05:45:29 -05:00
$tag = $wp_query -> get_queried_object ();;
2010-02-20 19:03:42 -05:00
2010-02-19 05:45:29 -05:00
if ( ! $tag )
return ;
2010-02-14 02:38:00 -05:00
$my_tag_name = apply_filters ( 'single_tag_title' , $tag -> name );
if ( ! empty ( $my_tag_name ) ) {
if ( $display )
echo $prefix . $my_tag_name ;
else
return $my_tag_name ;
}
2007-08-21 14:39:45 -04:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-12 00:31:41 -04:00
* Display or retrieve page title for post archive based on date .
2008-09-05 15:19:01 -04:00
*
2008-09-12 00:31:41 -04:00
* Useful for when the template only needs to display the month and year , if
* either are available . Optimized for just this purpose , so if it is all that
* is needed , should be better than { @ link wp_title ()} .
*
* It does not support placing the separator after the title , but by leaving the
* prefix parameter empty , you can set the title separator manually . The prefix
* does not automatically place a space between the prefix , so if there should
* be a space , the parameter value will need to have it at the end .
2008-09-05 15:19:01 -04:00
*
* @ since 0.71
*
2008-09-12 00:31:41 -04:00
* @ param string $prefix Optional . What to display before the title .
* @ param bool $display Optional , default is true . Whether to display or retrieve title .
* @ return string | null Title when retrieving , null when displaying or failure .
2008-09-05 15:19:01 -04:00
*/
2004-01-27 04:58:01 -05:00
function single_month_title ( $prefix = '' , $display = true ) {
2007-03-08 23:06:23 -05:00
global $wp_locale ;
$m = get_query_var ( 'm' );
$year = get_query_var ( 'year' );
$monthnum = get_query_var ( 'monthnum' );
2005-10-17 19:41:28 -04:00
if ( ! empty ( $monthnum ) && ! empty ( $year ) ) {
2004-10-18 19:45:26 -04:00
$my_year = $year ;
2006-04-01 19:20:11 -05:00
$my_month = $wp_locale -> get_month ( $monthnum );
2005-10-17 19:41:28 -04:00
} elseif ( ! empty ( $m ) ) {
2004-10-18 19:52:36 -04:00
$my_year = substr ( $m , 0 , 4 );
2006-10-04 23:12:24 -04:00
$my_month = $wp_locale -> get_month ( substr ( $m , 4 , 2 ));
2004-10-18 19:52:36 -04:00
}
2006-10-04 23:12:24 -04:00
if ( empty ( $my_month ) )
return false ;
$result = $prefix . $my_month . $prefix . $my_year ;
if ( ! $display )
return $result ;
echo $result ;
2004-01-27 04:58:01 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-12 00:31:41 -04:00
* Retrieve archive link content based on predefined or custom code .
*
* The format can be one of four styles . The 'link' for head element , 'option'
* for use in the select element , 'html' for use in list ( either ol or ul HTML
* elements ) . Custom content is also supported using the before and after
* parameters .
*
* The 'link' format uses the link HTML element with the < em > archives </ em >
* relationship . The before and after parameters are not used . The text
* parameter is used to describe the link .
*
* The 'option' format uses the option HTML element for use in select element .
* The value is the url parameter and the before and after parameters are used
* between the text description .
2008-09-05 15:19:01 -04:00
*
2008-09-12 00:31:41 -04:00
* The 'html' format , which is the default , uses the li HTML element for use in
* the list HTML elements . The before parameter is before the link and the after
* parameter is after the closing link .
*
* The custom format uses the before parameter before the link ( 'a' HTML
* element ) and the after parameter after the closing link tag . If the above
* three values for the format are not used , then custom format is assumed .
2008-09-05 15:19:01 -04:00
*
* @ since 1.0 . 0
* @ author Orien
* @ link http :// icecode . com / link navigation hack by Orien
*
2008-09-12 00:31:41 -04:00
* @ param string $url URL to archive .
* @ param string $text Archive text description .
* @ param string $format Optional , default is 'html' . Can be 'link' , 'option' , 'html' , or custom .
* @ param string $before Optional .
* @ param string $after Optional .
* @ return string HTML link content for archive .
2008-09-05 15:19:01 -04:00
*/
2004-07-06 13:04:07 -04:00
function get_archives_link ( $url , $text , $format = 'html' , $before = '' , $after = '' ) {
$text = wptexturize ( $text );
2009-05-05 15:43:53 -04:00
$title_text = esc_attr ( $text );
2009-05-18 12:00:33 -04:00
$url = esc_url ( $url );
2004-07-28 19:09:33 -04:00
2005-10-17 19:41:28 -04:00
if ( 'link' == $format )
2008-05-20 12:43:44 -04:00
$link_html = " \t <link rel='archives' title=' $title_text ' href=' $url ' /> \n " ;
2005-10-17 19:41:28 -04:00
elseif ( 'option' == $format )
2008-05-20 12:43:44 -04:00
$link_html = " \t <option value=' $url '> $before $text $after </option> \n " ;
2005-10-17 19:41:28 -04:00
elseif ( 'html' == $format )
2008-05-20 12:43:44 -04:00
$link_html = " \t <li> $before <a href=' $url ' title=' $title_text '> $text </a> $after </li> \n " ;
2005-10-17 19:41:28 -04:00
else // custom
2008-05-20 12:43:44 -04:00
$link_html = " \t $before <a href=' $url ' title=' $title_text '> $text </a> $after\n " ;
$link_html = apply_filters ( " get_archives_link " , $link_html );
2008-08-09 01:36:14 -04:00
2008-05-20 12:43:44 -04:00
return $link_html ;
2004-01-27 04:58:01 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-12 00:31:41 -04:00
* Display archive links based on type and format .
*
* The 'type' argument offers a few choices and by default will display monthly
* archive links . The other options for values are 'daily' , 'weekly' , 'monthly' ,
* 'yearly' , 'postbypost' or 'alpha' . Both 'postbypost' and 'alpha' display the
* same archive link list , the difference between the two is that 'alpha'
* will order by post title and 'postbypost' will order by post date .
*
* The date archives will logically display dates with links to the archive post
* page . The 'postbypost' and 'alpha' values for 'type' argument will display
* the post titles .
*
* The 'limit' argument will only display a limited amount of links , specified
* by the 'limit' integer value . By default , there is no limit . The
* 'show_post_count' argument will show how many posts are within the archive .
* By default , the 'show_post_count' argument is set to false .
2008-09-05 15:19:01 -04:00
*
2008-09-12 00:31:41 -04:00
* For the 'format' , 'before' , and 'after' arguments , see { @ link
* get_archives_link ()} . The values of these arguments have to do with that
* function .
2008-09-05 15:19:01 -04:00
*
* @ since 1.2 . 0
*
2008-09-12 00:31:41 -04:00
* @ param string | array $args Optional . Override defaults .
2008-09-05 15:19:01 -04:00
*/
2004-04-24 15:23:57 -04:00
function wp_get_archives ( $args = '' ) {
2007-05-11 00:01:54 -04:00
global $wpdb , $wp_locale ;
2007-06-13 22:25:30 -04:00
2007-05-10 23:10:05 -04:00
$defaults = array (
2007-09-03 19:32:58 -04:00
'type' => 'monthly' , 'limit' => '' ,
'format' => 'html' , 'before' => '' ,
2008-09-16 00:52:47 -04:00
'after' => '' , 'show_post_count' => false ,
'echo' => 1
2007-05-10 23:10:05 -04:00
);
2007-06-13 22:25:30 -04:00
2007-05-10 23:10:05 -04:00
$r = wp_parse_args ( $args , $defaults );
2007-06-14 18:45:40 -04:00
extract ( $r , EXTR_SKIP );
2005-10-17 19:41:28 -04:00
if ( '' == $type )
$type = 'monthly' ;
if ( '' != $limit ) {
2008-01-29 13:48:38 -05:00
$limit = absint ( $limit );
2005-10-17 19:41:28 -04:00
$limit = ' LIMIT ' . $limit ;
}
2006-06-15 16:28:47 -04:00
2005-10-17 19:41:28 -04:00
// this is what will separate dates on weekly archive links
$archive_week_separator = '–' ;
// over-ride general date format ? 0 = no: use the date format set in Options, 1 = yes: over-ride
$archive_date_format_over_ride = 0 ;
// options for daily archive (only if you over-ride the general date format)
$archive_day_date_format = 'Y/m/d' ;
// options for weekly archive (only if you over-ride the general date format)
$archive_week_start_date_format = 'Y/m/d' ;
$archive_week_end_date_format = 'Y/m/d' ;
if ( ! $archive_date_format_over_ride ) {
2006-08-30 17:46:31 -04:00
$archive_day_date_format = get_option ( 'date_format' );
$archive_week_start_date_format = get_option ( 'date_format' );
$archive_week_end_date_format = get_option ( 'date_format' );
2005-10-17 19:41:28 -04:00
}
2007-03-08 23:09:24 -05:00
//filters
$where = apply_filters ( 'getarchives_where' , " WHERE post_type = 'post' AND post_status = 'publish' " , $r );
$join = apply_filters ( 'getarchives_join' , " " , $r );
2008-10-24 16:47:12 -04:00
$output = '' ;
2005-10-17 19:41:28 -04:00
if ( 'monthly' == $type ) {
2009-02-19 17:53:19 -05:00
$query = " SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date) ORDER BY post_date DESC $limit " ;
2007-10-30 02:03:11 -04:00
$key = md5 ( $query );
$cache = wp_cache_get ( 'wp_get_archives' , 'general' );
if ( ! isset ( $cache [ $key ] ) ) {
$arcresults = $wpdb -> get_results ( $query );
$cache [ $key ] = $arcresults ;
wp_cache_add ( 'wp_get_archives' , $cache , 'general' );
} else {
$arcresults = $cache [ $key ];
}
2005-10-17 19:41:28 -04:00
if ( $arcresults ) {
$afterafter = $after ;
2008-08-06 16:31:54 -04:00
foreach ( ( array ) $arcresults as $arcresult ) {
2008-09-12 00:31:41 -04:00
$url = get_month_link ( $arcresult -> year , $arcresult -> month );
2009-11-17 15:54:38 -05:00
/* translators: 1: month name, 2: 4-digit year */
2006-11-29 16:34:51 -05:00
$text = sprintf ( __ ( '%1$s %2$d' ), $wp_locale -> get_month ( $arcresult -> month ), $arcresult -> year );
2007-09-03 19:32:58 -04:00
if ( $show_post_count )
2005-10-17 19:41:28 -04:00
$after = ' (' . $arcresult -> posts . ')' . $afterafter ;
2008-10-24 16:47:12 -04:00
$output .= get_archives_link ( $url , $text , $format , $before , $after );
2005-10-17 19:41:28 -04:00
}
}
2006-08-30 13:23:42 -04:00
} elseif ( 'yearly' == $type ) {
2009-02-19 17:53:19 -05:00
$query = " SELECT YEAR(post_date) AS `year`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date) ORDER BY post_date DESC $limit " ;
2007-10-30 02:03:11 -04:00
$key = md5 ( $query );
$cache = wp_cache_get ( 'wp_get_archives' , 'general' );
if ( ! isset ( $cache [ $key ] ) ) {
$arcresults = $wpdb -> get_results ( $query );
$cache [ $key ] = $arcresults ;
wp_cache_add ( 'wp_get_archives' , $cache , 'general' );
} else {
$arcresults = $cache [ $key ];
}
2006-08-30 13:23:42 -04:00
if ( $arcresults ) {
2007-02-27 10:24:54 -05:00
$afterafter = $after ;
2008-08-06 16:31:54 -04:00
foreach ( ( array ) $arcresults as $arcresult ) {
2007-02-27 10:24:54 -05:00
$url = get_year_link ( $arcresult -> year );
$text = sprintf ( '%d' , $arcresult -> year );
2006-09-07 13:38:43 -04:00
if ( $show_post_count )
2007-02-27 10:24:54 -05:00
$after = ' (' . $arcresult -> posts . ')' . $afterafter ;
2008-10-24 16:47:12 -04:00
$output .= get_archives_link ( $url , $text , $format , $before , $after );
2007-02-27 10:24:54 -05:00
}
}
2005-10-17 19:41:28 -04:00
} elseif ( 'daily' == $type ) {
2009-02-19 17:53:19 -05:00
$query = " SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, DAYOFMONTH(post_date) AS `dayofmonth`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date), DAYOFMONTH(post_date) ORDER BY post_date DESC $limit " ;
2007-10-30 02:03:11 -04:00
$key = md5 ( $query );
$cache = wp_cache_get ( 'wp_get_archives' , 'general' );
if ( ! isset ( $cache [ $key ] ) ) {
$arcresults = $wpdb -> get_results ( $query );
$cache [ $key ] = $arcresults ;
wp_cache_add ( 'wp_get_archives' , $cache , 'general' );
} else {
$arcresults = $cache [ $key ];
}
2005-10-17 19:41:28 -04:00
if ( $arcresults ) {
2006-09-07 13:38:43 -04:00
$afterafter = $after ;
2008-08-06 16:31:54 -04:00
foreach ( ( array ) $arcresults as $arcresult ) {
2005-10-17 19:41:28 -04:00
$url = get_day_link ( $arcresult -> year , $arcresult -> month , $arcresult -> dayofmonth );
2006-12-09 19:23:10 -05:00
$date = sprintf ( '%1$d-%2$02d-%3$02d 00:00:00' , $arcresult -> year , $arcresult -> month , $arcresult -> dayofmonth );
2005-10-17 19:41:28 -04:00
$text = mysql2date ( $archive_day_date_format , $date );
2006-09-07 13:38:43 -04:00
if ( $show_post_count )
$after = ' (' . $arcresult -> posts . ')' . $afterafter ;
2008-10-24 16:47:12 -04:00
$output .= get_archives_link ( $url , $text , $format , $before , $after );
2005-10-17 19:41:28 -04:00
}
}
} elseif ( 'weekly' == $type ) {
2006-08-30 17:46:31 -04:00
$start_of_week = get_option ( 'start_of_week' );
2007-10-30 02:03:11 -04:00
$query = " SELECT DISTINCT WEEK(post_date, $start_of_week ) AS `week`, YEAR(post_date) AS yr, DATE_FORMAT(post_date, '%Y-%m-%d') AS yyyymmdd, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY WEEK(post_date, $start_of_week ), YEAR(post_date) ORDER BY post_date DESC $limit " ;
$key = md5 ( $query );
$cache = wp_cache_get ( 'wp_get_archives' , 'general' );
if ( ! isset ( $cache [ $key ] ) ) {
$arcresults = $wpdb -> get_results ( $query );
$cache [ $key ] = $arcresults ;
wp_cache_add ( 'wp_get_archives' , $cache , 'general' );
} else {
$arcresults = $cache [ $key ];
}
2005-10-17 19:41:28 -04:00
$arc_w_last = '' ;
2006-09-07 13:38:43 -04:00
$afterafter = $after ;
2005-10-17 19:41:28 -04:00
if ( $arcresults ) {
2008-08-06 16:31:54 -04:00
foreach ( ( array ) $arcresults as $arcresult ) {
2005-10-17 19:41:28 -04:00
if ( $arcresult -> week != $arc_w_last ) {
$arc_year = $arcresult -> yr ;
$arc_w_last = $arcresult -> week ;
2006-08-30 17:46:31 -04:00
$arc_week = get_weekstartend ( $arcresult -> yyyymmdd , get_option ( 'start_of_week' ));
2005-10-17 19:41:28 -04:00
$arc_week_start = date_i18n ( $archive_week_start_date_format , $arc_week [ 'start' ]);
$arc_week_end = date_i18n ( $archive_week_end_date_format , $arc_week [ 'end' ]);
2010-01-04 12:23:29 -05:00
$url = sprintf ( '%1$s/%2$s%3$sm%4$s%5$s%6$sw%7$s%8$d' , home_url (), '' , '?' , '=' , $arc_year , '&' , '=' , $arcresult -> week );
2005-10-17 19:41:28 -04:00
$text = $arc_week_start . $archive_week_separator . $arc_week_end ;
2006-09-07 13:38:43 -04:00
if ( $show_post_count )
$after = ' (' . $arcresult -> posts . ')' . $afterafter ;
2008-10-24 16:47:12 -04:00
$output .= get_archives_link ( $url , $text , $format , $before , $after );
2005-10-17 19:41:28 -04:00
}
}
}
2006-02-18 21:07:13 -05:00
} elseif ( ( 'postbypost' == $type ) || ( 'alpha' == $type ) ) {
2008-10-24 16:47:12 -04:00
$orderby = ( 'alpha' == $type ) ? " post_title ASC " : " post_date DESC " ;
2007-10-30 02:03:11 -04:00
$query = " SELECT * FROM $wpdb->posts $join $where ORDER BY $orderby $limit " ;
$key = md5 ( $query );
$cache = wp_cache_get ( 'wp_get_archives' , 'general' );
if ( ! isset ( $cache [ $key ] ) ) {
$arcresults = $wpdb -> get_results ( $query );
$cache [ $key ] = $arcresults ;
wp_cache_add ( 'wp_get_archives' , $cache , 'general' );
} else {
$arcresults = $cache [ $key ];
}
2005-10-17 19:41:28 -04:00
if ( $arcresults ) {
2008-08-06 16:31:54 -04:00
foreach ( ( array ) $arcresults as $arcresult ) {
2005-10-17 19:41:28 -04:00
if ( $arcresult -> post_date != '0000-00-00 00:00:00' ) {
$url = get_permalink ( $arcresult );
$arc_title = $arcresult -> post_title ;
if ( $arc_title )
2007-03-30 19:46:17 -04:00
$text = strip_tags ( apply_filters ( 'the_title' , $arc_title ));
2005-10-17 19:41:28 -04:00
else
$text = $arcresult -> ID ;
2008-10-24 16:47:12 -04:00
$output .= get_archives_link ( $url , $text , $format , $before , $after );
2005-10-17 19:41:28 -04:00
}
}
}
}
2008-10-24 16:47:12 -04:00
if ( $echo )
echo $output ;
else
2008-12-09 13:03:31 -05:00
return $output ;
2004-01-27 04:58:01 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-12 00:31:41 -04:00
* Get number of days since the start of the week .
2008-09-05 15:19:01 -04:00
*
* @ since 1.5 . 0
* @ usedby get_calendar ()
*
2008-09-06 02:38:26 -04:00
* @ param int $num Number of day .
2008-09-12 00:31:41 -04:00
* @ return int Days since the start of the week .
2008-09-05 15:19:01 -04:00
*/
2004-09-09 19:07:46 -04:00
function calendar_week_mod ( $num ) {
$base = 7 ;
return ( $num - $base * floor ( $num / $base ));
}
2008-09-05 15:19:01 -04:00
/**
2008-09-12 00:31:41 -04:00
* Display calendar with days that have posts as links .
2008-09-05 15:19:01 -04:00
*
2008-09-12 00:31:41 -04:00
* The calendar is cached , which will be retrieved , if it exists . If there are
* no posts for the month , then it will not be displayed .
2008-09-05 15:19:01 -04:00
*
* @ since 1.0 . 0
*
2008-09-12 00:31:41 -04:00
* @ param bool $initial Optional , default is true . Use initial calendar names .
2010-02-10 13:37:14 -05:00
* @ param bool $echo Optional , default is true . Set to false for return .
2008-09-05 15:19:01 -04:00
*/
2010-02-10 13:37:14 -05:00
function get_calendar ( $initial = true , $echo = true ) {
2007-12-06 14:49:33 -05:00
global $wpdb , $m , $monthnum , $year , $wp_locale , $posts ;
2005-10-17 19:41:28 -04:00
2008-12-19 02:05:00 -05:00
$cache = array ();
2006-11-23 12:56:53 -05:00
$key = md5 ( $m . $monthnum . $year );
if ( $cache = wp_cache_get ( 'get_calendar' , 'calendar' ) ) {
2010-02-12 15:14:17 -05:00
if ( is_array ( $cache ) && isset ( $cache [ $key ] ) ) {
2010-02-10 13:37:14 -05:00
if ( $echo )
echo apply_filters ( 'get_calendar' , $cache [ $key ] );
else
2010-02-12 15:14:17 -05:00
return apply_filters ( 'get_calendar' , $cache [ $key ] );
2006-11-23 12:56:53 -05:00
}
}
2008-12-19 02:05:00 -05:00
if ( ! is_array ( $cache ) )
$cache = array ();
2005-10-17 19:41:28 -04:00
// Quick check. If we have no posts at all, abort!
if ( ! $posts ) {
2009-06-10 20:04:20 -04:00
$gotsome = $wpdb -> get_var ( " SELECT 1 as test FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish' LIMIT 1 " );
2009-03-04 17:28:45 -05:00
if ( ! $gotsome ) {
$cache [ $key ] = '' ;
wp_cache_set ( 'get_calendar' , $cache , 'calendar' );
2005-10-17 19:41:28 -04:00
return ;
2009-03-04 17:28:45 -05:00
}
2005-10-17 19:41:28 -04:00
}
if ( isset ( $_GET [ 'w' ]) )
$w = '' . intval ( $_GET [ 'w' ]);
// week_begins = 0 stands for Sunday
2006-08-30 17:46:31 -04:00
$week_begins = intval ( get_option ( 'start_of_week' ));
2005-10-17 19:41:28 -04:00
// Let's figure out when we are
if ( ! empty ( $monthnum ) && ! empty ( $year ) ) {
$thismonth = '' . zeroise ( intval ( $monthnum ), 2 );
$thisyear = '' . intval ( $year );
} elseif ( ! empty ( $w ) ) {
// We need to get the month from MySQL
$thisyear = '' . intval ( substr ( $m , 0 , 4 ));
$d = (( $w - 1 ) * 7 ) + 6 ; //it seems MySQL's weeks disagree with PHP's
$thismonth = $wpdb -> get_var ( " SELECT DATE_FORMAT((DATE_ADD(' ${ thisyear } 0101', INTERVAL $d DAY) ), '%m') " );
} elseif ( ! empty ( $m ) ) {
$thisyear = '' . intval ( substr ( $m , 0 , 4 ));
if ( strlen ( $m ) < 6 )
$thismonth = '01' ;
else
$thismonth = '' . zeroise ( intval ( substr ( $m , 4 , 2 )), 2 );
} else {
2006-10-06 07:22:42 -04:00
$thisyear = gmdate ( 'Y' , current_time ( 'timestamp' ));
$thismonth = gmdate ( 'm' , current_time ( 'timestamp' ));
2005-10-17 19:41:28 -04:00
}
$unixmonth = mktime ( 0 , 0 , 0 , $thismonth , 1 , $thisyear );
// Get the next and previous month and year with at least one post
2009-02-25 12:09:29 -05:00
$previous = $wpdb -> get_row ( " SELECT DISTINCT MONTH(post_date) AS month, YEAR(post_date) AS year
2005-10-17 19:41:28 -04:00
FROM $wpdb -> posts
WHERE post_date < '$thisyear-$thismonth-01'
2006-02-09 05:03:48 -05:00
AND post_type = 'post' AND post_status = 'publish'
2005-10-17 19:41:28 -04:00
ORDER BY post_date DESC
LIMIT 1 " );
2009-02-25 12:09:29 -05:00
$next = $wpdb -> get_row ( " SELECT DISTINCT MONTH(post_date) AS month, YEAR(post_date) AS year
2005-10-17 19:41:28 -04:00
FROM $wpdb -> posts
2009-02-25 12:09:29 -05:00
WHERE post_date > '$thisyear-$thismonth-01'
AND MONTH ( post_date ) != MONTH ( '$thisyear-$thismonth-01' )
2006-11-24 17:55:28 -05:00
AND post_type = 'post' AND post_status = 'publish'
2005-10-17 19:41:28 -04:00
ORDER BY post_date ASC
LIMIT 1 " );
2009-03-12 23:53:39 -04:00
/* translators: Calendar caption: 1: month name, 2: 4-digit year */
$calendar_caption = _x ( '%1$s %2$s' , 'calendar caption' );
2010-02-12 15:14:17 -05:00
$calendar_output = '<table id="wp-calendar" summary="' . esc_attr__ ( 'Calendar' ) . ' " >
2009-03-12 23:53:39 -04:00
< caption > ' . sprintf($calendar_caption, $wp_locale->get_month($thismonth), date(' Y ', $unixmonth)) . ' </ caption >
2005-10-17 19:41:28 -04:00
< thead >
< tr > ' ;
$myweek = array ();
for ( $wdcount = 0 ; $wdcount <= 6 ; $wdcount ++ ) {
2006-04-01 19:20:11 -05:00
$myweek [] = $wp_locale -> get_weekday (( $wdcount + $week_begins ) % 7 );
2005-10-17 19:41:28 -04:00
}
foreach ( $myweek as $wd ) {
2006-04-01 19:20:11 -05:00
$day_name = ( true == $initial ) ? $wp_locale -> get_weekday_initial ( $wd ) : $wp_locale -> get_weekday_abbrev ( $wd );
2009-08-18 12:05:07 -04:00
$wd = esc_attr ( $wd );
2010-02-10 13:37:14 -05:00
$calendar_output .= " \n \t \t <th scope= \" col \" title= \" $wd\ " > $day_name </ th > " ;
2005-10-17 19:41:28 -04:00
}
2010-02-12 15:14:17 -05:00
2010-02-10 13:37:14 -05:00
$calendar_output .= '
2005-10-17 19:41:28 -04:00
</ tr >
</ thead >
< tfoot >
< tr > ' ;
if ( $previous ) {
2010-02-10 13:37:14 -05:00
$calendar_output .= " \n \t \t " . '<td colspan="3" id="prev"><a href="' . get_month_link ( $previous -> year , $previous -> month ) . '" title="' . sprintf ( __ ( 'View posts for %1$s %2$s' ), $wp_locale -> get_month ( $previous -> month ), date ( 'Y' , mktime ( 0 , 0 , 0 , $previous -> month , 1 , $previous -> year ))) . '">« ' . $wp_locale -> get_month_abbrev ( $wp_locale -> get_month ( $previous -> month )) . '</a></td>' ;
2005-10-17 19:41:28 -04:00
} else {
2010-02-10 13:37:14 -05:00
$calendar_output .= " \n \t \t " . '<td colspan="3" id="prev" class="pad"> </td>' ;
2005-10-17 19:41:28 -04:00
}
2010-02-10 13:37:14 -05:00
$calendar_output .= " \n \t \t " . '<td class="pad"> </td>' ;
2005-10-17 19:41:28 -04:00
if ( $next ) {
2010-02-10 13:37:14 -05:00
$calendar_output .= " \n \t \t " . '<td colspan="3" id="next"><a href="' . get_month_link ( $next -> year , $next -> month ) . '" title="' . esc_attr ( sprintf ( __ ( 'View posts for %1$s %2$s' ), $wp_locale -> get_month ( $next -> month ), date ( 'Y' , mktime ( 0 , 0 , 0 , $next -> month , 1 , $next -> year ))) ) . '">' . $wp_locale -> get_month_abbrev ( $wp_locale -> get_month ( $next -> month )) . ' »</a></td>' ;
2005-10-17 19:41:28 -04:00
} else {
2010-02-10 13:37:14 -05:00
$calendar_output .= " \n \t \t " . '<td colspan="3" id="next" class="pad"> </td>' ;
2005-10-17 19:41:28 -04:00
}
2010-02-10 13:37:14 -05:00
$calendar_output .= '
2005-10-17 19:41:28 -04:00
</ tr >
</ tfoot >
< tbody >
< tr > ' ;
// Get days with posts
$dayswithposts = $wpdb -> get_results ( " SELECT DISTINCT DAYOFMONTH(post_date)
2009-02-25 12:09:29 -05:00
FROM $wpdb -> posts WHERE MONTH ( post_date ) = '$thismonth'
AND YEAR ( post_date ) = '$thisyear'
2006-02-09 05:03:48 -05:00
AND post_type = 'post' AND post_status = 'publish'
2005-10-17 19:41:28 -04:00
AND post_date < '" . current_time(' mysql ') . ' \ '' , ARRAY_N );
if ( $dayswithposts ) {
2008-08-06 16:31:54 -04:00
foreach ( ( array ) $dayswithposts as $daywith ) {
2005-10-17 19:41:28 -04:00
$daywithpost [] = $daywith [ 0 ];
}
} else {
$daywithpost = array ();
}
2010-02-13 21:27:19 -05:00
if ( strpos ( $_SERVER [ 'HTTP_USER_AGENT' ], 'MSIE' ) !== false || stripos ( $_SERVER [ 'HTTP_USER_AGENT' ], 'camino' ) !== false || stripos ( $_SERVER [ 'HTTP_USER_AGENT' ], 'safari' ) !== false )
2005-10-17 19:41:28 -04:00
$ak_title_separator = " \n " ;
else
$ak_title_separator = ', ' ;
$ak_titles_for_day = array ();
$ak_post_titles = $wpdb -> get_results ( " SELECT post_title, DAYOFMONTH(post_date) as dom "
. " FROM $wpdb->posts "
2009-02-25 12:09:29 -05:00
. " WHERE YEAR(post_date) = ' $thisyear ' "
. " AND MONTH(post_date) = ' $thismonth ' "
2005-10-17 19:41:28 -04:00
. " AND post_date < ' " . current_time ( 'mysql' ) . " ' "
2006-02-09 05:03:48 -05:00
. " AND post_type = 'post' AND post_status = 'publish' "
2005-10-17 19:41:28 -04:00
);
if ( $ak_post_titles ) {
2008-08-06 16:31:54 -04:00
foreach ( ( array ) $ak_post_titles as $ak_post_title ) {
2007-06-13 22:25:30 -04:00
2009-05-06 00:56:32 -04:00
$post_title = esc_attr ( apply_filters ( 'the_title' , $ak_post_title -> post_title ) );
2007-06-13 22:25:30 -04:00
2005-10-17 19:41:28 -04:00
if ( empty ( $ak_titles_for_day [ 'day_' . $ak_post_title -> dom ]) )
$ak_titles_for_day [ 'day_' . $ak_post_title -> dom ] = '' ;
if ( empty ( $ak_titles_for_day [ " $ak_post_title->dom " ]) ) // first one
2007-03-09 22:56:35 -05:00
$ak_titles_for_day [ " $ak_post_title->dom " ] = $post_title ;
2005-10-17 19:41:28 -04:00
else
2007-03-09 22:56:35 -05:00
$ak_titles_for_day [ " $ak_post_title->dom " ] .= $ak_title_separator . $post_title ;
2005-10-17 19:41:28 -04:00
}
}
// See how much we should pad in the beginning
$pad = calendar_week_mod ( date ( 'w' , $unixmonth ) - $week_begins );
if ( 0 != $pad )
2010-02-10 13:37:14 -05:00
$calendar_output .= " \n \t \t " . '<td colspan="' . esc_attr ( $pad ) . '" class="pad"> </td>' ;
2005-10-17 19:41:28 -04:00
$daysinmonth = intval ( date ( 't' , $unixmonth ));
for ( $day = 1 ; $day <= $daysinmonth ; ++ $day ) {
if ( isset ( $newrow ) && $newrow )
2010-02-10 13:37:14 -05:00
$calendar_output .= " \n \t </tr> \n \t <tr> \n \t \t " ;
2005-10-17 19:41:28 -04:00
$newrow = false ;
2009-12-30 12:56:09 -05:00
if ( $day == gmdate ( 'j' , current_time ( 'timestamp' )) && $thismonth == gmdate ( 'm' , current_time ( 'timestamp' )) && $thisyear == gmdate ( 'Y' , current_time ( 'timestamp' )) )
2010-02-10 13:37:14 -05:00
$calendar_output .= '<td id="today">' ;
2005-10-17 19:41:28 -04:00
else
2010-02-10 13:37:14 -05:00
$calendar_output .= '<td>' ;
2005-10-17 19:41:28 -04:00
if ( in_array ( $day , $daywithpost ) ) // any posts today?
2010-02-10 13:37:14 -05:00
$calendar_output .= '<a href="' . get_day_link ( $thisyear , $thismonth , $day ) . " \" title= \" " . esc_attr ( $ak_titles_for_day [ $day ]) . " \" > $day </a> " ;
2005-10-17 19:41:28 -04:00
else
2010-02-10 13:37:14 -05:00
$calendar_output .= $day ;
$calendar_output .= '</td>' ;
2005-10-17 19:41:28 -04:00
if ( 6 == calendar_week_mod ( date ( 'w' , mktime ( 0 , 0 , 0 , $thismonth , $day , $thisyear )) - $week_begins ) )
$newrow = true ;
}
$pad = 7 - calendar_week_mod ( date ( 'w' , mktime ( 0 , 0 , 0 , $thismonth , $day , $thisyear )) - $week_begins );
if ( $pad != 0 && $pad != 7 )
2010-02-10 13:37:14 -05:00
$calendar_output .= " \n \t \t " . '<td class="pad" colspan="' . esc_attr ( $pad ) . '"> </td>' ;
2005-10-17 19:41:28 -04:00
2010-02-10 13:37:14 -05:00
$calendar_output .= " \n \t </tr> \n \t </tbody> \n \t </table> " ;
2006-11-23 12:56:53 -05:00
2010-02-12 15:14:17 -05:00
$cache [ $key ] = $calendar_output ;
2007-09-15 17:50:53 -04:00
wp_cache_set ( 'get_calendar' , $cache , 'calendar' );
2010-02-10 13:37:14 -05:00
if ( $echo )
echo apply_filters ( 'get_calendar' , $calendar_output );
else
return apply_filters ( 'get_calendar' , $calendar_output );
2006-11-23 12:56:53 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-05 17:47:53 -04:00
* Purge the cached results of get_calendar .
2008-12-09 13:03:31 -05:00
*
2008-09-05 17:47:53 -04:00
* @ see get_calendar
2008-09-05 15:19:01 -04:00
* @ since 2.1 . 0
*/
2006-11-23 12:56:53 -05:00
function delete_get_calendar_cache () {
wp_cache_delete ( 'get_calendar' , 'calendar' );
2004-01-27 04:58:01 -05:00
}
2006-11-23 12:56:53 -05:00
add_action ( 'save_post' , 'delete_get_calendar_cache' );
add_action ( 'delete_post' , 'delete_get_calendar_cache' );
add_action ( 'update_option_start_of_week' , 'delete_get_calendar_cache' );
add_action ( 'update_option_gmt_offset' , 'delete_get_calendar_cache' );
2004-01-27 04:58:01 -05:00
2008-09-05 15:19:01 -04:00
/**
2008-09-12 00:31:41 -04:00
* Display all of the allowed tags in HTML format with attributes .
2008-09-05 15:19:01 -04:00
*
2008-09-12 00:31:41 -04:00
* This is useful for displaying in the comment area , which elements and
* attributes are supported . As well as any plugins which want to display it .
2008-09-05 15:19:01 -04:00
*
* @ since 1.0 . 1
* @ uses $allowedtags
*
2008-09-12 00:31:41 -04:00
* @ return string HTML allowed tags entity encoded .
2008-09-05 15:19:01 -04:00
*/
2004-01-27 04:58:01 -05:00
function allowed_tags () {
2005-10-17 19:41:28 -04:00
global $allowedtags ;
2004-05-07 19:56:33 -04:00
$allowed = '' ;
2008-08-06 16:31:54 -04:00
foreach ( ( array ) $allowedtags as $tag => $attributes ) {
2005-10-17 19:41:28 -04:00
$allowed .= '<' . $tag ;
if ( 0 < count ( $attributes ) ) {
foreach ( $attributes as $attribute => $limits ) {
$allowed .= ' ' . $attribute . '=""' ;
}
}
$allowed .= '> ' ;
}
return htmlentities ( $allowed );
2004-01-27 04:58:01 -05:00
}
/***** Date/Time tags *****/
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Outputs the date in iso8601 format for xml files .
2008-09-05 15:19:01 -04:00
*
* @ since 1.0 . 0
*/
2004-01-27 04:58:01 -05:00
function the_date_xml () {
2005-10-17 19:41:28 -04:00
global $post ;
2009-05-13 22:00:32 -04:00
echo mysql2date ( 'Y-m-d' , $post -> post_date , false );
2004-01-27 04:58:01 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2010-02-01 11:28:54 -05:00
* Display or Retrieve the date the current $post was written ( once per date )
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* Will only output the date if the current post ' s date is different from the
* previous one output .
2010-02-01 11:28:54 -05:00
* i . e . Only one date listing will show per day worth of posts shown in the loop , even if the
* function is called several times for each post .
2008-09-05 15:19:01 -04:00
*
2010-02-01 11:28:54 -05:00
* HTML output can be filtered with 'the_date' .
* Date string output can be filtered with 'get_the_date' .
2008-09-05 15:19:01 -04:00
*
2010-02-01 11:28:54 -05:00
* @ since 0.71
* @ uses get_the_date ()
2008-09-06 02:38:26 -04:00
* @ param string $d Optional . PHP date format defaults to the date_format option if not specified .
* @ param string $before Optional . Output before the date .
* @ param string $after Optional . Output after the date .
* @ param bool $echo Optional , default is display . Whether to echo the date or return it .
* @ return string | null Null if displaying , string if retrieving .
2008-09-05 15:19:01 -04:00
*/
2010-02-01 11:28:54 -05:00
function the_date ( $d = '' , $before = '' , $after = '' , $echo = true ) {
global $day , $previousday ;
2005-10-17 19:41:28 -04:00
$the_date = '' ;
if ( $day != $previousday ) {
$the_date .= $before ;
2010-02-01 11:28:54 -05:00
$the_date .= get_the_date ( $d );
2005-10-17 19:41:28 -04:00
$the_date .= $after ;
$previousday = $day ;
2008-12-14 07:13:30 -05:00
2010-02-01 11:28:54 -05:00
$the_date = apply_filters ( 'the_date' , $the_date , $d , $before , $after );
if ( $echo )
echo $the_date ;
else
return $the_date ;
2008-12-14 07:13:30 -05:00
}
2010-02-01 11:28:54 -05:00
return null ;
}
/**
* Retrieve the date the current $post was written .
*
* Unlike the_date () this function will always return the date .
* Modify output with 'get_the_date' filter .
*
* @ since 3.0 . 0
*
* @ param string $d Optional . PHP date format defaults to the date_format option if not specified .
* @ return string | null Null if displaying , string if retrieving .
*/
function get_the_date ( $d = '' ) {
2010-02-19 21:01:46 -05:00
global $post ;
2010-02-01 11:28:54 -05:00
$the_date = '' ;
if ( '' == $d )
$the_date .= mysql2date ( get_option ( 'date_format' ), $post -> post_date );
else
$the_date .= mysql2date ( $d , $post -> post_date );
return apply_filters ( 'get_the_date' , $the_date , $d );
2004-01-27 04:58:01 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Display the date on which the post was last modified .
2008-09-05 15:19:01 -04:00
*
* @ since 2.1 . 0
*
2009-12-23 10:22:08 -05:00
* @ param string $d Optional . PHP date format defaults to the date_format option if not specified .
* @ param string $before Optional . Output before the date .
* @ param string $after Optional . Output after the date .
* @ param bool $echo Optional , default is display . Whether to echo the date or return it .
* @ return string | null Null if displaying , string if retrieving .
2008-09-05 15:19:01 -04:00
*/
2009-12-23 10:22:08 -05:00
function the_modified_date ( $d = '' , $before = '' , $after = '' , $echo = true ) {
2010-01-15 17:11:12 -05:00
2009-12-23 10:22:08 -05:00
$the_modified_date = $before . get_the_modified_date ( $d ) . $after ;
$the_modified_date = apply_filters ( 'the_modified_date' , $the_modified_date , $d , $before , $after );
2010-01-15 17:11:12 -05:00
2009-12-23 10:22:08 -05:00
if ( $echo )
echo $the_modified_date ;
else
return $the_modified_date ;
2010-01-15 17:11:12 -05:00
2006-08-30 12:46:08 -04:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Retrieve the date on which the post was last modified .
2008-09-05 15:19:01 -04:00
*
* @ since 2.1 . 0
*
2008-09-06 02:38:26 -04:00
* @ param string $d Optional . PHP date format . Defaults to the " date_format " option
2008-09-05 17:47:53 -04:00
* @ return string
2008-09-05 15:19:01 -04:00
*/
2006-08-30 12:46:08 -04:00
function get_the_modified_date ( $d = '' ) {
if ( '' == $d )
2009-05-13 22:00:32 -04:00
$the_time = get_post_modified_time ( get_option ( 'date_format' ), null , null , true );
2006-08-30 12:46:08 -04:00
else
2009-05-13 22:00:32 -04:00
$the_time = get_post_modified_time ( $d , null , null , true );
2006-08-30 12:46:08 -04:00
return apply_filters ( 'get_the_modified_date' , $the_time , $d );
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Display the time at which the post was written .
2008-09-05 15:19:01 -04:00
*
* @ since 0.71
*
2008-09-05 17:47:53 -04:00
* @ param string $d Either 'G' , 'U' , or php date format .
2008-09-05 15:19:01 -04:00
*/
2005-01-07 17:01:59 -05:00
function the_time ( $d = '' ) {
2005-02-05 22:40:08 -05:00
echo apply_filters ( 'the_time' , get_the_time ( $d ), $d );
2005-01-07 17:01:59 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Retrieve the time at which the post was written .
2008-09-05 15:19:01 -04:00
*
* @ since 1.5 . 0
*
2010-01-10 10:50:17 -05:00
* @ param string $d Optional Either 'G' , 'U' , or php date format defaults to the value specified in the time_format option .
2008-11-02 16:05:38 -05:00
* @ param int | object $post Optional post ID or object . Default is global $post object .
2008-09-05 17:47:53 -04:00
* @ return string
2008-09-05 15:19:01 -04:00
*/
2008-11-02 16:05:38 -05:00
function get_the_time ( $d = '' , $post = null ) {
$post = get_post ( $post );
2005-01-07 17:01:59 -05:00
if ( '' == $d )
2009-05-13 22:00:32 -04:00
$the_time = get_post_time ( get_option ( 'time_format' ), false , $post , true );
2005-01-07 17:01:59 -05:00
else
2009-05-13 22:00:32 -04:00
$the_time = get_post_time ( $d , false , $post , true );
2008-11-02 16:05:38 -05:00
return apply_filters ( 'get_the_time' , $the_time , $d , $post );
2005-01-07 17:01:59 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Retrieve the time at which the post was written .
2008-09-05 15:19:01 -04:00
*
2008-09-05 17:47:53 -04:00
* @ since 2.0 . 0
2008-09-05 15:19:01 -04:00
*
2010-01-10 10:50:17 -05:00
* @ param string $d Optional Either 'G' , 'U' , or php date format .
* @ param bool $gmt Optional , default is false . Whether of not to return the gmt time .
2008-11-02 16:05:38 -05:00
* @ param int | object $post Optional post ID or object . Default is global $post object .
2009-05-13 22:00:32 -04:00
* @ param bool $translate Whether to translate the time string or not
2008-09-05 17:47:53 -04:00
* @ return string
2008-09-05 15:19:01 -04:00
*/
2009-05-13 22:00:32 -04:00
function get_post_time ( $d = 'U' , $gmt = false , $post = null , $translate = false ) { // returns timestamp
2008-11-02 16:05:38 -05:00
$post = get_post ( $post );
2005-01-07 17:01:59 -05:00
if ( $gmt )
2005-01-18 21:21:36 -05:00
$time = $post -> post_date_gmt ;
2005-01-07 17:01:59 -05:00
else
2005-01-18 21:21:36 -05:00
$time = $post -> post_date ;
2009-05-13 22:00:32 -04:00
$time = mysql2date ( $d , $time , $translate );
2008-04-08 13:33:42 -04:00
return apply_filters ( 'get_post_time' , $time , $d , $gmt );
2004-01-27 04:58:01 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Display the time at which the post was last modified .
2008-09-05 15:19:01 -04:00
*
* @ since 2.0 . 0
*
2010-01-10 10:50:17 -05:00
* @ param string $d Optional Either 'G' , 'U' , or php date format defaults to the value specified in the time_format option .
2008-09-05 15:19:01 -04:00
*/
2005-11-10 18:31:30 -05:00
function the_modified_time ( $d = '' ) {
echo apply_filters ( 'the_modified_time' , get_the_modified_time ( $d ), $d );
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Retrieve the time at which the post was last modified .
2008-09-05 15:19:01 -04:00
*
* @ since 2.0 . 0
*
2010-01-10 10:50:17 -05:00
* @ param string $d Optional Either 'G' , 'U' , or php date format defaults to the value specified in the time_format option .
2008-09-05 17:47:53 -04:00
* @ return string
2008-09-05 15:19:01 -04:00
*/
2005-11-10 18:31:30 -05:00
function get_the_modified_time ( $d = '' ) {
if ( '' == $d )
2009-05-13 22:00:32 -04:00
$the_time = get_post_modified_time ( get_option ( 'time_format' ), null , null , true );
2005-11-10 18:31:30 -05:00
else
2009-05-13 22:00:32 -04:00
$the_time = get_post_modified_time ( $d , null , null , true );
2005-11-10 18:31:30 -05:00
return apply_filters ( 'get_the_modified_time' , $the_time , $d );
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Retrieve the time at which the post was last modified .
2008-09-05 15:19:01 -04:00
*
* @ since 2.0 . 0
*
2010-01-10 10:50:17 -05:00
* @ param string $d Optional , default is 'U' . Either 'G' , 'U' , or php date format .
* @ param bool $gmt Optional , default is false . Whether of not to return the gmt time .
* @ param int | object $post Optional , default is global post object . A post_id or post object
* @ param bool $translate Optional , default is false . Whether to translate the result or not
2008-09-06 02:38:26 -04:00
* @ return string Returns timestamp
2008-09-05 15:19:01 -04:00
*/
2009-05-13 22:00:32 -04:00
function get_post_modified_time ( $d = 'U' , $gmt = false , $post = null , $translate = false ) {
$post = get_post ( $post );
2005-11-10 18:31:30 -05:00
if ( $gmt )
$time = $post -> post_modified_gmt ;
else
$time = $post -> post_modified ;
2009-05-13 22:00:32 -04:00
$time = mysql2date ( $d , $time , $translate );
2005-11-10 18:31:30 -05:00
2009-05-15 18:33:33 -04:00
return apply_filters ( 'get_post_modified_time' , $time , $d , $gmt );
2005-11-10 18:31:30 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Display the weekday on which the post was written .
2008-09-05 15:19:01 -04:00
*
* @ since 0.71
* @ uses $wp_locale
* @ uses $post
*/
2004-01-27 04:58:01 -05:00
function the_weekday () {
2007-12-06 14:49:33 -05:00
global $wp_locale , $post ;
2009-05-13 22:00:32 -04:00
$the_weekday = $wp_locale -> get_weekday ( mysql2date ( 'w' , $post -> post_date , false ));
2005-10-17 19:41:28 -04:00
$the_weekday = apply_filters ( 'the_weekday' , $the_weekday );
echo $the_weekday ;
2004-01-27 04:58:01 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Display the weekday on which the post was written .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* Will only output the weekday if the current post ' s weekday is different from
* the previous one output .
2008-09-05 15:19:01 -04:00
*
* @ since 0.71
*
2010-01-10 10:50:17 -05:00
* @ param string $before Optional Output before the date .
* @ param string $after Optional Output after the date .
2008-09-05 17:47:53 -04:00
*/
2004-01-27 04:58:01 -05:00
function the_weekday_date ( $before = '' , $after = '' ) {
2007-12-06 14:49:33 -05:00
global $wp_locale , $post , $day , $previousweekday ;
2005-10-17 19:41:28 -04:00
$the_weekday_date = '' ;
if ( $day != $previousweekday ) {
$the_weekday_date .= $before ;
2009-05-13 22:00:32 -04:00
$the_weekday_date .= $wp_locale -> get_weekday ( mysql2date ( 'w' , $post -> post_date , false ));
2005-10-17 19:41:28 -04:00
$the_weekday_date .= $after ;
$previousweekday = $day ;
}
$the_weekday_date = apply_filters ( 'the_weekday_date' , $the_weekday_date , $before , $after );
echo $the_weekday_date ;
2004-01-27 04:58:01 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-05 17:47:53 -04:00
* Fire the wp_head action
2008-09-05 15:19:01 -04:00
*
* @ since 1.2 . 0
2008-09-06 02:38:26 -04:00
* @ uses do_action () Calls 'wp_head' hook .
2008-09-05 15:19:01 -04:00
*/
2006-06-07 19:17:59 -04:00
function wp_head () {
do_action ( 'wp_head' );
}
2008-09-05 15:19:01 -04:00
/**
2008-09-05 17:47:53 -04:00
* Fire the wp_footer action
2008-09-05 15:19:01 -04:00
*
* @ since 1.5 . 1
2008-09-06 02:38:26 -04:00
* @ uses do_action () Calls 'wp_footer' hook .
2008-09-05 15:19:01 -04:00
*/
2006-06-07 19:17:59 -04:00
function wp_footer () {
do_action ( 'wp_footer' );
}
2009-01-19 00:04:58 -05:00
/**
* Enable / disable automatic general feed link outputting .
*
* @ since 2.8 . 0
*
2010-01-10 10:50:17 -05:00
* @ param boolean $add Optional , default is true . Add or remove links . Defaults to true .
2009-01-19 00:04:58 -05:00
*/
function automatic_feed_links ( $add = true ) {
if ( $add )
add_action ( 'wp_head' , 'feed_links' , 2 );
else {
remove_action ( 'wp_head' , 'feed_links' , 2 );
remove_action ( 'wp_head' , 'feed_links_extra' , 3 );
}
}
/**
* Display the links to the general feeds .
*
* @ since 2.8 . 0
*
* @ param array $args Optional arguments .
*/
2010-01-10 10:50:17 -05:00
function feed_links ( $args = array () ) {
2009-01-19 00:04:58 -05:00
$defaults = array (
2009-03-12 23:53:39 -04:00
/* translators: Separator between blog name and feed type in feed links */
2009-06-02 03:21:42 -04:00
'separator' => _x ( '»' , 'feed link' ),
/* translators: 1: blog title, 2: separator (raquo) */
'feedtitle' => __ ( '%1$s %2$s Feed' ),
/* translators: %s: blog title, 2: separator (raquo) */
'comstitle' => __ ( '%1$s %2$s Comments Feed' ),
2009-01-19 00:04:58 -05:00
);
$args = wp_parse_args ( $args , $defaults );
2009-06-02 03:21:42 -04:00
echo '<link rel="alternate" type="' . feed_content_type () . '" title="' . esc_attr ( sprintf ( $args [ 'feedtitle' ], get_bloginfo ( 'name' ), $args [ 'separator' ] )) . '" href="' . get_feed_link () . " \" /> \n " ;
echo '<link rel="alternate" type="' . feed_content_type () . '" title="' . esc_attr ( sprintf ( $args [ 'comstitle' ], get_bloginfo ( 'name' ), $args [ 'separator' ] )) . '" href="' . get_feed_link ( 'comments_' . get_default_feed () ) . " \" /> \n " ;
2009-01-19 00:04:58 -05:00
}
/**
* Display the links to the extra feeds such as category feeds .
*
* @ since 2.8 . 0
*
* @ param array $args Optional arguments .
*/
2010-01-10 10:50:17 -05:00
function feed_links_extra ( $args = array () ) {
2009-01-19 00:04:58 -05:00
$defaults = array (
2009-03-12 23:53:39 -04:00
/* translators: Separator between blog name and feed type in feed links */
'separator' => _x ( '»' , 'feed link' ),
/* translators: 1: blog name, 2: separator(raquo), 3: post title */
2009-01-19 00:04:58 -05:00
'singletitle' => __ ( '%1$s %2$s %3$s Comments Feed' ),
2009-03-12 23:53:39 -04:00
/* translators: 1: blog name, 2: separator(raquo), 3: category name */
2009-01-19 00:04:58 -05:00
'cattitle' => __ ( '%1$s %2$s %3$s Category Feed' ),
2009-03-12 23:53:39 -04:00
/* translators: 1: blog name, 2: separator(raquo), 3: tag name */
2009-01-19 00:04:58 -05:00
'tagtitle' => __ ( '%1$s %2$s %3$s Tag Feed' ),
2009-03-12 23:53:39 -04:00
/* translators: 1: blog name, 2: separator(raquo), 3: author name */
2009-01-19 00:04:58 -05:00
'authortitle' => __ ( '%1$s %2$s Posts by %3$s Feed' ),
2009-03-12 23:53:39 -04:00
/* translators: 1: blog name, 2: separator(raquo), 3: search phrase */
2009-05-05 00:28:05 -04:00
'searchtitle' => __ ( '%1$s %2$s Search Results for “%3$s” Feed' ),
2009-01-19 00:04:58 -05:00
);
$args = wp_parse_args ( $args , $defaults );
if ( is_single () || is_page () ) {
$post = & get_post ( $id = 0 );
2009-03-07 16:34:01 -05:00
if ( comments_open () || pings_open () || $post -> comment_count > 0 ) {
2009-05-18 11:11:07 -04:00
$title = esc_attr ( sprintf ( $args [ 'singletitle' ], get_bloginfo ( 'name' ), $args [ 'separator' ], esc_html ( get_the_title () ) ));
2009-03-07 16:34:01 -05:00
$href = get_post_comments_feed_link ( $post -> ID );
}
} elseif ( is_category () ) {
2009-01-19 00:04:58 -05:00
$cat_id = intval ( get_query_var ( 'cat' ) );
2009-05-05 15:43:53 -04:00
$title = esc_attr ( sprintf ( $args [ 'cattitle' ], get_bloginfo ( 'name' ), $args [ 'separator' ], get_cat_name ( $cat_id ) ));
2009-03-07 16:34:01 -05:00
$href = get_category_feed_link ( $cat_id );
} elseif ( is_tag () ) {
2009-01-19 00:04:58 -05:00
$tag_id = intval ( get_query_var ( 'tag_id' ) );
$tag = get_tag ( $tag_id );
2009-05-05 15:43:53 -04:00
$title = esc_attr ( sprintf ( $args [ 'tagtitle' ], get_bloginfo ( 'name' ), $args [ 'separator' ], $tag -> name ));
2009-03-07 16:34:01 -05:00
$href = get_tag_feed_link ( $tag_id );
} elseif ( is_author () ) {
2009-01-19 00:04:58 -05:00
$author_id = intval ( get_query_var ( 'author' ) );
2009-05-16 18:32:48 -04:00
$title = esc_attr ( sprintf ( $args [ 'authortitle' ], get_bloginfo ( 'name' ), $args [ 'separator' ], get_the_author_meta ( 'display_name' , $author_id ) ));
2009-03-07 16:34:01 -05:00
$href = get_author_feed_link ( $author_id );
} elseif ( is_search () ) {
2009-05-05 15:43:53 -04:00
$title = esc_attr ( sprintf ( $args [ 'searchtitle' ], get_bloginfo ( 'name' ), $args [ 'separator' ], get_search_query () ));
2009-03-07 16:34:01 -05:00
$href = get_search_feed_link ();
2009-01-19 00:04:58 -05:00
}
2009-03-07 16:34:01 -05:00
if ( isset ( $title ) && isset ( $href ) )
echo '<link rel="alternate" type="' . feed_content_type () . '" title="' . $title . '" href="' . $href . '" />' . " \n " ;
2009-01-19 00:04:58 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Display the link to the Really Simple Discovery service endpoint .
2008-09-05 15:19:01 -04:00
*
2008-09-05 17:47:53 -04:00
* @ link http :// archipelago . phrasewise . com / rsd
2008-09-05 15:19:01 -04:00
* @ since 2.0 . 0
*/
2005-11-07 04:47:51 -05:00
function rsd_link () {
2008-01-02 13:21:19 -05:00
echo '<link rel="EditURI" type="application/rsd+xml" title="RSD" href="' . get_bloginfo ( 'wpurl' ) . " /xmlrpc.php?rsd \" /> \n " ;
2007-10-05 13:29:34 -04:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Display the link to the Windows Live Writer manifest file .
2008-09-05 15:19:01 -04:00
*
2008-09-05 17:47:53 -04:00
* @ link http :// msdn . microsoft . com / en - us / library / bb463265 . aspx
2008-09-05 15:19:01 -04:00
* @ since 2.3 . 1
*/
2007-10-05 13:29:34 -04:00
function wlwmanifest_link () {
2008-01-02 13:21:19 -05:00
echo '<link rel="wlwmanifest" type="application/wlwmanifest+xml" href="'
. get_bloginfo ( 'wpurl' ) . '/wp-includes/wlwmanifest.xml" /> ' . " \n " ;
2005-11-07 04:47:51 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Display a noindex meta tag if required by the blog configuration .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* If a blog is marked as not being public then the noindex meta tag will be
* output to tell web robots not to index the page content .
2008-09-05 15:19:01 -04:00
*
* @ since 2.1 . 0
*/
2006-02-18 02:40:43 -05:00
function noindex () {
// If the blog is not public, tell robots to go away.
2006-06-17 19:38:45 -04:00
if ( '0' == get_option ( 'blog_public' ) )
echo " <meta name='robots' content='noindex,nofollow' /> \n " ;
2006-02-18 02:40:43 -05:00
}
2006-06-07 19:17:59 -04:00
2008-09-05 15:19:01 -04:00
/**
2008-09-05 17:47:53 -04:00
* Determine if TinyMCE is available .
2008-09-05 15:19:01 -04:00
*
2008-09-05 17:47:53 -04:00
* Checks to see if the user has deleted the tinymce files to slim down there WordPress install .
2008-09-05 15:19:01 -04:00
*
* @ since 2.1 . 0
*
2008-09-05 17:47:53 -04:00
* @ return bool Whether of not TinyMCE exists .
2008-09-05 15:19:01 -04:00
*/
2006-10-23 23:57:19 -04:00
function rich_edit_exists () {
global $wp_rich_edit_exists ;
if ( ! isset ( $wp_rich_edit_exists ) )
$wp_rich_edit_exists = file_exists ( ABSPATH . WPINC . '/js/tinymce/tiny_mce.js' );
return $wp_rich_edit_exists ;
}
2006-09-22 18:24:50 -04:00
2008-09-05 15:19:01 -04:00
/**
2008-09-05 17:47:53 -04:00
* Whether or not the user should have a WYSIWIG editor .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* Checks that the user requires a WYSIWIG editor and that the editor is
* supported in the users browser .
2008-09-05 15:19:01 -04:00
*
* @ since 2.0 . 0
*
2008-09-05 17:47:53 -04:00
* @ return bool
2008-09-05 15:19:01 -04:00
*/
2006-10-23 23:57:19 -04:00
function user_can_richedit () {
2006-12-06 19:38:54 -05:00
global $wp_rich_edit , $pagenow ;
2007-06-13 22:25:30 -04:00
2007-05-09 21:31:12 -04:00
if ( ! isset ( $wp_rich_edit ) ) {
2007-09-03 19:32:58 -04:00
if ( get_user_option ( 'rich_editing' ) == 'true' &&
( ( preg_match ( '!AppleWebKit/(\d+)!' , $_SERVER [ 'HTTP_USER_AGENT' ], $match ) && intval ( $match [ 1 ]) >= 420 ) ||
2007-07-05 16:11:32 -04:00
! preg_match ( '!opera[ /][2-8]|konqueror|safari!i' , $_SERVER [ 'HTTP_USER_AGENT' ] ) )
&& 'comment.php' != $pagenow ) {
2007-05-09 21:31:12 -04:00
$wp_rich_edit = true ;
} else {
$wp_rich_edit = false ;
}
}
2006-09-22 18:24:50 -04:00
2006-10-23 23:57:19 -04:00
return apply_filters ( 'user_can_richedit' , $wp_rich_edit );
2006-09-22 18:24:50 -04:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Find out which editor should be displayed by default .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* Works out which of the two editors to display as the current editor for a
* user .
2008-09-05 15:19:01 -04:00
*
* @ since 2.5 . 0
*
* @ return string Either 'tinymce' , or 'html' , or 'test'
*/
2008-01-06 14:01:32 -05:00
function wp_default_editor () {
$r = user_can_richedit () ? 'tinymce' : 'html' ; // defaults
if ( $user = wp_get_current_user () ) { // look for cookie
2008-08-31 02:34:43 -04:00
$ed = get_user_setting ( 'editor' , 'tinymce' );
$r = ( in_array ( $ed , array ( 'tinymce' , 'html' , 'test' ) ) ) ? $ed : $r ;
2008-01-06 14:01:32 -05:00
}
return apply_filters ( 'wp_default_editor' , $r ); // filter
}
2008-09-05 15:19:01 -04:00
/**
2008-09-12 00:31:41 -04:00
* Display visual editor forms : TinyMCE , or HTML , or both .
*
* The amount of rows the text area will have for the content has to be between
* 3 and 100 or will default at 12. There is only one option used for all users ,
* named 'default_post_edit_rows' .
2008-09-05 15:19:01 -04:00
*
2008-09-12 00:31:41 -04:00
* If the user can not use the rich editor ( TinyMCE ), then the switch button
* will not be displayed .
2008-09-05 15:19:01 -04:00
*
* @ since 2.1 . 0
*
2008-09-12 00:31:41 -04:00
* @ param string $content Textarea content .
2010-01-10 10:50:17 -05:00
* @ param string $id Optional , default is 'content' . HTML ID attribute value .
* @ param string $prev_id Optional , default is 'title' . HTML ID name for switching back and forth between visual editors .
2008-09-12 00:31:41 -04:00
* @ param bool $media_buttons Optional , default is true . Whether to display media buttons .
* @ param int $tab_index Optional , default is 2. Tabindex for textarea element .
2008-09-05 15:19:01 -04:00
*/
2008-02-25 23:53:48 -05:00
function the_editor ( $content , $id = 'content' , $prev_id = 'title' , $media_buttons = true , $tab_index = 2 ) {
2006-08-30 17:46:31 -04:00
$rows = get_option ( 'default_post_edit_rows' );
2006-06-07 19:17:59 -04:00
if (( $rows < 3 ) || ( $rows > 100 ))
$rows = 12 ;
2008-11-13 02:45:11 -05:00
if ( ! current_user_can ( 'upload_files' ) )
$media_buttons = false ;
2008-10-31 12:52:55 -04:00
$richedit = user_can_richedit ();
2009-05-04 06:34:50 -04:00
$class = '' ;
2008-12-09 13:03:31 -05:00
2008-10-31 12:52:55 -04:00
if ( $richedit || $media_buttons ) { ?>
2008-02-18 12:11:12 -05:00
< div id = " editor-toolbar " >
2009-05-04 06:34:50 -04:00
< ? php
if ( $richedit ) {
2008-02-18 12:11:12 -05:00
$wp_default_editor = wp_default_editor (); ?>
< div class = " zerosize " >< input accesskey = " e " type = " button " onclick = " switchEditors.go('<?php echo $id ; ?>') " /></ div >
2009-05-04 06:34:50 -04:00
< ? php if ( 'html' == $wp_default_editor ) {
2008-02-18 12:11:12 -05:00
add_filter ( 'the_editor_content' , 'wp_htmledit_pre' ); ?>
2009-05-04 06:34:50 -04:00
< a id = " edButtonHTML " class = " active hide-if-no-js " onclick = " switchEditors.go('<?php echo $id ; ?>', 'html'); " >< ? php _e ( 'HTML' ); ?> </a>
< a id = " edButtonPreview " class = " hide-if-no-js " onclick = " switchEditors.go('<?php echo $id ; ?>', 'tinymce'); " >< ? php _e ( 'Visual' ); ?> </a>
< ? php } else {
$class = " class='theEditor' " ;
2008-09-28 10:21:00 -04:00
add_filter ( 'the_editor_content' , 'wp_richedit_pre' ); ?>
2009-05-04 06:34:50 -04:00
< a id = " edButtonHTML " class = " hide-if-no-js " onclick = " switchEditors.go('<?php echo $id ; ?>', 'html'); " >< ? php _e ( 'HTML' ); ?> </a>
< a id = " edButtonPreview " class = " active hide-if-no-js " onclick = " switchEditors.go('<?php echo $id ; ?>', 'tinymce'); " >< ? php _e ( 'Visual' ); ?> </a>
< ? php }
}
2008-03-02 15:17:30 -05:00
2009-05-04 06:34:50 -04:00
if ( $media_buttons ) { ?>
< div id = " media-buttons " class = " hide-if-no-js " >
< ? php do_action ( 'media_buttons' ); ?>
</ div >
< ? php
} ?>
2006-09-22 03:04:41 -04:00
</ div >
2009-05-04 06:34:50 -04:00
< ? php
}
?>
< div id = " quicktags " >< ? php
wp_print_scripts ( 'quicktags' ); ?>
2006-09-22 03:04:41 -04:00
< script type = " text/javascript " > edToolbar () </ script >
</ div >
2008-01-06 14:01:32 -05:00
2009-05-04 06:34:50 -04:00
< ? php
$the_editor = apply_filters ( 'the_editor' , " <div id='editorcontainer'><textarea rows=' $rows ' $class cols='40' name=' $id ' tabindex=' $tab_index ' id=' $id '>%s</textarea></div> \n " );
2006-06-07 19:17:59 -04:00
$the_editor_content = apply_filters ( 'the_editor_content' , $content );
printf ( $the_editor , $the_editor_content );
2009-05-04 06:34:50 -04:00
?>
2008-08-24 02:56:22 -04:00
< script type = " text/javascript " >
edCanvas = document . getElementById ( '<?php echo $id; ?>' );
</ script >
2009-05-04 06:34:50 -04:00
< ? php
2006-06-07 19:17:59 -04:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Retrieve the contents of the search WordPress query variable .
2008-09-05 15:19:01 -04:00
*
* @ since 2.3 . 0
*
2008-09-05 17:47:53 -04:00
* @ return string
2008-09-05 15:19:01 -04:00
*/
2007-05-23 23:37:10 -04:00
function get_search_query () {
2009-12-10 03:07:19 -05:00
return apply_filters ( 'get_search_query' , get_query_var ( 's' ) );
2007-05-23 23:37:10 -04:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Display the contents of the search query variable .
2008-12-09 13:03:31 -05:00
*
2009-05-05 15:43:53 -04:00
* The search query string is passed through { @ link esc_attr ()}
2008-09-06 02:38:26 -04:00
* to ensure that it is safe for placing in an html attribute .
2008-09-05 15:19:01 -04:00
*
2009-04-28 01:58:45 -04:00
* @ uses attr
2008-09-05 15:19:01 -04:00
* @ since 2.1 . 0
*/
2006-09-07 13:37:26 -04:00
function the_search_query () {
2009-05-05 15:43:53 -04:00
echo esc_attr ( apply_filters ( 'the_search_query' , get_search_query () ) );
2006-09-07 13:37:26 -04:00
}
2008-09-05 15:19:01 -04:00
/**
2008-09-06 02:38:26 -04:00
* Display the language attributes for the html tag .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* Builds up a set of html attributes containing the text direction and language
* information for the page .
2008-09-05 15:19:01 -04:00
*
* @ since 2.1 . 0
*
2008-09-05 17:47:53 -04:00
* @ param string $doctype The type of html document ( xhtml | html ) .
2008-09-05 15:19:01 -04:00
*/
2007-12-19 12:44:02 -05:00
function language_attributes ( $doctype = 'html' ) {
$attributes = array ();
2006-09-24 16:16:13 -04:00
$output = '' ;
2008-02-05 01:47:27 -05:00
2006-09-24 16:16:13 -04:00
if ( $dir = get_bloginfo ( 'text_direction' ) )
2007-12-19 12:44:02 -05:00
$attributes [] = " dir= \" $dir\ " " ;
2008-02-05 01:47:27 -05:00
2006-09-24 16:16:13 -04:00
if ( $lang = get_bloginfo ( 'language' ) ) {
2008-12-30 13:35:31 -05:00
if ( get_option ( 'html_type' ) == 'text/html' || $doctype == 'html' )
2007-12-19 12:44:02 -05:00
$attributes [] = " lang= \" $lang\ " " ;
2008-02-05 01:47:27 -05:00
2007-12-19 12:44:02 -05:00
if ( get_option ( 'html_type' ) != 'text/html' || $doctype == 'xhtml' )
$attributes [] = " xml:lang= \" $lang\ " " ;
}
2008-02-05 01:47:27 -05:00
2007-12-19 12:44:02 -05:00
$output = implode ( ' ' , $attributes );
$output = apply_filters ( 'language_attributes' , $output );
2006-09-24 16:16:13 -04:00
echo $output ;
}
2006-10-03 03:16:49 -04:00
2008-09-05 15:19:01 -04:00
/**
2008-09-12 00:31:41 -04:00
* Retrieve paginated link for archive post pages .
*
* Technically , the function can be used to create paginated link list for any
* area . The 'base' argument is used to reference the url , which will be used to
* create the paginated links . The 'format' argument is then used for replacing
* the page number . It is however , most likely and by default , to be used on the
* archive post pages .
*
* The 'type' argument controls format of the returned value . The default is
* 'plain' , which is just a string with the links separated by a newline
* character . The other possible values are either 'array' or 'list' . The
* 'array' value will return an array of the paginated link list to offer full
* control of display . The 'list' value will place all of the paginated links in
* an unordered HTML list .
*
* The 'total' argument is the total amount of pages and is an integer . The
* 'current' argument is the current page number and is also an integer .
*
* An example of the 'base' argument is " http://example.com/all_posts.php%_% "
* and the '%_%' is required . The '%_%' will be replaced by the contents of in
* the 'format' argument . An example for the 'format' argument is " ?page=%#% "
* and the '%#%' is also required . The '%#%' will be replaced with the page
* number .
*
* You can include the previous and next links in the list by setting the
* 'prev_next' argument to true , which it is by default . You can set the
* previous text , by using the 'prev_text' argument . You can set the next text
* by setting the 'next_text' argument .
*
* If the 'show_all' argument is set to true , then it will show all of the pages
* instead of a short list of the pages near the current page . By default , the
* 'show_all' is set to false and controlled by the 'end_size' and 'mid_size'
* arguments . The 'end_size' argument is how many numbers on either the start
* and the end list edges , by default is 1. The 'mid_size' argument is how many
* numbers to either side of current page , but not including current page .
*
* It is possible to add query vars to the link by using the 'add_args' argument
* and see { @ link add_query_arg ()} for more information .
2008-09-05 15:19:01 -04:00
*
* @ since 2.1 . 0
*
2008-09-12 00:31:41 -04:00
* @ param string | array $args Optional . Override defaults .
* @ return array | string String of page links or array of page links .
2008-09-05 15:19:01 -04:00
*/
2007-06-14 18:46:59 -04:00
function paginate_links ( $args = '' ) {
2007-09-03 19:32:58 -04:00
$defaults = array (
2007-06-14 18:46:59 -04:00
'base' => '%_%' , // http://example.com/all_posts.php%_% : %_% is replaced by format (below)
'format' => '?page=%#%' , // ?page=%#% : %#% is replaced by the page number
'total' => 1 ,
'current' => 0 ,
'show_all' => false ,
'prev_next' => true ,
'prev_text' => __ ( '« Previous' ),
'next_text' => __ ( 'Next »' ),
2008-09-12 00:31:41 -04:00
'end_size' => 1 ,
'mid_size' => 2 ,
2007-06-14 18:46:59 -04:00
'type' => 'plain' ,
2008-10-07 18:41:51 -04:00
'add_args' => false , // array of query args to add
'add_fragment' => ''
2007-06-14 18:46:59 -04:00
);
$args = wp_parse_args ( $args , $defaults );
extract ( $args , EXTR_SKIP );
2006-10-03 03:16:49 -04:00
// Who knows what else people pass in $args
2008-09-12 00:31:41 -04:00
$total = ( int ) $total ;
2006-10-03 11:40:26 -04:00
if ( $total < 2 )
return ;
2006-10-03 03:16:49 -04:00
$current = ( int ) $current ;
$end_size = 0 < ( int ) $end_size ? ( int ) $end_size : 1 ; // Out of bounds? Make it the default.
$mid_size = 0 <= ( int ) $mid_size ? ( int ) $mid_size : 2 ;
$add_args = is_array ( $add_args ) ? $add_args : false ;
$r = '' ;
$page_links = array ();
$n = 0 ;
$dots = false ;
if ( $prev_next && $current && 1 < $current ) :
2006-10-03 11:40:26 -04:00
$link = str_replace ( '%_%' , 2 == $current ? '' : $format , $base );
$link = str_replace ( '%#%' , $current - 1 , $link );
2006-10-03 03:16:49 -04:00
if ( $add_args )
$link = add_query_arg ( $add_args , $link );
2008-10-07 18:41:51 -04:00
$link .= $add_fragment ;
2009-05-18 12:00:33 -04:00
$page_links [] = " <a class='prev page-numbers' href=' " . esc_url ( $link ) . " '> $prev_text </a> " ;
2006-10-03 03:16:49 -04:00
endif ;
for ( $n = 1 ; $n <= $total ; $n ++ ) :
2008-11-17 20:10:40 -05:00
$n_display = number_format_i18n ( $n );
2006-10-03 03:16:49 -04:00
if ( $n == $current ) :
2008-11-17 20:10:40 -05:00
$page_links [] = " <span class='page-numbers current'> $n_display </span> " ;
2006-10-03 03:16:49 -04:00
$dots = true ;
else :
if ( $show_all || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :
2006-10-03 11:40:26 -04:00
$link = str_replace ( '%_%' , 1 == $n ? '' : $format , $base );
$link = str_replace ( '%#%' , $n , $link );
2006-10-03 03:16:49 -04:00
if ( $add_args )
$link = add_query_arg ( $add_args , $link );
2008-10-07 18:41:51 -04:00
$link .= $add_fragment ;
2009-05-18 12:00:33 -04:00
$page_links [] = " <a class='page-numbers' href=' " . esc_url ( $link ) . " '> $n_display </a> " ;
2006-10-03 03:16:49 -04:00
$dots = true ;
elseif ( $dots && ! $show_all ) :
$page_links [] = " <span class='page-numbers dots'>...</span> " ;
$dots = false ;
endif ;
endif ;
endfor ;
if ( $prev_next && $current && ( $current < $total || - 1 == $total ) ) :
2006-10-03 11:40:26 -04:00
$link = str_replace ( '%_%' , $format , $base );
$link = str_replace ( '%#%' , $current + 1 , $link );
2006-10-03 03:16:49 -04:00
if ( $add_args )
$link = add_query_arg ( $add_args , $link );
2008-10-07 18:41:51 -04:00
$link .= $add_fragment ;
2009-05-18 12:00:33 -04:00
$page_links [] = " <a class='next page-numbers' href=' " . esc_url ( $link ) . " '> $next_text </a> " ;
2006-10-03 03:16:49 -04:00
endif ;
switch ( $type ) :
case 'array' :
return $page_links ;
break ;
case 'list' :
$r .= " <ul class='page-numbers'> \n \t <li> " ;
$r .= join ( " </li> \n \t <li> " , $page_links );
$r .= " </li> \n </ul> \n " ;
break ;
default :
$r = join ( " \n " , $page_links );
break ;
endswitch ;
return $r ;
}
2007-08-28 19:23:38 -04:00
2008-09-05 17:47:53 -04:00
/**
2008-09-06 02:38:26 -04:00
* Registers an admin colour scheme css file .
2008-09-05 17:47:53 -04:00
*
2008-09-06 02:38:26 -04:00
* Allows a plugin to register a new admin colour scheme . For example :
2008-09-05 17:47:53 -04:00
* < code >
2008-09-06 02:38:26 -04:00
* wp_admin_css_color ( 'classic' , __ ( 'Classic' ), admin_url ( " css/colors-classic.css " ),
* array ( '#07273E' , '#14568A' , '#D54E21' , '#2683AE' ));
2008-09-05 17:47:53 -04:00
* </ code >
*
2008-09-06 02:38:26 -04:00
* @ since 2.5 . 0
*
2008-09-05 17:47:53 -04:00
* @ param string $key The unique key for this theme .
* @ param string $name The name of the theme .
* @ param string $url The url of the css file containing the colour scheme .
2010-01-10 10:50:17 -05:00
* @ param array @ colors Optional An array of CSS color definitions which are used to give the user a feel for the theme .
2008-09-05 17:47:53 -04:00
*/
2008-03-11 17:06:03 -04:00
function wp_admin_css_color ( $key , $name , $url , $colors = array ()) {
global $_wp_admin_css_colors ;
if ( ! isset ( $_wp_admin_css_colors ) )
$_wp_admin_css_colors = array ();
$_wp_admin_css_colors [ $key ] = ( object ) array ( 'name' => $name , 'url' => $url , 'colors' => $colors );
}
2010-02-06 00:15:26 -05:00
/**
* Registers the default Admin color themes
*
* @ since 3.0 . 0
*/
function register_admin_color_themes () {
wp_admin_css_color ( 'classic' , __ ( 'Blue' ), admin_url ( " css/colors-classic.css " ), array ( '#073447' , '#21759B' , '#EAF3FA' , '#BBD8E7' ));
wp_admin_css_color ( 'fresh' , __ ( 'Gray' ), admin_url ( " css/colors-fresh.css " ), array ( '#464646' , '#6D6D6D' , '#F1F1F1' , '#DFDFDF' ));}
2008-05-25 17:23:22 -04:00
/**
2008-09-06 02:38:26 -04:00
* Display the URL of a WordPress admin CSS file .
2008-05-25 17:23:22 -04:00
*
* @ see WP_Styles :: _css_href and its style_loader_src filter .
*
2008-09-05 15:19:01 -04:00
* @ since 2.3 . 0
*
2008-05-25 17:23:22 -04:00
* @ param string $file file relative to wp - admin / without its " .css " extension .
*/
2007-08-28 19:23:38 -04:00
function wp_admin_css_uri ( $file = 'wp-admin' ) {
2008-03-11 17:06:03 -04:00
if ( defined ( 'WP_INSTALLING' ) ) {
$_file = " ./ $file .css " ;
2007-09-03 16:20:18 -04:00
} else {
2008-05-27 13:46:01 -04:00
$_file = admin_url ( " $file .css " );
2007-09-03 19:32:58 -04:00
}
2008-03-11 17:06:03 -04:00
$_file = add_query_arg ( 'version' , get_bloginfo ( 'version' ), $_file );
2007-08-28 19:23:38 -04:00
return apply_filters ( 'wp_admin_css_uri' , $_file , $file );
}
2008-05-25 17:23:22 -04:00
/**
2008-09-05 17:47:53 -04:00
* Enqueues or directly prints a stylesheet link to the specified CSS file .
2008-05-25 17:23:22 -04:00
*
2008-09-06 02:38:26 -04:00
* " Intelligently " decides to enqueue or to print the CSS file . If the
* 'wp_print_styles' action has * not * yet been called , the CSS file will be
* enqueued . If the wp_print_styles action * has * been called , the CSS link will
* be printed . Printing may be forced by passing TRUE as the $force_echo
* ( second ) parameter .
2008-05-25 17:23:22 -04:00
*
2008-09-06 02:38:26 -04:00
* For backward compatibility with WordPress 2.3 calling method : If the $file
* ( first ) parameter does not correspond to a registered CSS file , we assume
* $file is a file relative to wp - admin / without its " .css " extension . A
* stylesheet link to that generated URL is printed .
2008-05-25 17:23:22 -04:00
*
* @ package WordPress
2008-09-06 02:38:26 -04:00
* @ since 2.3 . 0
2008-05-25 17:23:22 -04:00
* @ uses $wp_styles WordPress Styles Object
*
* @ param string $file Style handle name or file name ( without " .css " extension ) relative to wp - admin /
* @ param bool $force_echo Optional . Force the stylesheet link to be printed rather than enqueued .
*/
2008-05-21 20:06:41 -04:00
function wp_admin_css ( $file = 'wp-admin' , $force_echo = false ) {
2008-05-21 19:24:23 -04:00
global $wp_styles ;
if ( ! is_a ( $wp_styles , 'WP_Styles' ) )
$wp_styles = new WP_Styles ();
2008-05-25 17:23:22 -04:00
// For backward compatibility
2008-05-21 19:24:23 -04:00
$handle = 0 === strpos ( $file , 'css/' ) ? substr ( $file , 4 ) : $file ;
2008-03-11 17:06:03 -04:00
2008-05-21 19:24:23 -04:00
if ( $wp_styles -> query ( $handle ) ) {
2008-05-21 20:06:41 -04:00
if ( $force_echo || did_action ( 'wp_print_styles' ) ) // we already printed the style queue. Print this one immediately
2008-05-21 19:24:23 -04:00
wp_print_styles ( $handle );
else // Add to style queue
wp_enqueue_style ( $handle );
return ;
2007-08-28 19:23:38 -04:00
}
2008-05-21 19:24:23 -04:00
2009-05-18 12:00:33 -04:00
echo apply_filters ( 'wp_admin_css' , " <link rel='stylesheet' href=' " . esc_url ( wp_admin_css_uri ( $file ) ) . " ' type='text/css' /> \n " , $file );
2008-05-21 19:24:23 -04:00
if ( 'rtl' == get_bloginfo ( 'text_direction' ) )
2009-05-18 12:00:33 -04:00
echo apply_filters ( 'wp_admin_css' , " <link rel='stylesheet' href=' " . esc_url ( wp_admin_css_uri ( " $file -rtl " ) ) . " ' type='text/css' /> \n " , " $file -rtl " );
2007-08-28 19:23:38 -04:00
}
2008-05-22 11:27:28 -04:00
/**
2008-12-09 13:03:31 -05:00
* Enqueues the default ThickBox js and css .
*
2008-09-06 02:38:26 -04:00
* If any of the settings need to be changed , this can be done with another js
* file similar to media - upload . js and theme - preview . js . That file should
* require array ( 'thickbox' ) to ensure it is loaded after .
*
* @ since 2.5 . 0
2008-05-22 11:27:28 -04:00
*/
2008-05-20 13:19:33 -04:00
function add_thickbox () {
wp_enqueue_script ( 'thickbox' );
2008-05-22 11:27:28 -04:00
wp_enqueue_style ( 'thickbox' );
2008-05-20 13:19:33 -04:00
}
2007-10-06 02:55:24 -04:00
/**
2008-09-06 02:38:26 -04:00
* Display the XHTML generator that is generated on the wp_head hook .
*
* @ since 2.5 . 0
2007-10-06 02:55:24 -04:00
*/
2008-09-05 15:19:01 -04:00
function wp_generator () {
2007-10-06 02:55:24 -04:00
the_generator ( apply_filters ( 'wp_generator_type' , 'xhtml' ) );
}
/**
2008-09-06 02:38:26 -04:00
* Display the generator XML or Comment for RSS , ATOM , etc .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* Returns the correct generator type for the requested output format . Allows
* for a plugin to filter generators overall the the_generator filter .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* @ since 2.5 . 0
* @ uses apply_filters () Calls 'the_generator' hook .
2008-09-05 15:19:01 -04:00
*
2008-09-05 17:47:53 -04:00
* @ param string $type The type of generator to output - ( html | xhtml | atom | rss2 | rdf | comment | export ) .
2007-10-06 02:55:24 -04:00
*/
2008-09-05 15:19:01 -04:00
function the_generator ( $type ) {
echo apply_filters ( 'the_generator' , get_the_generator ( $type ), $type ) . " \n " ;
2007-10-06 02:55:24 -04:00
}
/**
2008-09-05 17:47:53 -04:00
* Creates the generator XML or Comment for RSS , ATOM , etc .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* Returns the correct generator type for the requested output format . Allows
* for a plugin to filter generators on an individual basis using the
* 'get_the_generator_{$type}' filter .
2008-09-05 15:19:01 -04:00
*
2008-09-06 02:38:26 -04:00
* @ since 2.5 . 0
* @ uses apply_filters () Calls 'get_the_generator_$type' hook .
2008-09-05 15:19:01 -04:00
*
2008-09-05 17:47:53 -04:00
* @ param string $type The type of generator to return - ( html | xhtml | atom | rss2 | rdf | comment | export ) .
2008-09-06 02:38:26 -04:00
* @ return string The HTML content for the generator .
2007-10-06 02:55:24 -04:00
*/
2010-02-13 11:45:16 -05:00
function get_the_generator ( $type = '' ) {
if ( empty ( $type ) ) {
$current_filter = current_filter ();
if ( empty ( $current_filter ) )
return ;
switch ( $current_filter ) {
case 'rss2_head' :
case 'commentsrss2_head' :
$type = 'rss2' ;
break ;
case 'rss_head' :
case 'opml_head' :
$type = 'comment' ;
break ;
case 'rdf_header' :
$type = 'rdf' ;
break ;
case 'atom_head' :
case 'comments_atom_head' :
case 'app_head' :
$type = 'atom' ;
break ;
}
}
switch ( $type ) {
2007-10-06 02:55:24 -04:00
case 'html' :
2009-02-23 00:24:14 -05:00
$gen = '<meta name="generator" content="WordPress ' . get_bloginfo ( 'version' ) . '">' ;
2007-10-06 02:55:24 -04:00
break ;
case 'xhtml' :
2009-02-23 00:24:14 -05:00
$gen = '<meta name="generator" content="WordPress ' . get_bloginfo ( 'version' ) . '" />' ;
2007-10-06 02:55:24 -04:00
break ;
case 'atom' :
$gen = '<generator uri="http://wordpress.org/" version="' . get_bloginfo_rss ( 'version' ) . '">WordPress</generator>' ;
break ;
case 'rss2' :
$gen = '<generator>http://wordpress.org/?v=' . get_bloginfo_rss ( 'version' ) . '</generator>' ;
break ;
case 'rdf' :
$gen = '<admin:generatorAgent rdf:resource="http://wordpress.org/?v=' . get_bloginfo_rss ( 'version' ) . '" />' ;
break ;
case 'comment' :
$gen = '<!-- generator="WordPress/' . get_bloginfo ( 'version' ) . '" -->' ;
break ;
case 'export' :
2008-03-28 15:05:22 -04:00
$gen = '<!-- generator="WordPress/' . get_bloginfo_rss ( 'version' ) . '" created="' . date ( 'Y-m-d H:i' ) . '"-->' ;
2007-10-06 02:55:24 -04:00
break ;
}
return apply_filters ( " get_the_generator_ { $type } " , $gen , $type );
}
2008-09-05 15:19:01 -04:00
2010-02-20 16:57:43 -05:00
/**
* Outputs the Custom Navigation .
*
* @ since 3.0 . 0
*/
function custom_nav ( $args = array ()) {
2010-02-20 18:18:57 -05:00
require_once ( ABSPATH . WPINC . '/custom-navigation.php' );
2010-02-20 16:57:43 -05:00
wp_custom_navigation_output ( $args );
}
2010-01-11 17:33:28 -05:00
?>