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
2010-05-03 05:57:24 -04:00
* specialised header 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
*
* @ since 1.5 . 0
2014-04-15 00:01:15 -04:00
*
* @ uses locate_template ()
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 ) {
2014-04-15 00:01:15 -04:00
/**
* Fires before the header template file is loaded .
*
* The hook allows a specific header template file to be used in place of the
* default header template file . If your file is called header - new . php ,
* you would specify the filename in the hook as get_header ( 'new' ) .
*
* @ since 2.1 . 0
* @ since 2.8 . 0 $name parameter added .
*
* @ param string $name Name of the specific header file to use .
*/
2009-06-04 13:59:14 -04:00
do_action ( 'get_header' , $name );
2008-08-19 16:57:48 -04:00
2011-11-16 17:55:59 -05:00
$templates = array ();
2013-07-09 16:31:04 -04:00
$name = ( string ) $name ;
if ( '' !== $name )
2011-11-16 17:55:59 -05:00
$templates [] = " header- { $name } .php " ;
$templates [] = 'header.php' ;
2010-05-03 05:57:24 -04:00
// Backward compat code will be removed in a future release
2011-11-16 17:55:59 -05:00
if ( '' == locate_template ( $templates , true ))
load_template ( ABSPATH . WPINC . '/theme-compat/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
2010-05-03 05:57:24 -04:00
* specialised footer will be included .
2008-09-06 02:38:26 -04:00
*
* For the parameter , if the file is called " footer-special.php " then specify
* " special " .
2008-09-05 15:19:01 -04:00
*
* @ since 1.5 . 0
2014-04-15 00:01:15 -04:00
*
* @ uses locate_template ()
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 ) {
2014-04-15 00:01:15 -04:00
/**
* Fires before the footer template file is loaded .
*
* The hook allows a specific footer template file to be used in place of the
* default footer template file . If your file is called footer - new . php ,
* you would specify the filename in the hook as get_footer ( 'new' ) .
*
* @ since 2.1 . 0
* @ since 2.8 . 0 $name parameter added .
*
* @ param string $name Name of the specific footer file to use .
*/
2009-06-04 13:59:14 -04:00
do_action ( 'get_footer' , $name );
2008-08-19 16:57:48 -04:00
2011-11-16 17:55:59 -05:00
$templates = array ();
2013-07-09 16:31:04 -04:00
$name = ( string ) $name ;
2013-07-09 16:48:02 -04:00
if ( '' !== $name )
2011-11-16 17:55:59 -05:00
$templates [] = " footer- { $name } .php " ;
$templates [] = 'footer.php' ;
2010-05-03 05:57:24 -04:00
// Backward compat code will be removed in a future release
2011-11-16 17:55:59 -05:00
if ( '' == locate_template ( $templates , true ))
load_template ( ABSPATH . WPINC . '/theme-compat/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
2010-05-03 05:57:24 -04:00
* specialised sidebar will be included .
2008-09-06 02:38:26 -04:00
*
* For the parameter , if the file is called " sidebar-special.php " then specify
* " special " .
2008-09-05 15:19:01 -04:00
*
* @ since 1.5 . 0
2014-04-15 00:01:15 -04:00
*
* @ uses locate_template ()
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 ) {
2014-04-15 00:01:15 -04:00
/**
* Fires before the sidebar template file is loaded .
*
* The hook allows a specific sidebar template file to be used in place of the
* default sidebar template file . If your file is called sidebar - new . php ,
* you would specify the filename in the hook as get_sidebar ( 'new' ) .
*
* @ since 2.2 . 0
* @ since 2.8 . 0 $name parameter added .
*
* @ param string $name Name of the specific sidebar file to use .
*/
2009-06-04 13:59:14 -04:00
do_action ( 'get_sidebar' , $name );
2008-08-19 16:57:48 -04:00
2011-11-16 17:55:59 -05:00
$templates = array ();
2013-07-09 16:31:04 -04:00
$name = ( string ) $name ;
if ( '' !== $name )
2011-11-16 17:55:59 -05:00
$templates [] = " sidebar- { $name } .php " ;
$templates [] = 'sidebar.php' ;
2010-05-03 05:57:24 -04:00
// Backward compat code will be removed in a future release
2011-11-16 17:55:59 -05:00
if ( '' == locate_template ( $templates , true ))
load_template ( ABSPATH . WPINC . '/theme-compat/sidebar.php' );
2004-12-30 05:58:06 -05:00
}
2010-02-14 04:32:23 -05:00
/**
2010-03-25 18:02:45 -04:00
* Load a template part into a template
2010-02-14 04:32:23 -05:00
*
2010-03-25 18:02:45 -04:00
* Makes it easy for a theme to reuse sections of code in a easy to overload way
* for child themes .
*
* Includes the named template part for a theme or if a name is specified then a
* specialised part will be included . If the theme contains no { slug } . php file
2010-02-14 04:32:23 -05:00
* then no template will be included .
*
2010-04-11 13:26:03 -04:00
* The template is included using require , not require_once , so you may include the
* same template part multiple times .
*
2011-09-19 15:01:03 -04:00
* For the $name parameter , if the file is called " { slug}-special.php " then specify
2010-02-14 04:32:23 -05:00
* " special " .
*
* @ since 3.0 . 0
2014-04-15 00:01:15 -04:00
*
* @ uses locate_template ()
2010-02-14 04:32:23 -05:00
*
* @ param string $slug The slug name for the generic template .
* @ param string $name The name of the specialised template .
*/
2010-03-25 18:02:45 -04:00
function get_template_part ( $slug , $name = null ) {
2014-04-15 00:01:15 -04:00
/**
* Fires before the specified template part file is loaded .
*
* The dynamic portion of the hook name , $slug , refers to the slug name
* for the generic template part .
*
* @ since 3.0 . 0
*
* @ param string $slug The slug name for the generic template .
* @ param string $name The name of the specialized template .
*/
2010-04-10 06:40:47 -04:00
do_action ( " get_template_part_ { $slug } " , $slug , $name );
2010-02-14 04:32:23 -05:00
$templates = array ();
2013-07-09 16:31:04 -04:00
$name = ( string ) $name ;
if ( '' !== $name )
2010-02-14 04:32:23 -05:00
$templates [] = " { $slug } - { $name } .php " ;
$templates [] = " { $slug } .php " ;
2011-11-16 17:55:59 -05:00
locate_template ( $templates , true , false );
2010-02-14 04:32:23 -05:00
}
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 ,
2013-03-26 17:08:04 -04:00
* 'pre_get_search_form' . This can be useful for outputting JavaScript that the
2009-01-22 16:17:52 -05:00
* 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
2013-03-26 16:27:13 -04:00
*
2010-02-10 13:37:14 -05:00
* @ param boolean $echo Default to echo and not return the form .
2012-09-20 09:52:36 -04:00
* @ return string | null String when retrieving , null when displaying or if searchform . php exists .
2008-10-18 16:46:30 -04:00
*/
2013-03-26 16:27:13 -04:00
function get_search_form ( $echo = true ) {
2014-04-15 00:01:15 -04:00
/**
* Fires before the search form is retrieved , at the start of get_search_form () .
*
* @ since 2.7 . 0 as 'get_search_form' action .
* @ since 3.6 . 0
*
* @ link https :// core . trac . wordpress . org / ticket / 19321
*/
2013-03-26 17:08:04 -04:00
do_action ( 'pre_get_search_form' );
2008-10-17 16:39:56 -04:00
2013-06-06 11:31:34 -04:00
$format = current_theme_supports ( 'html5' , 'search-form' ) ? 'html5' : 'xhtml' ;
2014-04-15 00:01:15 -04:00
/**
* Filter the HTML format of the search form .
*
* @ since 3.6 . 0
*
* @ param string $format The type of markup to use in the search form .
* Accepts 'html5' , 'xhtml' .
*/
2013-05-09 18:41:30 -04:00
$format = apply_filters ( 'search_form_format' , $format );
2013-03-26 16:27:13 -04:00
2013-03-12 06:25:08 -04:00
$search_form_template = locate_template ( 'searchform.php' );
2009-05-22 12:04:49 -04:00
if ( '' != $search_form_template ) {
2013-03-12 05:51:56 -04:00
ob_start ();
2013-03-12 06:25:08 -04:00
require ( $search_form_template );
2013-03-12 05:51:56 -04:00
$form = ob_get_clean ();
} else {
2013-03-26 19:18:43 -04:00
if ( 'html5' == $format ) {
2013-06-27 16:45:12 -04:00
$form = '<form role="search" method="get" class="search-form" action="' . esc_url ( home_url ( '/' ) ) . ' " >
< label >
< span class = " screen-reader-text " > ' . _x( ' Search for : ', ' label ' ) . ' </ span >
2013-10-07 10:14:09 -04:00
< input type = " search " class = " search-field " placeholder = " ' . esc_attr_x( 'Search …', 'placeholder' ) . ' " value = " ' . get_search_query() . ' " name = " s " title = " ' . esc_attr_x( 'Search for:', 'label' ) . ' " />
2013-04-04 20:26:53 -04:00
</ label >
2013-06-27 16:45:12 -04:00
< input type = " submit " class = " search-submit " value = " '. esc_attr_x( 'Search', 'submit button' ) .' " />
2013-04-04 20:26:53 -04:00
</ form > ' ;
} else {
$form = '<form role="search" method="get" id="searchform" class="searchform" action="' . esc_url ( home_url ( '/' ) ) . ' " >
< div >
< label class = " screen-reader-text " for = " s " > ' . _x( ' Search for : ', ' label ' ) . ' </ label >
< input type = " text " value = " ' . get_search_query() . ' " name = " s " id = " s " />
< input type = " submit " id = " searchsubmit " value = " '. esc_attr_x( 'Search', 'submit button' ) .' " />
</ div >
2013-03-26 19:18:43 -04:00
</ form > ' ;
}
2009-05-22 12:04:49 -04:00
}
2008-10-17 16:39:56 -04:00
2014-04-15 00:01:15 -04:00
/**
* Filter the HTML output of the search form .
*
* @ since 2.7 . 0
*
* @ param string $form The search form HTML output .
*/
2013-03-26 17:08:04 -04:00
$result = apply_filters ( 'get_search_form' , $form );
2014-04-15 00:01:15 -04:00
2013-03-26 17:08:04 -04:00
if ( null === $result )
$result = $form ;
2010-02-10 13:37:14 -05:00
if ( $echo )
2013-03-26 17:08:04 -04:00
echo $result ;
2010-02-10 13:37:14 -05:00
else
2013-03-26 17:08:04 -04:00
return $result ;
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
*
2010-02-26 00:46:08 -05:00
* Displays a link , which allows users to navigate to the Log In page to log in
2010-02-24 15:13:23 -05:00
* or log out depending on whether they are currently logged in .
2008-09-05 15:19:01 -04:00
*
* @ since 1.5 . 0
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 .
2012-09-20 09:52:36 -04:00
* @ return string | null String when retrieving , null when displaying .
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 () )
2010-05-03 14:16:22 -04:00
$link = '<a href="' . esc_url ( wp_login_url ( $redirect ) ) . '">' . __ ( 'Log in' ) . '</a>' ;
2005-10-17 19:41:28 -04:00
else
2010-05-03 14:16:22 -04:00
$link = '<a href="' . esc_url ( wp_logout_url ( $redirect ) ) . '">' . __ ( 'Log out' ) . '</a>' ;
2010-02-12 15:14:17 -05:00
2014-04-15 00:01:15 -04:00
if ( $echo ) {
/**
* Filter the HTML output for the Log In / Log Out link .
*
* @ since 1.5 . 0
*
* @ param string $link The HTML link content .
*/
echo apply_filters ( 'loginout' , $link );
} else {
/** This filter is documented in wp-includes/general-template.php */
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 .
*
2013-04-22 16:21:22 -04:00
* Returns the URL that allows the user to log out of the site .
2008-09-28 17:05:37 -04:00
*
2010-12-01 14:24:38 -05:00
* @ since 2.7 . 0
2014-04-15 00:01:15 -04:00
*
2013-04-22 16:21:22 -04:00
* @ uses wp_nonce_url () To protect against CSRF .
* @ uses site_url () To generate the log out 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 .
2012-09-20 09:52:36 -04:00
* @ return string A log out URL .
2008-09-28 17:05:37 -04:00
*/
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' );
2014-04-15 00:01:15 -04:00
/**
* Filter the logout URL .
*
* @ since 2.8 . 0
*
* @ param string $logout_url The Log Out URL .
* @ param string $redirect Path to redirect to on logout .
*/
return apply_filters ( 'logout_url' , $logout_url , $redirect );
2008-09-28 17:05:37 -04:00
}
/**
* Returns the Log In URL .
*
2013-04-22 16:21:22 -04:00
* Returns the URL that allows the user to log in to the site .
2008-09-28 17:05:37 -04:00
*
2010-12-01 14:24:38 -05:00
* @ since 2.7 . 0
2014-04-15 00:01:15 -04:00
*
2013-04-22 16:21:22 -04:00
* @ uses site_url () To generate the log in 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 .
2010-05-11 09:44:40 -04:00
* @ param bool $force_reauth Whether to force reauthorization , even if a cookie is present . Default is false .
2012-09-20 09:52:36 -04:00
* @ return string A log in URL .
2008-09-28 17:05:37 -04:00
*/
2010-05-11 09:44:40 -04:00
function wp_login_url ( $redirect = '' , $force_reauth = false ) {
2009-04-14 14:31:49 -04:00
$login_url = site_url ( 'wp-login.php' , 'login' );
2010-05-11 09:44:40 -04:00
if ( ! empty ( $redirect ) )
2009-05-14 12:11:01 -04:00
$login_url = add_query_arg ( 'redirect_to' , urlencode ( $redirect ), $login_url );
2010-05-11 09:44:40 -04:00
if ( $force_reauth )
$login_url = add_query_arg ( 'reauth' , '1' , $login_url );
2008-12-09 13:03:31 -05:00
2014-04-15 00:01:15 -04:00
/**
* Filter the login URL .
*
* @ since 2.8 . 0
*
* @ param string $login_url The login URL .
* @ param string $redirect The path to redirect to on login , if supplied .
*/
return apply_filters ( 'login_url' , $login_url , $redirect );
2008-09-28 17:05:37 -04:00
}
2013-04-22 16:21:22 -04:00
/**
* Returns the user registration URL .
*
* Returns the URL that allows the user to register on the site .
*
* @ since 3.6 . 0
2014-04-15 00:01:15 -04:00
*
2013-04-22 16:21:22 -04:00
* @ uses site_url () To generate the registration URL .
*
2014-04-15 00:01:15 -04:00
* @ return string User registration URL .
2013-04-22 16:21:22 -04:00
*/
function wp_registration_url () {
2014-04-15 00:01:15 -04:00
/**
* Filter the user registration URL .
*
* @ since 3.6 . 0
*
* @ param string $register The user registration URL .
*/
2013-04-22 16:21:22 -04:00
return apply_filters ( 'register_url' , site_url ( 'wp-login.php?action=register' , 'login' ) );
}
2010-01-11 16:48:43 -05:00
/**
2010-06-06 01:16:32 -04:00
* Provides a simple login form for use anywhere within WordPress . By default , it echoes
2010-01-11 16:48:43 -05:00
* the HTML immediately . Pass array ( 'echo' => false ) to return the string instead .
*
2010-01-11 17:33:28 -05:00
* @ since 3.0 . 0
2014-04-15 00:01:15 -04:00
*
2012-09-20 09:52:36 -04:00
* @ param array $args Configuration options to modify the form output .
* @ return string | null String when retrieving , null when displaying .
2010-01-11 16:48:43 -05:00
*/
function wp_login_form ( $args = array () ) {
2013-03-12 06:30:58 -04:00
$defaults = array (
'echo' => true ,
'redirect' => ( is_ssl () ? 'https://' : 'http://' ) . $_SERVER [ 'HTTP_HOST' ] . $_SERVER [ 'REQUEST_URI' ], // Default redirect is back to the current page
'form_id' => 'loginform' ,
'label_username' => __ ( 'Username' ),
'label_password' => __ ( 'Password' ),
'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 ,
'value_username' => '' ,
'value_remember' => false , // Set this to true to default the "Remember me" checkbox to checked
);
2014-04-15 00:01:15 -04:00
/**
* Filter the default login form output arguments .
*
* @ since 3.0 . 0
*
* @ see wp_login_form ()
*
* @ param array $defaults An array of default login form arguments .
*/
2010-01-11 16:48:43 -05:00
$args = wp_parse_args ( $args , apply_filters ( 'login_form_defaults' , $defaults ) );
2010-01-15 17:11:12 -05:00
2014-04-15 00:42:16 -04:00
/**
* Filter content to display at the top of the login form .
*
* The filter evaluates just following the opening form tag element .
*
* @ since 3.0 . 0
*
* @ param string $content Content to display . Default empty .
* @ param array $args Array of login form arguments .
*/
$login_form_top = apply_filters ( 'login_form_top' , '' , $args );
/**
* Filter content to display in the middle of the login form .
*
* The filter evaluates just following the location where the 'login-password'
* field is displayed .
*
* @ since 3.0 . 0
*
* @ param string $content Content to display . Default empty .
* @ param array $args Array of login form arguments .
*/
$login_form_middle = apply_filters ( 'login_form_middle' , '' , $args );
/**
* Filter content to display at the bottom of the login form .
*
* The filter evaluates just preceding the closing form tag element .
*
* @ since 3.0 . 0
*
* @ param string $content Content to display . Default empty .
* @ param array $args Array of login form arguments .
*/
$login_form_bottom = apply_filters ( 'login_form_bottom' , '' , $args );
2010-01-11 16:48:43 -05:00
$form = '
2011-10-20 19:41:07 -04:00
< form name = " ' . $args['form_id'] . ' " id = " ' . $args['form_id'] . ' " action = " ' . esc_url( site_url( 'wp-login.php', 'login_post' ) ) . ' " method = " post " >
2014-04-15 00:42:16 -04:00
' . $login_form_top . '
2010-01-11 16:48:43 -05:00
< p class = " login-username " >
< label for = " ' . esc_attr( $args['id_username'] ) . ' " > ' . esc_html( $args[' label_username '] ) . ' </ label >
2012-07-23 20:15:15 -04:00
< input type = " text " name = " log " id = " ' . esc_attr( $args['id_username'] ) . ' " class = " input " value = " ' . esc_attr( $args['value_username'] ) . ' " size = " 20 " />
2010-01-11 16:48:43 -05:00
</ p >
< p class = " login-password " >
< label for = " ' . esc_attr( $args['id_password'] ) . ' " > ' . esc_html( $args[' label_password '] ) . ' </ label >
2012-07-23 20:15:15 -04:00
< input type = " password " name = " pwd " id = " ' . esc_attr( $args['id_password'] ) . ' " class = " input " value = " " size = " 20 " />
2010-01-11 16:48:43 -05:00
</ p >
2014-04-15 00:42:16 -04:00
' . $login_form_middle . '
2012-07-23 20:15:15 -04:00
' . ( $args[' remember '] ? ' < p class = " login-remember " >< label >< input name = " rememberme " type = " checkbox " id = " ' . esc_attr( $args['id_remember'] ) . ' " value = " forever " ' . ( $args[' value_remember '] ? ' checked = " checked " ' : ' ' ) . ' /> ' . esc_html( $args[' label_remember '] ) . ' </ label ></ p > ' : ' ' ) . '
2010-01-11 16:48:43 -05:00
< p class = " login-submit " >
2012-08-07 19:13:31 -04:00
< input type = " submit " name = " wp-submit " id = " ' . esc_attr( $args['id_submit'] ) . ' " class = " button-primary " value = " ' . esc_attr( $args['label_log_in'] ) . ' " />
2011-10-20 19:41:07 -04:00
< input type = " hidden " name = " redirect_to " value = " ' . esc_url( $args['redirect'] ) . ' " />
2010-01-11 16:48:43 -05:00
</ p >
2014-04-15 00:42:16 -04:00
' . $login_form_bottom . '
2010-01-11 16:48:43 -05:00
</ 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
2014-04-15 00:01:15 -04:00
*
2009-05-24 16:58:22 -04:00
* @ uses site_url () To generate the lost password URL
*
* @ param string $redirect Path to redirect to on login .
2012-09-20 09:52:36 -04:00
* @ return string Lost password URL .
2009-05-24 16:58:22 -04:00
*/
2011-10-20 10:40:11 -04:00
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 ;
}
2011-10-20 10:40:11 -04:00
$lostpassword_url = add_query_arg ( $args , network_site_url ( 'wp-login.php' , 'login' ) );
2014-04-15 00:01:15 -04:00
/**
* Filter the Lost Password URL .
*
* @ since 2.8 . 0
*
* @ param string $lostpassword_url The lost password page URL .
* @ param string $redirect The path to redirect to on login .
*/
2011-10-20 10:40:11 -04:00
return apply_filters ( 'lostpassword_url' , $lostpassword_url , $redirect );
2009-05-24 16:58:22 -04:00
}
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
* @ 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 .
2012-09-20 09:52:36 -04:00
* @ return string | null String when retrieving , null when displaying .
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' ) )
2013-04-22 16:21:22 -04:00
$link = $before . '<a href="' . esc_url ( wp_registration_url () ) . '">' . __ ( '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
2014-04-25 02:24:15 -04:00
/**
* Filter the HTML link to the Registration or Admin page .
*
* Users are sent to the admin page if logged - in , or the registration page
* if enabled and logged - out .
*
* @ since 1.5 . 0
*
* @ param string $link The HTML code for the link to the Registration or Admin page .
*/
$link = apply_filters ( 'register' , $link );
2014-04-15 00:01:15 -04:00
if ( $echo ) {
2014-04-25 02:24:15 -04:00
echo $link ;
2014-04-15 00:01:15 -04:00
} else {
2014-04-25 02:24:15 -04:00
return $link ;
2014-04-15 00:01:15 -04:00
}
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
2014-04-15 00:01:15 -04:00
*
2014-09-29 09:37:16 -04:00
* @ link https :// core . trac . wordpress . org / ticket / 1458 Explanation of 'wp_meta' action .
2008-09-05 15:19:01 -04:00
*/
2004-07-10 19:34:47 -04:00
function wp_meta () {
2014-04-15 00:01:15 -04:00
/**
* Fires before displaying echoed content in the sidebar .
*
* @ since 1.5 . 0
*/
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
*/
2010-02-27 18:22:56 -05:00
function bloginfo ( $show = '' ) {
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 >
2010-09-04 22:45:39 -04:00
* < li >< strong > url </ strong > - Blog URI to homepage .</ li >
2008-09-06 02:38:26 -04:00
* < 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
2010-05-03 01:49:19 -04:00
_deprecated_argument ( __FUNCTION__ , '2.2' , sprintf ( __ ( 'The <code>%s</code> option is deprecated for the family of <code>bloginfo()</code> functions.' ), $show ) . ' ' . sprintf ( __ ( 'Use the <code>%s</code> option instead.' ), 'url' ) );
2009-12-30 12:05:02 -05:00
case 'url' :
2010-01-04 12:23:29 -05:00
$output = home_url ();
2005-10-17 19:41:28 -04:00
break ;
case 'wpurl' :
2010-02-27 18:22:56 -05:00
$output = site_url ();
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' :
2013-10-02 17:15:09 -04:00
$output = site_url ( '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' :
2010-05-03 01:49:19 -04:00
//_deprecated_argument( __FUNCTION__, '2.2', sprintf( __('The <code>%s</code> option is deprecated for the family of <code>bloginfo()</code> functions.' ), $show ) . ' ' . sprintf( __( 'Use the <code>%s</code> function instead.' ), 'is_rtl()' ) );
2010-05-14 17:22:14 -04:00
if ( function_exists ( 'is_rtl' ) ) {
$output = is_rtl () ? 'rtl' : 'ltr' ;
} else {
$output = 'ltr' ;
}
2006-09-24 15:29:32 -04:00
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 ) {
2014-04-15 00:01:15 -04:00
if ( $url ) {
/**
* Filter the URL returned by get_bloginfo () .
*
* @ since 2.0 . 5
*
* @ param mixed $output The URL returned by bloginfo () .
* @ param mixed $show Type of information requested .
*/
$output = apply_filters ( 'bloginfo_url' , $output , $show );
} else {
/**
* Filter the site information returned by get_bloginfo () .
*
* @ since 0.71
*
* @ param mixed $output The requested non - URL site information .
* @ param mixed $show Type of information requested .
*/
$output = apply_filters ( 'bloginfo' , $output , $show );
}
2007-08-31 19:55:56 -04:00
}
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 = '' ) {
2014-05-22 13:37:14 -04:00
global $wp_locale ;
2005-10-17 19:41:28 -04:00
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
2010-09-08 12:21:13 -04:00
// If there is a post
if ( is_single () || ( is_home () && ! is_front_page () ) || ( is_page () && ! is_front_page () ) ) {
$title = single_post_title ( '' , false );
2005-10-17 19:41:28 -04:00
}
2013-09-06 18:07:09 -04:00
// If there's a post type archive
if ( is_post_type_archive () ) {
2013-09-09 23:02:10 -04:00
$post_type = get_query_var ( 'post_type' );
if ( is_array ( $post_type ) )
$post_type = reset ( $post_type );
$post_type_object = get_post_type_object ( $post_type );
2013-09-06 18:07:09 -04:00
if ( ! $post_type_object -> has_archive )
$title = post_type_archive_title ( '' , false );
}
2010-09-08 12:21:13 -04:00
// If there's a category or tag
if ( is_category () || is_tag () ) {
$title = single_term_title ( '' , false );
2007-05-22 23:57:20 -04:00
}
2010-09-08 12:21:13 -04:00
// If there's a taxonomy
if ( is_tax () ) {
2010-11-15 05:51:39 -05:00
$term = get_queried_object ();
2013-09-09 22:28:11 -04:00
if ( $term ) {
$tax = get_taxonomy ( $term -> taxonomy );
$title = single_term_title ( $tax -> labels -> name . $t_sep , false );
}
2005-11-10 19:48:31 -05:00
}
2010-09-08 12:21:13 -04:00
// If there's an author
2014-05-04 18:21:22 -04:00
if ( is_author () && ! is_post_type_archive () ) {
2010-10-31 07:02:17 -04:00
$author = get_queried_object ();
2013-09-09 22:28:11 -04:00
if ( $author )
$title = $author -> display_name ;
2005-11-10 19:48:31 -05:00
}
2013-09-06 18:07:09 -04:00
// Post type archives with has_archive should override terms.
if ( is_post_type_archive () && $post_type_object -> has_archive )
2010-10-15 15:44:57 -04:00
$title = post_type_archive_title ( '' , false );
2005-10-17 19:41:28 -04:00
// If there's a month
2010-09-08 12:21:13 -04:00
if ( is_archive () && ! empty ( $m ) ) {
2005-10-17 19:41:28 -04:00
$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 ));
2011-05-22 18:30:05 -04:00
$title = $my_year . ( $my_month ? $t_sep . $my_month : '' ) . ( $my_day ? $t_sep . $my_day : '' );
2005-10-17 19:41:28 -04:00
}
2010-09-08 12:21:13 -04:00
// If there's a year
if ( is_archive () && ! empty ( $year ) ) {
2005-10-17 19:41:28 -04:00
$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
}
2010-09-08 12:21:13 -04:00
// If it's a search
2009-02-27 12:46:13 -05:00
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
2010-09-08 12:21:13 -04:00
// If it's a 404 page
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 " ;
2014-06-04 20:28:15 -04:00
/**
* Filter the parts of the page title .
*
* @ since 4.0 . 0
*
* @ param array $title_array Parts of the page title .
*/
$title_array = apply_filters ( 'wp_title_parts' , explode ( $t_sep , $title ) );
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 = array_reverse ( $title_array );
$title = implode ( " $sep " , $title_array ) . $prefix ;
} else {
$title = $prefix . implode ( " $sep " , $title_array );
}
2008-02-05 01:47:27 -05:00
2014-04-15 00:01:15 -04:00
/**
* Filter the text of the page title .
*
* @ since 2.0 . 0
*
* @ param string $title Page title .
* @ param string $sep Title separator .
* @ param string $seplocation Location of the separator ( left or right ) .
*/
$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 .
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
*
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-12-30 16:10:45 -05:00
$_post = get_queried_object ();
2010-02-28 08:00:27 -05:00
if ( ! isset ( $_post -> post_title ) )
return ;
2014-04-15 00:01:15 -04:00
/**
* Filter the page title for a single post .
*
* @ since 0.71
*
* @ param string $_post_title The single post page title .
* @ param object $_post The current queried object as returned by get_queried_object () .
*/
$title = apply_filters ( 'single_post_title' , $_post -> post_title , $_post );
2010-02-14 02:38:00 -05:00
if ( $display )
2010-02-27 13:57:04 -05:00
echo $prefix . $title ;
2010-02-14 02:38:00 -05:00
else
2013-08-16 16:54:10 -04:00
return $prefix . $title ;
2004-01-27 04:58:01 -05:00
}
2010-10-15 15:44:57 -04:00
/**
* Display or retrieve title for a post type archive .
*
* This is optimized for archive . php and archive - { $post_type } . php template files
* for displaying the title of the post type .
*
* @ since 3.1 . 0
*
* @ 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 .
*/
2010-11-05 17:14:43 -04:00
function post_type_archive_title ( $prefix = '' , $display = true ) {
2010-10-15 15:44:57 -04:00
if ( ! is_post_type_archive () )
return ;
2013-09-09 23:02:10 -04:00
$post_type = get_query_var ( 'post_type' );
if ( is_array ( $post_type ) )
$post_type = reset ( $post_type );
$post_type_obj = get_post_type_object ( $post_type );
2014-04-15 00:01:15 -04:00
2013-11-28 00:24:09 -05:00
/**
* Filter the post type archive title .
*
* @ since 3.1 . 0
*
* @ param string $post_type_name Post type 'name' label .
* @ param string $post_type Post type .
*/
$title = apply_filters ( 'post_type_archive_title' , $post_type_obj -> labels -> name , $post_type );
2010-10-15 15:44:57 -04:00
if ( $display )
echo $prefix . $title ;
else
2013-08-16 16:54:10 -04:00
return $prefix . $title ;
2010-10-15 15:44:57 -04:00
}
2010-10-19 03:48:22 -04: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
*/
2010-09-08 12:21:13 -04:00
function single_cat_title ( $prefix = '' , $display = true ) {
return single_term_title ( $prefix , $display );
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
*/
2010-09-08 12:21:13 -04:00
function single_tag_title ( $prefix = '' , $display = true ) {
return single_term_title ( $prefix , $display );
}
/**
* Display or retrieve page title for taxonomy term archive .
*
* Useful for taxonomy term template files for displaying the taxonomy term page title .
* It has less overhead than { @ link wp_title ()}, because of its limited implementation .
*
* 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 .
*
* @ since 3.1 . 0
*
* @ 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 .
*/
function single_term_title ( $prefix = '' , $display = true ) {
2010-10-31 07:02:17 -04:00
$term = get_queried_object ();
2010-09-08 12:21:13 -04:00
if ( ! $term )
2007-09-11 14:06:52 -04:00
return ;
2014-04-15 00:01:15 -04:00
if ( is_category () ) {
/**
* Filter the category archive page title .
*
* @ since 2.0 . 10
*
* @ param string $term_name Category name for archive being displayed .
*/
2010-09-08 12:21:13 -04:00
$term_name = apply_filters ( 'single_cat_title' , $term -> name );
2014-04-15 00:01:15 -04:00
} elseif ( is_tag () ) {
/**
* Filter the tag archive page title .
*
* @ since 2.3 . 0
*
* @ param string $term_name Tag name for archive being displayed .
*/
2010-09-08 12:21:13 -04:00
$term_name = apply_filters ( 'single_tag_title' , $term -> name );
2014-04-15 00:01:15 -04:00
} elseif ( is_tax () ) {
/**
* Filter the custom taxonomy archive page title .
*
* @ since 3.1 . 0
*
* @ param string $term_name Term name for archive being displayed .
*/
2010-09-08 12:21:13 -04:00
$term_name = apply_filters ( 'single_term_title' , $term -> name );
2014-04-15 00:01:15 -04:00
} else {
2010-09-08 12:21:13 -04:00
return ;
2014-04-15 00:01:15 -04:00
}
2010-02-20 19:03:42 -05:00
2010-09-08 12:21:13 -04:00
if ( empty ( $term_name ) )
2010-02-19 05:45:29 -05:00
return ;
2010-02-14 02:38:00 -05:00
2010-09-08 12:21:13 -04:00
if ( $display )
echo $prefix . $term_name ;
2010-12-21 19:04:53 -05:00
else
2013-08-16 16:54:10 -04:00
return $prefix . $term_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
*
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-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 )
2013-10-02 18:51:10 -04:00
$link_html = " \t <link rel='archives' title=' " . esc_attr ( $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 )
2013-10-02 18:51:10 -04:00
$link_html = " \t <li> $before <a href=' $url '> $text </a> $after </li> \n " ;
2005-10-17 19:41:28 -04:00
else // custom
2013-10-02 18:51:10 -04:00
$link_html = " \t $before <a href=' $url '> $text </a> $after\n " ;
2008-05-20 12:43:44 -04:00
2014-04-15 00:01:15 -04:00
/**
* Filter the archive link content .
*
* @ since 2.6 . 0
*
* @ param string $link_html The archive HTML link content .
*/
2011-05-22 18:30:05 -04:00
$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 .
*
2008-09-05 15:19:01 -04:00
* @ since 1.2 . 0
*
2014-05-18 13:20:15 -04:00
* @ see get_archives_link ()
*
* @ param string | array $args {
* Default archive links arguments . Optional .
*
* @ type string $type Type of archive to retrieve . Accepts 'daily' , 'weekly' , 'monthly' ,
* 'yearly' , 'postbypost' , or 'alpha' . Both 'postbypost' and 'alpha'
* display the same archive link list as well as post titles instead
* of displaying dates . The difference between the two is that 'alpha'
* will order by post title and 'postbypost' will order by post date .
* Default 'monthly' .
* @ type string | int $limit Number of links to limit the query to . Default empty ( no limit ) .
* @ type string $format Format each link should take using the $before and $after args .
* Accepts 'link' ( `<link>` tag ), 'option' ( `<option>` tag ), 'html'
* ( `<li>` tag ), or a custom format , which generates a link anchor
* with $before preceding and $after succeeding . Default 'html' .
* @ type string $before Markup to prepend to the beginning of each link . Default empty .
* @ type string $after Markup to append to the end of each link . Default empty .
* @ type bool $show_post_count Whether to display the post count alongside the link . Default false .
* @ type bool $echo Whether to echo or return the links list . Default 1 | true to echo .
* @ type string $order Whether to use ascending or descending order . Accepts 'ASC' , or 'DESC' .
* Default 'DESC' .
* }
2012-09-20 09:52:36 -04:00
* @ return string | null String when retrieving , null when displaying .
2008-09-05 15:19:01 -04:00
*/
2014-05-13 00:29:26 -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 ,
2012-08-24 16:50:22 -04:00
'echo' => 1 , 'order' => 'DESC' ,
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 );
2005-10-17 19:41:28 -04:00
2014-05-13 00:29:26 -04:00
if ( '' == $r [ 'type' ] ) {
$r [ 'type' ] = 'monthly' ;
}
2005-10-17 19:41:28 -04:00
2014-05-23 14:28:14 -04:00
if ( ! empty ( $r [ 'limit' ] ) ) {
2014-05-13 00:29:26 -04:00
$r [ 'limit' ] = absint ( $r [ 'limit' ] );
$r [ 'limit' ] = ' LIMIT ' . $r [ 'limit' ];
2005-10-17 19:41:28 -04:00
}
2006-06-15 16:28:47 -04:00
2014-05-13 00:29:26 -04:00
$order = strtoupper ( $r [ 'order' ] );
if ( $order !== 'ASC' ) {
2012-08-24 16:50:22 -04:00
$order = 'DESC' ;
2014-05-13 00:29:26 -04:00
}
2012-08-24 16:50:22 -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' ;
2014-05-13 00:29:26 -04:00
if ( ! $archive_date_format_over_ride ) {
$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
}
2014-04-15 00:01:15 -04:00
/**
* Filter the SQL WHERE clause for retrieving archives .
*
* @ since 2.2 . 0
*
* @ param string $sql_where Portion of SQL query containing the WHERE clause .
* @ param array $r An array of default arguments .
*/
2011-05-22 18:30:05 -04:00
$where = apply_filters ( 'getarchives_where' , " WHERE post_type = 'post' AND post_status = 'publish' " , $r );
2014-04-15 00:01:15 -04:00
/**
* Filter the SQL JOIN clause for retrieving archives .
*
* @ since 2.2 . 0
*
* @ param string $sql_join Portion of SQL query containing JOIN clause .
* @ param array $r An array of default arguments .
*/
2011-05-22 18:30:05 -04:00
$join = apply_filters ( 'getarchives_join' , '' , $r );
2007-03-08 23:09:24 -05:00
2008-10-24 16:47:12 -04:00
$output = '' ;
2013-02-04 08:54:15 -05:00
$last_changed = wp_cache_get ( 'last_changed' , 'posts' );
if ( ! $last_changed ) {
2014-02-26 17:05:13 -05:00
$last_changed = microtime ();
2013-02-04 08:54:15 -05:00
wp_cache_set ( 'last_changed' , $last_changed , 'posts' );
}
2014-05-13 00:29:26 -04:00
$limit = $r [ 'limit' ];
if ( 'monthly' == $r [ 'type' ] ) {
2012-08-24 16:50:22 -04: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 $order $limit " ;
2013-02-04 08:54:15 -05:00
$key = md5 ( $query );
$key = " wp_get_archives: $key : $last_changed " ;
if ( ! $results = wp_cache_get ( $key , 'posts' ) ) {
$results = $wpdb -> get_results ( $query );
wp_cache_set ( $key , $results , 'posts' );
2007-10-30 02:03:11 -04:00
}
2013-02-04 08:54:15 -05:00
if ( $results ) {
2014-05-13 00:29:26 -04:00
$after = $r [ 'after' ];
2013-02-04 08:54:15 -05:00
foreach ( ( array ) $results as $result ) {
$url = get_month_link ( $result -> year , $result -> month );
2009-11-17 15:54:38 -05:00
/* translators: 1: month name, 2: 4-digit year */
2014-05-13 00:29:26 -04:00
$text = sprintf ( __ ( '%1$s %2$d' ), $wp_locale -> get_month ( $result -> month ), $result -> year );
if ( $r [ 'show_post_count' ] ) {
2014-05-22 13:35:13 -04:00
$r [ 'after' ] = ' (' . $result -> posts . ')' . $after ;
2014-05-13 00:29:26 -04:00
}
2014-05-22 13:35:13 -04:00
$output .= get_archives_link ( $url , $text , $r [ 'format' ], $r [ 'before' ], $r [ 'after' ] );
2005-10-17 19:41:28 -04:00
}
}
2014-05-13 00:29:26 -04:00
} elseif ( 'yearly' == $r [ 'type' ] ) {
2012-08-24 16:50:22 -04: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 $order $limit " ;
2013-02-04 08:54:15 -05:00
$key = md5 ( $query );
$key = " wp_get_archives: $key : $last_changed " ;
if ( ! $results = wp_cache_get ( $key , 'posts' ) ) {
$results = $wpdb -> get_results ( $query );
wp_cache_set ( $key , $results , 'posts' );
2007-10-30 02:03:11 -04:00
}
2013-02-04 08:54:15 -05:00
if ( $results ) {
2014-05-13 00:29:26 -04:00
$after = $r [ 'after' ];
2013-02-04 08:54:15 -05:00
foreach ( ( array ) $results as $result ) {
2014-05-13 00:29:26 -04:00
$url = get_year_link ( $result -> year );
$text = sprintf ( '%d' , $result -> year );
if ( $r [ 'show_post_count' ] ) {
2014-05-22 13:35:13 -04:00
$r [ 'after' ] = ' (' . $result -> posts . ')' . $after ;
2014-05-13 00:29:26 -04:00
}
2014-05-22 13:35:13 -04:00
$output .= get_archives_link ( $url , $text , $r [ 'format' ], $r [ 'before' ], $r [ 'after' ] );
2007-02-27 10:24:54 -05:00
}
}
2014-05-13 00:29:26 -04:00
} elseif ( 'daily' == $r [ 'type' ] ) {
2012-08-24 16:50:22 -04: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 $order $limit " ;
2013-02-04 08:54:15 -05:00
$key = md5 ( $query );
$key = " wp_get_archives: $key : $last_changed " ;
if ( ! $results = wp_cache_get ( $key , 'posts' ) ) {
$results = $wpdb -> get_results ( $query );
$cache [ $key ] = $results ;
wp_cache_set ( $key , $results , 'posts' );
2007-10-30 02:03:11 -04:00
}
2013-02-04 08:54:15 -05:00
if ( $results ) {
2014-05-13 00:29:26 -04:00
$after = $r [ 'after' ];
2013-02-04 08:54:15 -05:00
foreach ( ( array ) $results as $result ) {
2014-05-22 13:35:13 -04:00
$url = get_day_link ( $result -> year , $result -> month , $result -> dayofmonth );
2014-05-13 00:29:26 -04:00
$date = sprintf ( '%1$d-%2$02d-%3$02d 00:00:00' , $result -> year , $result -> month , $result -> dayofmonth );
$text = mysql2date ( $archive_day_date_format , $date );
if ( $r [ 'show_post_count' ] ) {
2014-05-22 13:35:13 -04:00
$r [ 'after' ] = ' (' . $result -> posts . ')' . $after ;
2014-05-13 00:29:26 -04:00
}
2014-05-22 13:40:14 -04:00
$output .= get_archives_link ( $url , $text , $r [ 'format' ], $r [ 'before' ], $r [ 'after' ] );
2005-10-17 19:41:28 -04:00
}
}
2014-05-13 00:29:26 -04:00
} elseif ( 'weekly' == $r [ 'type' ] ) {
2010-05-07 01:01:29 -04:00
$week = _wp_mysql_week ( '`post_date`' );
2012-08-24 16:50:22 -04:00
$query = " SELECT DISTINCT $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 , YEAR( `post_date` ) ORDER BY `post_date` $order $limit " ;
2013-02-04 08:54:15 -05:00
$key = md5 ( $query );
$key = " wp_get_archives: $key : $last_changed " ;
if ( ! $results = wp_cache_get ( $key , 'posts' ) ) {
$results = $wpdb -> get_results ( $query );
wp_cache_set ( $key , $results , 'posts' );
2007-10-30 02:03:11 -04:00
}
2005-10-17 19:41:28 -04:00
$arc_w_last = '' ;
2013-02-04 08:54:15 -05:00
if ( $results ) {
2014-05-22 13:35:13 -04:00
$after = $r [ 'after' ];
foreach ( ( array ) $results as $result ) {
if ( $result -> week != $arc_w_last ) {
$arc_year = $result -> yr ;
$arc_w_last = $result -> week ;
$arc_week = get_weekstartend ( $result -> yyyymmdd , get_option ( 'start_of_week' ) );
$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' ] );
$url = sprintf ( '%1$s/%2$s%3$sm%4$s%5$s%6$sw%7$s%8$d' , home_url (), '' , '?' , '=' , $arc_year , '&' , '=' , $result -> week );
$text = $arc_week_start . $archive_week_separator . $arc_week_end ;
if ( $r [ 'show_post_count' ] ) {
$r [ 'after' ] = ' (' . $result -> posts . ')' . $after ;
2005-10-17 19:41:28 -04:00
}
2014-05-22 13:35:13 -04:00
$output .= get_archives_link ( $url , $text , $r [ 'format' ], $r [ 'before' ], $r [ 'after' ] );
2005-10-17 19:41:28 -04:00
}
2014-05-22 13:35:13 -04:00
}
2005-10-17 19:41:28 -04:00
}
2014-05-13 00:29:26 -04:00
} elseif ( ( 'postbypost' == $r [ 'type' ] ) || ( 'alpha' == $r [ 'type' ] ) ) {
$orderby = ( 'alpha' == $r [ '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 " ;
2013-02-04 08:54:15 -05:00
$key = md5 ( $query );
$key = " wp_get_archives: $key : $last_changed " ;
if ( ! $results = wp_cache_get ( $key , 'posts' ) ) {
$results = $wpdb -> get_results ( $query );
wp_cache_set ( $key , $results , 'posts' );
2007-10-30 02:03:11 -04:00
}
2013-02-04 08:54:15 -05:00
if ( $results ) {
foreach ( ( array ) $results as $result ) {
if ( $result -> post_date != '0000-00-00 00:00:00' ) {
2014-05-22 13:35:13 -04:00
$url = get_permalink ( $result );
2013-10-24 18:59:20 -04:00
if ( $result -> post_title ) {
/** This filter is documented in wp-includes/post-template.php */
2013-02-04 08:54:15 -05:00
$text = strip_tags ( apply_filters ( 'the_title' , $result -> post_title , $result -> ID ) );
2013-10-24 18:59:20 -04:00
} else {
2013-02-04 08:54:15 -05:00
$text = $result -> ID ;
2013-10-24 18:59:20 -04:00
}
2014-05-13 00:29:26 -04:00
$output .= get_archives_link ( $url , $text , $r [ 'format' ], $r [ 'before' ], $r [ 'after' ] );
2005-10-17 19:41:28 -04:00
}
}
}
}
2014-05-13 00:29:26 -04:00
if ( $r [ 'echo' ] ) {
2008-10-24 16:47:12 -04:00
echo $output ;
2014-05-13 00:29:26 -04:00
} else {
2008-12-09 13:03:31 -05:00
return $output ;
2014-05-13 00:29:26 -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
* Get number of days since the start of the week .
2008-09-05 15:19:01 -04:00
*
* @ since 1.5 . 0
*
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
2012-07-09 01:03:53 -04:00
* @ uses calendar_week_mod ()
2008-09-05 15:19:01 -04:00
*
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 .
2012-09-20 09:52:36 -04:00
* @ return string | null String when retrieving , null when displaying .
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
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-04-21 17:35:39 -04:00
if ( $echo ) {
2014-04-15 00:01:15 -04:00
/** This filter is documented in wp-includes/general-template.php */
echo apply_filters ( 'get_calendar' , $cache [ $key ] );
2010-04-21 17:35:39 -04:00
return ;
} else {
2014-04-15 00:01:15 -04:00
/** This filter is documented in wp-includes/general-template.php */
return apply_filters ( 'get_calendar' , $cache [ $key ] );
2010-04-21 17:35:39 -04:00
}
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
2010-11-14 10:50:02 -05:00
$thismonth = $wpdb -> get_var ( " SELECT DATE_FORMAT((DATE_ADD(' { $thisyear } 0101', INTERVAL $d DAY) ), '%m') " );
2005-10-17 19:41:28 -04:00
} 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 );
2010-09-07 00:22:56 -04:00
$last_day = date ( 't' , $unixmonth );
2005-10-17 19:41:28 -04:00
// Get the next and previous month and year with at least one post
2010-09-07 00:22:56 -04:00
$previous = $wpdb -> get_row ( " SELECT 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 " );
2010-09-07 00:22:56 -04:00
$next = $wpdb -> get_row ( " SELECT MONTH(post_date) AS month, YEAR(post_date) AS year
2005-10-17 19:41:28 -04:00
FROM $wpdb -> posts
2010-09-07 00:22:56 -04:00
WHERE post_date > '$thisyear-$thismonth-{$last_day} 23:59:59'
2006-11-24 17:55:28 -05:00
AND post_type = 'post' AND post_status = 'publish'
2010-09-07 00:22:56 -04:00
ORDER BY post_date ASC
2005-10-17 19:41:28 -04:00
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' );
2011-06-02 16:43:31 -04:00
$calendar_output = ' < table id = " wp-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 ) {
2014-07-19 00:41:15 -04:00
$calendar_output .= " \n \t \t " . '<td colspan="3" id="prev"><a href="' . get_month_link ( $previous -> year , $previous -> month ) . '">« ' . $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 ) {
2014-07-19 00:41:15 -04:00
$calendar_output .= " \n \t \t " . '<td colspan="3" id="next"><a href="' . get_month_link ( $next -> year , $next -> month ) . '">' . $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)
2010-09-07 00:22:56 -04:00
FROM $wpdb -> posts WHERE post_date >= '{$thisyear}-{$thismonth}-01 00:00:00'
2006-02-09 05:03:48 -05:00
AND post_type = 'post' AND post_status = 'publish'
2010-09-07 00:22:56 -04:00
AND post_date <= '{$thisyear}-{$thismonth}-{$last_day} 23:59:59' " , ARRAY_N);
2005-10-17 19:41:28 -04:00
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 ();
2010-05-26 17:30:00 -04:00
$ak_post_titles = $wpdb -> get_results ( " SELECT ID, post_title, DAYOFMONTH(post_date) as dom "
2005-10-17 19:41:28 -04:00
. " FROM $wpdb->posts "
2010-09-07 00:22:56 -04:00
. " WHERE post_date >= ' { $thisyear } - { $thismonth } -01 00:00:00' "
. " AND post_date <= ' { $thisyear } - { $thismonth } - { $last_day } 23:59:59' "
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
2013-10-24 18:59:20 -04:00
/** This filter is documented in wp-includes/post-template.php */
2010-05-26 17:30:00 -04:00
$post_title = esc_attr ( apply_filters ( 'the_title' , $ak_post_title -> post_title , $ak_post_title -> ID ) );
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?
2011-05-22 18:30:05 -04: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
2014-04-15 00:01:15 -04:00
if ( $echo ) {
/**
* Filter the HTML calendar output .
*
* @ since 3.0 . 0
*
* @ param string $calendar_output HTML output of the calendar .
*/
echo apply_filters ( 'get_calendar' , $calendar_output );
} else {
/** This filter is documented in wp-includes/general-template.php */
return apply_filters ( 'get_calendar' , $calendar_output );
}
2010-02-10 13:37:14 -05:00
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 () {
2012-09-04 12:29:28 -04:00
echo mysql2date ( 'Y-m-d' , get_post () -> post_date , false );
2004-01-27 04:58:01 -05:00
}
2008-09-05 15:19:01 -04:00
/**
2014-02-21 17:49:13 -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-09-04 22:45:39 -04:00
*
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
2014-04-15 00:01:15 -04:00
*
2010-02-01 11:28:54 -05:00
* @ 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 ) {
2010-11-11 11:22:18 -05:00
global $currentday , $previousday ;
2014-02-21 17:38:13 -05:00
2010-11-11 11:22:18 -05:00
if ( $currentday != $previousday ) {
2014-02-21 17:38:13 -05:00
$the_date = $before . get_the_date ( $d ) . $after ;
2010-11-11 11:22:18 -05:00
$previousday = $currentday ;
2008-12-14 07:13:30 -05:00
2014-04-15 00:01:15 -04:00
/**
* Filter the date a post was published for display .
*
* @ since 0.71
*
* @ param string $the_date The formatted date string .
* @ param string $d PHP date format . Defaults to 'date_format' option
* if not specified .
* @ param string $before HTML output before the date .
* @ param string $after HTML output after the date .
*/
2014-02-21 17:38:13 -05:00
$the_date = apply_filters ( 'the_date' , $the_date , $d , $before , $after );
2010-02-01 11:28:54 -05:00
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 ;
}
/**
2014-03-03 13:00:14 -05:00
* Retrieve the date on which the post was written .
2010-02-01 11:28:54 -05:00
*
* Unlike the_date () this function will always return the date .
* Modify output with 'get_the_date' filter .
*
* @ since 3.0 . 0
*
2014-03-03 13:00:14 -05:00
* @ param string $d Optional . PHP date format defaults to the date_format option if not specified .
* @ param int | WP_Post $post Optional . Post ID or WP_Post object . Default current post .
2014-08-01 14:40:16 -04:00
* @ return string | bool Date the current post was written . False on failure .
2010-02-01 11:28:54 -05:00
*/
2014-03-03 13:00:14 -05:00
function get_the_date ( $d = '' , $post = null ) {
$post = get_post ( $post );
2010-02-01 11:28:54 -05:00
2014-08-01 14:40:16 -04:00
if ( ! $post ) {
return false ;
}
2014-03-03 13:00:14 -05:00
if ( '' == $d ) {
2014-02-21 17:38:13 -05:00
$the_date = mysql2date ( get_option ( 'date_format' ), $post -> post_date );
2014-03-03 13:00:14 -05:00
} else {
2014-02-21 17:38:13 -05:00
$the_date = mysql2date ( $d , $post -> post_date );
2014-03-03 13:00:14 -05:00
}
2010-02-01 11:28:54 -05:00
2014-03-03 13:00:14 -05:00
/**
2014-04-15 00:01:15 -04:00
* Filter the date a post was published .
2014-03-03 13:00:14 -05:00
*
* @ since 3.0 . 0
*
* @ param string $the_date The formatted date .
2014-04-15 00:01:15 -04:00
* @ param string $d PHP date format . Defaults to 'date_format' option
* if not specified .
* @ param int | WP_Post $post The post object or ID .
2014-03-03 13:00:14 -05:00
*/
return apply_filters ( 'get_the_date' , $the_date , $d , $post );
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 ;
2014-04-15 00:01:15 -04:00
/**
* Filter the date a post was last modified for display .
*
* @ since 2.1 . 0
*
* @ param string $the_modified_date The last modified date .
* @ param string $d PHP date format . Defaults to 'date_format' option
* if not specified .
* @ param string $before HTML output before the date .
* @ param string $after HTML output after the date .
*/
$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 );
2014-04-15 00:01:15 -04:00
/**
* Filter the date a post was last modified .
*
* @ since 2.1 . 0
*
* @ param string $the_time The formatted date .
* @ param string $d PHP date format . Defaults to value specified in
* 'date_format' option .
*/
return apply_filters ( 'get_the_modified_date' , $the_time , $d );
2006-08-30 12:46:08 -04: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 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 = '' ) {
2014-04-15 00:01:15 -04:00
/**
* Filter the time a post was written for display .
*
* @ since 0.71
*
* @ param string $get_the_time The formatted time .
* @ param string $d The time format . Accepts 'G' , 'U' ,
* or php date format .
*/
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
*
2014-02-09 16:03:13 -05:00
* @ param string $d Optional . Format to use for retrieving the time the post
* was written . Either 'G' , 'U' , or php date format defaults
* to the value specified in the time_format option . Default empty .
* @ param int | WP_Post $post WP_Post object or ID . Default is global $post object .
2014-08-01 14:40:16 -04:00
* @ return string | int | bool Formatted date string or Unix timestamp . False on failure .
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 );
2014-08-01 14:40:16 -04:00
if ( ! $post ) {
return false ;
}
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 );
2014-04-15 00:01:15 -04:00
/**
* Filter the time a post was written .
*
* @ since 1.5 . 0
*
* @ param string $the_time The formatted time .
* @ param string $d Format to use for retrieving the time the post was written .
* Accepts 'G' , 'U' , or php date format value specified
* in 'time_format' option . Default empty .
* @ param int | WP_Post $post WP_Post object or ID .
*/
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
*
2014-02-09 16:03:13 -05:00
* @ param string $d Optional . Format to use for retrieving the time the post
* was written . Either 'G' , 'U' , or php date format . Default 'U' .
* @ param bool $gmt Optional . Whether to retrieve the GMT time . Default false .
* @ param int | WP_Post $post WP_Post object or ID . Default is global $post object .
* @ param bool $translate Whether to translate the time string . Default false .
2014-08-01 14:40:16 -04:00
* @ return string | int | bool Formatted date string or Unix timestamp . False on failure .
2008-09-05 15:19:01 -04:00
*/
2014-02-09 16:03:13 -05:00
function get_post_time ( $d = 'U' , $gmt = false , $post = null , $translate = false ) {
2008-11-02 16:05:38 -05:00
$post = get_post ( $post );
2014-08-01 14:40:16 -04:00
if ( ! $post ) {
return false ;
}
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 );
2014-04-15 00:01:15 -04:00
/**
* Filter the localized time a post was written .
*
* @ since 2.6 . 0
*
* @ param string $time The formatted time .
* @ param string $d Format to use for retrieving the time the post was written .
* Accepts 'G' , 'U' , or php date format . Default 'U' .
* @ param bool $gmt Whether to retrieve the GMT time . Default false .
*/
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 = '' ) {
2014-04-15 00:01:15 -04:00
/**
* Filter the localized time a post was last modified , for display .
*
* @ since 2.0 . 0
*
* @ param string $get_the_modified_time The formatted time .
* @ param string $d The time format . Accepts 'G' , 'U' ,
* or php date format . Defaults to value
* specified in 'time_format' option .
*/
echo apply_filters ( 'the_modified_time' , get_the_modified_time ( $d ), $d );
2005-11-10 18:31:30 -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 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 );
2014-04-15 00:01:15 -04:00
/**
* Filter the localized time a post was last modified .
*
* @ since 2.0 . 0
*
* @ param string $the_time The formatted time .
* @ param string $d Format to use for retrieving the time the post was
* written . Accepts 'G' , 'U' , or php date format . Defaults
* to value specified in 'time_format' option .
*/
return apply_filters ( 'get_the_modified_time' , $the_time , $d );
2005-11-10 18:31:30 -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 last modified .
2008-09-05 15:19:01 -04:00
*
* @ since 2.0 . 0
*
2014-08-01 14:40:16 -04:00
* @ param string $d Optional . Format to use for retrieving the time the post
* was modified . Either 'G' , 'U' , or php date format . Default 'U' .
* @ param bool $gmt Optional . Whether to retrieve the GMT time . Default false .
* @ param int | WP_Post $post WP_Post object or ID . Default is global $post object .
* @ param bool $translate Whether to translate the time string . Default false .
* @ return string | int | bool Formatted date string or Unix timestamp . False on failure .
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
2014-08-01 14:40:16 -04:00
if ( ! $post ) {
return false ;
}
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
2014-04-15 00:01:15 -04:00
/**
* Filter the localized time a post was last modified .
*
* @ since 2.8 . 0
*
* @ param string $time The formatted time .
* @ param string $d The date format . Accepts 'G' , 'U' , or php date format . Default 'U' .
* @ param bool $gmt Whether to return the GMT time . Default false .
*/
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 () {
2012-09-04 12:29:28 -04:00
global $wp_locale ;
$the_weekday = $wp_locale -> get_weekday ( mysql2date ( 'w' , get_post () -> post_date , false ) );
2014-04-15 00:01:15 -04:00
/**
* Filter the weekday on which the post was written , for display .
*
* @ since 0.71
*
2014-05-04 18:21:22 -04:00
* @ param string $the_weekday
2014-04-15 00:01:15 -04:00
*/
$the_weekday = apply_filters ( 'the_weekday' , $the_weekday );
2005-10-17 19:41:28 -04:00
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 .
2010-06-29 20:05:18 -04:00
*/
2004-01-27 04:58:01 -05:00
function the_weekday_date ( $before = '' , $after = '' ) {
2013-05-07 12:35:03 -04:00
global $wp_locale , $currentday , $previousweekday ;
2005-10-17 19:41:28 -04:00
$the_weekday_date = '' ;
2010-11-11 11:22:18 -05:00
if ( $currentday != $previousweekday ) {
2005-10-17 19:41:28 -04:00
$the_weekday_date .= $before ;
2012-09-04 12:29:28 -04:00
$the_weekday_date .= $wp_locale -> get_weekday ( mysql2date ( 'w' , get_post () -> post_date , false ) );
2005-10-17 19:41:28 -04:00
$the_weekday_date .= $after ;
2010-11-11 11:22:18 -05:00
$previousweekday = $currentday ;
2005-10-17 19:41:28 -04:00
}
2014-04-15 00:01:15 -04:00
/**
* Filter the localized date on which the post was written , for display .
*
* @ since 0.71
*
2014-05-04 18:21:22 -04:00
* @ param string $the_weekday_date
2014-04-15 00:01:15 -04:00
* @ param string $before The HTML to output before the date .
* @ param string $after The HTML to output after the date .
*/
$the_weekday_date = apply_filters ( 'the_weekday_date' , $the_weekday_date , $before , $after );
2005-10-17 19:41:28 -04:00
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
*/
2006-06-07 19:17:59 -04:00
function wp_head () {
2014-04-15 00:01:15 -04:00
/**
* Print scripts or data in the head tag on the front end .
*
* @ since 1.5 . 0
*/
do_action ( 'wp_head' );
2006-06-07 19:17:59 -04:00
}
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
*/
2006-06-07 19:17:59 -04:00
function wp_footer () {
2014-04-15 00:01:15 -04:00
/**
* Print scripts or data before the closing body tag on the front end .
*
* @ since 1.5 . 1
*/
do_action ( 'wp_footer' );
2006-06-07 19:17:59 -04:00
}
2009-01-19 00:04:58 -05:00
/**
* 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 () ) {
2010-02-25 03:56:19 -05:00
if ( ! current_theme_supports ( 'automatic-feed-links' ) )
return ;
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' ),
2013-03-15 12:20:15 -04:00
/* translators: 1: blog title, 2: separator (raquo) */
2009-06-02 03:21:42 -04:00
'comstitle' => __ ( '%1$s %2$s Comments Feed' ),
2009-01-19 00:04:58 -05:00
);
$args = wp_parse_args ( $args , $defaults );
2013-09-02 06:11:09 -04:00
echo '<link rel="alternate" type="' . feed_content_type () . '" title="' . esc_attr ( sprintf ( $args [ 'feedtitle' ], get_bloginfo ( 'name' ), $args [ 'separator' ] ) ) . '" href="' . esc_url ( get_feed_link () ) . " \" /> \n " ;
echo '<link rel="alternate" type="' . feed_content_type () . '" title="' . esc_attr ( sprintf ( $args [ 'comstitle' ], get_bloginfo ( 'name' ), $args [ 'separator' ] ) ) . '" href="' . esc_url ( 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' ),
2012-11-17 10:11:29 -05:00
/* translators: 1: blog name, 2: separator(raquo), 3: post type name */
'posttypetitle' => __ ( '%1$s %2$s %3$s Feed' ),
2009-01-19 00:04:58 -05:00
);
$args = wp_parse_args ( $args , $defaults );
2013-09-06 18:07:09 -04:00
if ( is_singular () ) {
2011-10-31 15:38:46 -04:00
$id = 0 ;
2012-08-23 16:01:10 -04:00
$post = get_post ( $id );
2009-01-19 00:04:58 -05:00
2009-03-07 16:34:01 -05:00
if ( comments_open () || pings_open () || $post -> comment_count > 0 ) {
2014-01-17 04:53:09 -05:00
$title = sprintf ( $args [ 'singletitle' ], get_bloginfo ( 'name' ), $args [ 'separator' ], the_title_attribute ( array ( 'echo' => false ) ) );
2009-03-07 16:34:01 -05:00
$href = get_post_comments_feed_link ( $post -> ID );
}
2013-09-06 18:07:09 -04:00
} elseif ( is_post_type_archive () ) {
2013-09-09 23:02:10 -04:00
$post_type = get_query_var ( 'post_type' );
if ( is_array ( $post_type ) )
$post_type = reset ( $post_type );
$post_type_obj = get_post_type_object ( $post_type );
2013-09-06 18:07:09 -04:00
$title = sprintf ( $args [ 'posttypetitle' ], get_bloginfo ( 'name' ), $args [ 'separator' ], $post_type_obj -> labels -> name );
$href = get_post_type_archive_feed_link ( $post_type_obj -> name );
2009-03-07 16:34:01 -05:00
} elseif ( is_category () ) {
2010-10-31 07:02:17 -04:00
$term = get_queried_object ();
2009-01-19 00:04:58 -05:00
2013-09-09 22:28:11 -04:00
if ( $term ) {
$title = sprintf ( $args [ 'cattitle' ], get_bloginfo ( 'name' ), $args [ 'separator' ], $term -> name );
$href = get_category_feed_link ( $term -> term_id );
}
2009-03-07 16:34:01 -05:00
} elseif ( is_tag () ) {
2010-10-31 07:02:17 -04:00
$term = get_queried_object ();
2009-01-19 00:04:58 -05:00
2013-09-09 22:28:11 -04:00
if ( $term ) {
$title = sprintf ( $args [ 'tagtitle' ], get_bloginfo ( 'name' ), $args [ 'separator' ], $term -> name );
$href = get_tag_feed_link ( $term -> term_id );
}
2009-03-07 16:34:01 -05:00
} elseif ( is_author () ) {
2009-01-19 00:04:58 -05:00
$author_id = intval ( get_query_var ( 'author' ) );
2011-10-31 16:22:35 -04:00
$title = 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 () ) {
2011-10-31 16:22:35 -04:00
$title = sprintf ( $args [ 'searchtitle' ], get_bloginfo ( 'name' ), $args [ 'separator' ], get_search_query ( false ) );
2009-03-07 16:34:01 -05:00
$href = get_search_feed_link ();
2012-11-17 10:11:29 -05:00
} elseif ( is_post_type_archive () ) {
$title = sprintf ( $args [ 'posttypetitle' ], get_bloginfo ( 'name' ), $args [ 'separator' ], post_type_archive_title ( '' , false ) );
2013-09-09 22:28:11 -04:00
$post_type_obj = get_queried_object ();
if ( $post_type_obj )
$href = get_post_type_archive_feed_link ( $post_type_obj -> name );
2012-11-17 10:11:29 -05:00
}
2009-03-07 16:34:01 -05:00
if ( isset ( $title ) && isset ( $href ) )
2011-10-31 16:22:35 -04:00
echo '<link rel="alternate" type="' . feed_content_type () . '" title="' . esc_attr ( $title ) . '" href="' . esc_url ( $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 () {
2014-06-29 18:17:14 -04:00
echo '<link rel="wlwmanifest" type="application/wlwmanifest+xml" href="' ,
2014-06-29 18:27:15 -04:00
includes_url ( '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
2011-11-15 15:44:48 -05:00
* output to tell web robots not to index the page content . Add this to the wp_head action .
* Typical usage is as a wp_head callback . add_action ( 'wp_head' , 'noindex' );
*
* @ see wp_no_robots
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.
2013-07-05 11:17:31 -04:00
if ( '0' == get_option ( 'blog_public' ) )
2011-11-15 15:44:48 -05:00
wp_no_robots ();
}
/**
* Display a noindex meta tag .
*
* Outputs a noindex meta tag that tells web robots not to index the page content .
* Typical usage is as a wp_head callback . add_action ( 'wp_head' , 'wp_no_robots' );
*
* @ since 3.3 . 0
*/
function wp_no_robots () {
2013-11-11 17:27:10 -05:00
echo " <meta name='robots' content='noindex,follow' /> \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
/**
2010-02-24 15:13:23 -05:00
* Whether 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 () {
2012-04-09 21:19:30 -04:00
global $wp_rich_edit , $is_gecko , $is_opera , $is_safari , $is_chrome , $is_IE ;
2007-06-13 22:25:30 -04:00
2011-11-23 17:49:17 -05:00
if ( ! isset ( $wp_rich_edit ) ) {
2011-10-13 02:37:24 -04:00
$wp_rich_edit = false ;
2012-02-16 19:21:00 -05:00
if ( get_user_option ( 'rich_editing' ) == 'true' || ! is_user_logged_in () ) { // default to 'true' for logged out users
2011-10-13 02:37:24 -04:00
if ( $is_safari ) {
2012-06-04 12:04:54 -04:00
$wp_rich_edit = ! wp_is_mobile () || ( preg_match ( '!AppleWebKit/(\d+)!' , $_SERVER [ 'HTTP_USER_AGENT' ], $match ) && intval ( $match [ 1 ] ) >= 534 );
2012-07-30 15:40:52 -04:00
} elseif ( $is_gecko || $is_chrome || $is_IE || ( $is_opera && ! wp_is_mobile () ) ) {
2011-10-13 02:37:24 -04:00
$wp_rich_edit = true ;
}
2007-05-09 21:31:12 -04:00
}
}
2006-09-22 18:24:50 -04:00
2014-04-15 00:01:15 -04:00
/**
* Filter whether the user can access the rich ( Visual ) editor .
*
* @ since 2.1 . 0
*
* @ param bool $wp_rich_edit Whether the user can access to the rich ( Visual ) editor .
*/
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
/**
2011-11-23 14:06:52 -05:00
* Find out which editor should be displayed by default .
*
* Works out which of the two editors to display as the current editor for a
2012-07-05 16:28:01 -04:00
* user . The 'html' setting is for the " Text " editor tab .
2011-11-23 14:06:52 -05:00
*
* @ since 2.5 . 0
*
* @ return string Either 'tinymce' , or 'html' , or 'test'
*/
function wp_default_editor () {
$r = user_can_richedit () ? 'tinymce' : 'html' ; // defaults
2014-05-06 00:58:16 -04:00
if ( wp_get_current_user () ) { // look for cookie
2011-11-23 14:06:52 -05:00
$ed = get_user_setting ( 'editor' , 'tinymce' );
$r = ( in_array ( $ed , array ( 'tinymce' , 'html' , 'test' ) ) ) ? $ed : $r ;
}
2014-04-15 00:01:15 -04:00
/**
* Filter which editor should be displayed by default .
*
* @ since 2.5 . 0
*
* @ param array $r An array of editors . Accepts 'tinymce' , 'html' , 'test' .
*/
return apply_filters ( 'wp_default_editor' , $r );
2011-11-23 14:06:52 -05:00
}
/**
* Renders an editor .
2011-11-10 12:46:23 -05:00
*
* Using this function is the proper way to output all needed components for both TinyMCE and Quicktags .
2014-09-29 09:28:16 -04:00
* _WP_Editors should not be used directly . See https :// core . trac . wordpress . org / ticket / 17144.
2011-11-30 23:51:35 -05:00
*
2011-11-10 12:46:23 -05:00
* NOTE : Once initialized the TinyMCE editor cannot be safely moved in the DOM . For that reason
* running wp_editor () inside of a metabox is not a good idea unless only Quicktags is used .
* On the post edit screen several actions can be used to include additional editors
* containing TinyMCE : 'edit_page_form' , 'edit_form_advanced' and 'dbx_post_sidebar' .
2014-09-29 09:28:16 -04:00
* See https :// core . trac . wordpress . org / ticket / 19173 for more information .
2011-11-30 23:51:35 -05:00
*
2011-08-03 06:19:00 -04:00
* @ see wp - includes / class - wp - editor . php
2012-01-04 14:03:33 -05:00
* @ since 3.3 . 0
2008-09-05 15:19:01 -04:00
*
2011-08-03 06:19:00 -04:00
* @ param string $content Initial content for the editor .
2011-11-10 12:46:23 -05:00
* @ param string $editor_id HTML ID attribute value for the textarea and TinyMCE . Can only be / [ a - z ] +/.
2011-11-23 14:06:52 -05:00
* @ param array $settings See _WP_Editors :: editor () .
2008-09-05 15:19:01 -04:00
*/
2011-08-03 06:19:00 -04:00
function wp_editor ( $content , $editor_id , $settings = array () ) {
2011-11-23 14:06:52 -05:00
if ( ! class_exists ( '_WP_Editors' ) )
2011-08-03 06:19:00 -04:00
require ( ABSPATH . WPINC . '/class-wp-editor.php' );
2011-04-24 21:01:34 -04:00
2011-11-23 14:06:52 -05:00
_WP_Editors :: editor ( $content , $editor_id , $settings );
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
*
2010-04-03 19:38:38 -04:00
* The search query string is passed through { @ link esc_attr ()}
* to ensure that it is safe for placing in an html attribute .
*
2008-09-05 15:19:01 -04:00
* @ since 2.3 . 0
2010-04-03 19:38:38 -04:00
* @ uses esc_attr ()
2008-09-05 15:19:01 -04:00
*
2010-04-03 19:38:38 -04:00
* @ param bool $escaped Whether the result is escaped . Default true .
* Only use when you are later escaping it . Do not use unescaped .
2008-09-05 17:47:53 -04:00
* @ return string
2008-09-05 15:19:01 -04:00
*/
2010-04-03 19:38:38 -04:00
function get_search_query ( $escaped = true ) {
2014-04-15 00:01:15 -04:00
/**
* Filter the contents of the search query variable .
*
* @ since 2.3 . 0
*
* @ param mixed $search Contents of the search query variable .
*/
2010-04-03 19:38:38 -04:00
$query = apply_filters ( 'get_search_query' , get_query_var ( 's' ) );
2014-04-15 00:01:15 -04:00
2010-04-03 19:38:38 -04:00
if ( $escaped )
$query = esc_attr ( $query );
return $query ;
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
*
2010-04-03 19:38:38 -04:00
* @ uses esc_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 () {
2014-04-15 00:01:15 -04:00
/**
* Filter the contents of the search query variable for display .
*
* @ since 2.3 . 0
*
* @ param mixed $search Contents of the search query variable .
*/
2010-04-03 19:38:38 -04:00
echo esc_attr ( apply_filters ( 'the_search_query' , get_search_query ( false ) ) );
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 ();
2008-02-05 01:47:27 -05:00
2012-09-18 19:08:46 -04:00
if ( function_exists ( 'is_rtl' ) && is_rtl () )
$attributes [] = 'dir="rtl"' ;
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 );
2014-04-15 00:01:15 -04:00
/**
* Filter the language attributes for display in the html tag .
*
* @ since 2.5 . 0
*
* @ param string $output A space - separated list of language attributes .
*/
echo apply_filters ( 'language_attributes' , $output );
2006-09-24 16:16:13 -04:00
}
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
*
2014-05-04 18:21:22 -04:00
* The 'before_page_number' and 'after_page_number' arguments allow users to
2014-03-18 19:31:14 -04:00
* augment the links themselves . Typically this might be to add context to the
* numbered links so that screen reader users understand what the links are for .
2014-05-04 18:21:22 -04:00
* The text strings are added before and after the page number - within the
2014-03-18 19:31:14 -04:00
* anchor tag .
*
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 = '' ) {
2014-06-20 13:12:15 -04:00
global $wp_query , $wp_rewrite ;
$total = ( isset ( $wp_query -> max_num_pages ) ) ? $wp_query -> max_num_pages : 1 ;
$current = ( get_query_var ( 'paged' ) ) ? intval ( get_query_var ( 'paged' ) ) : 1 ;
$pagenum_link = html_entity_decode ( get_pagenum_link () );
$query_args = array ();
$url_parts = explode ( '?' , $pagenum_link );
if ( isset ( $url_parts [ 1 ] ) ) {
wp_parse_str ( $url_parts [ 1 ], $query_args );
}
$pagenum_link = remove_query_arg ( array_keys ( $query_args ), $pagenum_link );
$pagenum_link = trailingslashit ( $pagenum_link ) . '%_%' ;
$format = $wp_rewrite -> using_index_permalinks () && ! strpos ( $pagenum_link , 'index.php' ) ? 'index.php/' : '' ;
$format .= $wp_rewrite -> using_permalinks () ? user_trailingslashit ( $wp_rewrite -> pagination_base . '/%#%' , 'paged' ) : '?paged=%#%' ;
2007-09-03 19:32:58 -04:00
$defaults = array (
2014-06-20 13:12:15 -04:00
'base' => $pagenum_link , // http://example.com/all_posts.php%_% : %_% is replaced by format (below)
'format' => $format , // ?page=%#% : %#% is replaced by the page number
'total' => $total ,
'current' => $current ,
2007-06-14 18:46:59 -04:00
'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' ,
2014-09-29 00:03:16 -04:00
'add_args' => $query_args , // array of query args to add
2014-03-18 19:31:14 -04:00
'add_fragment' => '' ,
'before_page_number' => '' ,
'after_page_number' => ''
2007-06-14 18:46:59 -04:00
);
$args = wp_parse_args ( $args , $defaults );
2006-10-03 03:16:49 -04:00
// Who knows what else people pass in $args
2014-05-14 18:29:14 -04:00
$total = ( int ) $args [ 'total' ];
if ( $total < 2 ) {
2006-10-03 11:40:26 -04:00
return ;
2014-05-14 18:29:14 -04:00
}
$current = ( int ) $args [ 'current' ];
$end_size = ( int ) $args [ 'end_size' ]; // Out of bounds? Make it the default.
if ( $end_size < 1 ) {
$end_size = 1 ;
}
$mid_size = ( int ) $args [ 'mid_size' ];
if ( $mid_size < 0 ) {
$mid_size = 2 ;
}
$add_args = is_array ( $args [ 'add_args' ] ) ? $args [ 'add_args' ] : false ;
2006-10-03 03:16:49 -04:00
$r = '' ;
$page_links = array ();
$dots = false ;
2014-05-14 18:29:14 -04:00
if ( $args [ 'prev_next' ] && $current && 1 < $current ) :
2014-06-20 13:12:15 -04:00
$link = str_replace ( '%_%' , 2 == $current ? '' : $args [ 'format' ], $args [ '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 );
2014-05-14 18:29:14 -04:00
$link .= $args [ 'add_fragment' ];
2014-04-15 00:01:15 -04:00
/**
* Filter the paginated links for the given archive pages .
*
* @ since 3.0 . 0
*
* @ param string $link The paginated link URL .
*/
2014-05-14 18:29:14 -04:00
$page_links [] = '<a class="prev page-numbers" href="' . esc_url ( apply_filters ( 'paginate_links' , $link ) ) . '">' . $args [ 'prev_text' ] . '</a>' ;
2006-10-03 03:16:49 -04:00
endif ;
for ( $n = 1 ; $n <= $total ; $n ++ ) :
if ( $n == $current ) :
2014-05-14 18:29:14 -04:00
$page_links [] = " <span class='page-numbers current'> " . $args [ 'before_page_number' ] . number_format_i18n ( $n ) . $args [ 'after_page_number' ] . " </span> " ;
2006-10-03 03:16:49 -04:00
$dots = true ;
else :
2014-05-14 18:29:14 -04:00
if ( $args [ 'show_all' ] || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :
2014-06-20 13:12:15 -04:00
$link = str_replace ( '%_%' , 1 == $n ? '' : $args [ 'format' ], $args [ 'base' ] );
$link = str_replace ( '%#%' , $n , $link );
2006-10-03 03:16:49 -04:00
if ( $add_args )
$link = add_query_arg ( $add_args , $link );
2014-05-14 18:29:14 -04:00
$link .= $args [ 'add_fragment' ];
2014-04-15 00:01:15 -04:00
/** This filter is documented in wp-includes/general-template.php */
2014-05-14 18:29:14 -04:00
$page_links [] = " <a class='page-numbers' href=' " . esc_url ( apply_filters ( 'paginate_links' , $link ) ) . " '> " . $args [ 'before_page_number' ] . number_format_i18n ( $n ) . $args [ 'after_page_number' ] . " </a> " ;
2006-10-03 03:16:49 -04:00
$dots = true ;
2014-05-14 18:29:14 -04:00
elseif ( $dots && ! $args [ 'show_all' ] ) :
2011-11-14 16:24:49 -05:00
$page_links [] = '<span class="page-numbers dots">' . __ ( '…' ) . '</span>' ;
2006-10-03 03:16:49 -04:00
$dots = false ;
endif ;
endif ;
endfor ;
2014-05-14 18:29:14 -04:00
if ( $args [ 'prev_next' ] && $current && ( $current < $total || - 1 == $total ) ) :
2014-06-20 13:12:15 -04:00
$link = str_replace ( '%_%' , $args [ 'format' ], $args [ '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 );
2014-05-14 18:29:14 -04:00
$link .= $args [ 'add_fragment' ];
2014-04-15 00:01:15 -04:00
/** This filter is documented in wp-includes/general-template.php */
2014-05-14 18:29:14 -04:00
$page_links [] = '<a class="next page-numbers" href="' . esc_url ( apply_filters ( 'paginate_links' , $link ) ) . '">' . $args [ 'next_text' ] . '</a>' ;
2006-10-03 03:16:49 -04:00
endif ;
2014-05-14 18:29:14 -04:00
switch ( $args [ 'type' ] ) {
2006-10-03 03:16:49 -04:00
case 'array' :
return $page_links ;
2014-05-06 17:25:15 -04:00
2006-10-03 03:16:49 -04:00
case 'list' :
$r .= " <ul class='page-numbers'> \n \t <li> " ;
$r .= join ( " </li> \n \t <li> " , $page_links );
$r .= " </li> \n </ul> \n " ;
break ;
2014-05-13 00:29:26 -04:00
2006-10-03 03:16:49 -04:00
default :
$r = join ( " \n " , $page_links );
break ;
2014-05-06 17:25:15 -04:00
}
2006-10-03 03:16:49 -04:00
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-09-07 07:21:11 -04:00
* @ param array $colors Optional An array of CSS color definitions which are used to give the user a feel for the theme .
Merge the color schemes component from MP6. Introduces Light, Blue, and Midnight.
Color scheme selection on your own profile page gives you a preview and autosaves the selection.
Also introduces the usage of a preprocessor for core files, namely Sass. For 3.8, we will not expand its implementation past the color schemes. This does require Ruby as well as Sass 3.3.0+ due to the usage of the sourcemap option.
Note that only the default color scheme is available when running out of src. Use build to test the rest as well as the color picker.
props ryelle, melchoyce, tillkruess, drw158, littlethingsstudio, helen. see #25858, #22862.
Built from https://develop.svn.wordpress.org/trunk@26137
git-svn-id: http://core.svn.wordpress.org/trunk@26048 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-11-13 14:38:38 -05:00
* @ param array $icons Optional An array of CSS color definitions used to color any SVG icons
2008-09-05 17:47:53 -04:00
*/
Merge the color schemes component from MP6. Introduces Light, Blue, and Midnight.
Color scheme selection on your own profile page gives you a preview and autosaves the selection.
Also introduces the usage of a preprocessor for core files, namely Sass. For 3.8, we will not expand its implementation past the color schemes. This does require Ruby as well as Sass 3.3.0+ due to the usage of the sourcemap option.
Note that only the default color scheme is available when running out of src. Use build to test the rest as well as the color picker.
props ryelle, melchoyce, tillkruess, drw158, littlethingsstudio, helen. see #25858, #22862.
Built from https://develop.svn.wordpress.org/trunk@26137
git-svn-id: http://core.svn.wordpress.org/trunk@26048 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-11-13 14:38:38 -05:00
function wp_admin_css_color ( $key , $name , $url , $colors = array (), $icons = array () ) {
2008-03-11 17:06:03 -04:00
global $_wp_admin_css_colors ;
if ( ! isset ( $_wp_admin_css_colors ) )
$_wp_admin_css_colors = array ();
Merge the color schemes component from MP6. Introduces Light, Blue, and Midnight.
Color scheme selection on your own profile page gives you a preview and autosaves the selection.
Also introduces the usage of a preprocessor for core files, namely Sass. For 3.8, we will not expand its implementation past the color schemes. This does require Ruby as well as Sass 3.3.0+ due to the usage of the sourcemap option.
Note that only the default color scheme is available when running out of src. Use build to test the rest as well as the color picker.
props ryelle, melchoyce, tillkruess, drw158, littlethingsstudio, helen. see #25858, #22862.
Built from https://develop.svn.wordpress.org/trunk@26137
git-svn-id: http://core.svn.wordpress.org/trunk@26048 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-11-13 14:38:38 -05:00
$_wp_admin_css_colors [ $key ] = ( object ) array (
'name' => $name ,
'url' => $url ,
'colors' => $colors ,
'icon_colors' => $icons ,
);
2008-03-11 17:06:03 -04:00
}
2010-02-06 00:15:26 -05:00
/**
2010-02-28 01:34:31 -05:00
* Registers the default Admin color schemes
2010-02-06 00:15:26 -05:00
*
* @ since 3.0 . 0
*/
2010-02-28 01:34:31 -05:00
function register_admin_color_schemes () {
2013-12-07 04:05:10 -05:00
$suffix = is_rtl () ? '-rtl' : '' ;
2013-12-07 14:23:11 -05:00
$suffix .= defined ( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min' ;
2013-12-07 04:05:10 -05:00
Merge the color schemes component from MP6. Introduces Light, Blue, and Midnight.
Color scheme selection on your own profile page gives you a preview and autosaves the selection.
Also introduces the usage of a preprocessor for core files, namely Sass. For 3.8, we will not expand its implementation past the color schemes. This does require Ruby as well as Sass 3.3.0+ due to the usage of the sourcemap option.
Note that only the default color scheme is available when running out of src. Use build to test the rest as well as the color picker.
props ryelle, melchoyce, tillkruess, drw158, littlethingsstudio, helen. see #25858, #22862.
Built from https://develop.svn.wordpress.org/trunk@26137
git-svn-id: http://core.svn.wordpress.org/trunk@26048 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-11-13 14:38:38 -05:00
wp_admin_css_color ( 'fresh' , _x ( 'Default' , 'admin color scheme' ),
2014-02-06 17:16:11 -05:00
false ,
2013-12-03 23:13:11 -05:00
array ( '#222' , '#333' , '#0074a2' , '#2ea2cc' ),
array ( 'base' => '#999' , 'focus' => '#2ea2cc' , 'current' => '#fff' )
Merge the color schemes component from MP6. Introduces Light, Blue, and Midnight.
Color scheme selection on your own profile page gives you a preview and autosaves the selection.
Also introduces the usage of a preprocessor for core files, namely Sass. For 3.8, we will not expand its implementation past the color schemes. This does require Ruby as well as Sass 3.3.0+ due to the usage of the sourcemap option.
Note that only the default color scheme is available when running out of src. Use build to test the rest as well as the color picker.
props ryelle, melchoyce, tillkruess, drw158, littlethingsstudio, helen. see #25858, #22862.
Built from https://develop.svn.wordpress.org/trunk@26137
git-svn-id: http://core.svn.wordpress.org/trunk@26048 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-11-13 14:38:38 -05:00
);
// Other color schemes are not available when running out of src
2013-11-13 19:03:10 -05:00
if ( false !== strpos ( $GLOBALS [ 'wp_version' ], '-src' ) )
return ;
wp_admin_css_color ( 'light' , _x ( 'Light' , 'admin color scheme' ),
2013-12-07 04:05:10 -05:00
admin_url ( " css/colors/light/colors $suffix .css " ),
2013-11-13 19:03:10 -05:00
array ( '#e5e5e5' , '#999' , '#d64e07' , '#04a4cc' ),
array ( 'base' => '#999' , 'focus' => '#ccc' , 'current' => '#ccc' )
);
wp_admin_css_color ( 'blue' , _x ( 'Blue' , 'admin color scheme' ),
2013-12-07 04:05:10 -05:00
admin_url ( " css/colors/blue/colors $suffix .css " ),
2013-11-13 19:03:10 -05:00
array ( '#096484' , '#4796b3' , '#52accc' , '#74B6CE' ),
array ( 'base' => '#e5f8ff' , 'focus' => '#fff' , 'current' => '#fff' )
);
wp_admin_css_color ( 'midnight' , _x ( 'Midnight' , 'admin color scheme' ),
2013-12-07 04:05:10 -05:00
admin_url ( " css/colors/midnight/colors $suffix .css " ),
2013-11-13 19:03:10 -05:00
array ( '#25282b' , '#363b3f' , '#69a8bb' , '#e14d43' ),
array ( 'base' => '#f1f2f3' , 'focus' => '#fff' , 'current' => '#fff' )
);
Add four more color schemes to round out our collection at eight.
The new schemes are Ectoplasm, Coffee, Ocean, Sunrise. For those following along, the first three were at one point named Ghostbusters, Pixel, and Cape Cod.
See [26137] for the original color schemes.
props ryelle, melchoyce, drw158, littlethingsstudio.
fixes #26468. see #25858, #22862.
Built from https://develop.svn.wordpress.org/trunk@26773
git-svn-id: http://core.svn.wordpress.org/trunk@26660 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-12-07 02:26:12 -05:00
wp_admin_css_color ( 'sunrise' , _x ( 'Sunrise' , 'admin color scheme' ),
2013-12-07 04:05:10 -05:00
admin_url ( " css/colors/sunrise/colors $suffix .css " ),
array ( '#b43c38' , '#cf4944' , '#dd823b' , '#ccaf0b' ),
Add four more color schemes to round out our collection at eight.
The new schemes are Ectoplasm, Coffee, Ocean, Sunrise. For those following along, the first three were at one point named Ghostbusters, Pixel, and Cape Cod.
See [26137] for the original color schemes.
props ryelle, melchoyce, drw158, littlethingsstudio.
fixes #26468. see #25858, #22862.
Built from https://develop.svn.wordpress.org/trunk@26773
git-svn-id: http://core.svn.wordpress.org/trunk@26660 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-12-07 02:26:12 -05:00
array ( 'base' => '#f3f1f1' , 'focus' => '#fff' , 'current' => '#fff' )
);
wp_admin_css_color ( 'ectoplasm' , _x ( 'Ectoplasm' , 'admin color scheme' ),
2013-12-07 04:05:10 -05:00
admin_url ( " css/colors/ectoplasm/colors $suffix .css " ),
Add four more color schemes to round out our collection at eight.
The new schemes are Ectoplasm, Coffee, Ocean, Sunrise. For those following along, the first three were at one point named Ghostbusters, Pixel, and Cape Cod.
See [26137] for the original color schemes.
props ryelle, melchoyce, drw158, littlethingsstudio.
fixes #26468. see #25858, #22862.
Built from https://develop.svn.wordpress.org/trunk@26773
git-svn-id: http://core.svn.wordpress.org/trunk@26660 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-12-07 02:26:12 -05:00
array ( '#413256' , '#523f6d' , '#a3b745' , '#d46f15' ),
array ( 'base' => '#ece6f6' , 'focus' => '#fff' , 'current' => '#fff' )
);
2013-12-07 04:05:10 -05:00
Add four more color schemes to round out our collection at eight.
The new schemes are Ectoplasm, Coffee, Ocean, Sunrise. For those following along, the first three were at one point named Ghostbusters, Pixel, and Cape Cod.
See [26137] for the original color schemes.
props ryelle, melchoyce, drw158, littlethingsstudio.
fixes #26468. see #25858, #22862.
Built from https://develop.svn.wordpress.org/trunk@26773
git-svn-id: http://core.svn.wordpress.org/trunk@26660 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-12-07 02:26:12 -05:00
wp_admin_css_color ( 'ocean' , _x ( 'Ocean' , 'admin color scheme' ),
2013-12-07 04:05:10 -05:00
admin_url ( " css/colors/ocean/colors $suffix .css " ),
Add four more color schemes to round out our collection at eight.
The new schemes are Ectoplasm, Coffee, Ocean, Sunrise. For those following along, the first three were at one point named Ghostbusters, Pixel, and Cape Cod.
See [26137] for the original color schemes.
props ryelle, melchoyce, drw158, littlethingsstudio.
fixes #26468. see #25858, #22862.
Built from https://develop.svn.wordpress.org/trunk@26773
git-svn-id: http://core.svn.wordpress.org/trunk@26660 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-12-07 02:26:12 -05:00
array ( '#627c83' , '#738e96' , '#9ebaa0' , '#aa9d88' ),
array ( 'base' => '#f2fcff' , 'focus' => '#fff' , 'current' => '#fff' )
);
wp_admin_css_color ( 'coffee' , _x ( 'Coffee' , 'admin color scheme' ),
2013-12-07 04:05:10 -05:00
admin_url ( " css/colors/coffee/colors $suffix .css " ),
Add four more color schemes to round out our collection at eight.
The new schemes are Ectoplasm, Coffee, Ocean, Sunrise. For those following along, the first three were at one point named Ghostbusters, Pixel, and Cape Cod.
See [26137] for the original color schemes.
props ryelle, melchoyce, drw158, littlethingsstudio.
fixes #26468. see #25858, #22862.
Built from https://develop.svn.wordpress.org/trunk@26773
git-svn-id: http://core.svn.wordpress.org/trunk@26660 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-12-07 02:26:12 -05:00
array ( '#46403c' , '#59524c' , '#c7a589' , '#9ea476' ),
array ( 'base' => '#f3f2f1' , 'focus' => '#fff' , 'current' => '#fff' )
);
2010-11-02 17:04:29 -04:00
}
2010-02-06 00:15:26 -05:00
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 );
2014-04-15 00:01:15 -04:00
/**
* Filter the URI of a WordPress admin CSS file .
*
* @ since 2.3 . 0
*
* @ param string $_file Relative path to the file with query arguments attached .
* @ param string $file Relative path to the file , minus its " .css " extension .
*/
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
2012-01-05 15:50:54 -05:00
* be printed . Printing may be forced by passing true as the $force_echo
2008-09-06 02:38:26 -04:00
* ( 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
*
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
*
2010-09-14 12:22:55 -04:00
* @ param string $file Optional . Style handle name or file name ( without " .css " extension ) relative
* to wp - admin /. Defaults to 'wp-admin' .
2011-12-13 18:45:31 -05:00
* @ param bool $force_echo Optional . Force the stylesheet link to be printed rather than enqueued .
2008-05-25 17:23:22 -04:00
*/
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 ) ) {
2011-12-13 18:45:31 -05: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
2014-04-15 00:01:15 -04:00
/**
* Filter the stylesheet link to the specified CSS file .
*
* If the site is set to display right - to - left , the RTL stylesheet link
* will be used instead .
*
* @ since 2.3 . 0
*
* @ param string $file Style handle name or filename ( without " .css " extension )
* relative to wp - admin /. Defaults to 'wp-admin' .
*/
2010-05-03 14:16:22 -04:00
echo apply_filters ( 'wp_admin_css' , " <link rel='stylesheet' href=' " . esc_url ( wp_admin_css_uri ( $file ) ) . " ' type='text/css' /> \n " , $file );
2014-04-15 00:01:15 -04:00
if ( function_exists ( 'is_rtl' ) && is_rtl () ) {
/** This filter is documented in wp-includes/general-template.php */
2010-05-03 14:16:22 -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 " );
2014-04-15 00:01:15 -04:00
}
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
2012-04-09 22:25:03 -04:00
* file similar to media - upload . js . That file should
2008-09-06 02:38:26 -04:00
* 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' );
2010-12-15 13:48:40 -05:00
if ( is_network_admin () )
add_action ( 'admin_head' , '_thickbox_path_admin_subfolder' );
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 () {
2014-04-15 00:01:15 -04:00
/**
* Filter the output of the XHTML generator tag .
*
* @ since 2.5 . 0
*
* @ param string $generator_type The XHTML 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
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 ) {
2014-04-15 00:01:15 -04:00
/**
* Filter the output of the XHTML generator tag for display .
*
* @ since 2.5 . 0
*
* @ param string $generator_type The generator output .
* @ param string $type The type of generator to output . Accepts 'html' ,
* 'xhtml' , 'atom' , 'rss2' , 'rdf' , 'comment' , 'export' .
*/
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
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' :
2010-10-25 16:43:52 -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 ;
}
2014-04-15 00:01:15 -04:00
/**
* Filter the HTML for the retrieved generator type .
*
* The dynamic portion of the hook name , $type , refers to the generator type .
*
* @ since 2.5 . 0
*
* @ param string $gen The HTML markup output to 'wp_head()' .
* @ param string $type The type of generator . Accepts 'html' , 'xhtml' , 'atom' ,
* 'rss2' , 'rdf' , 'comment' , 'export' .
*/
2007-10-06 02:55:24 -04:00
return apply_filters ( " get_the_generator_ { $type } " , $gen , $type );
}
2008-09-05 15:19:01 -04:00
2010-03-11 11:34:27 -05:00
/**
* Outputs the html checked attribute .
*
* Compares the first two arguments and if identical marks as checked
*
2010-12-01 14:24:38 -05:00
* @ since 1.0 . 0
2010-03-11 11:34:27 -05:00
*
* @ param mixed $checked One of the values to compare
* @ param mixed $current ( true ) The other value to compare if not just true
* @ param bool $echo Whether to echo or just return the string
* @ return string html attribute or empty string
*/
function checked ( $checked , $current = true , $echo = true ) {
return __checked_selected_helper ( $checked , $current , $echo , 'checked' );
}
/**
* Outputs the html selected attribute .
*
* Compares the first two arguments and if identical marks as selected
*
2010-12-01 14:24:38 -05:00
* @ since 1.0 . 0
2010-03-11 11:34:27 -05:00
*
2010-09-07 07:21:11 -04:00
* @ param mixed $selected One of the values to compare
2010-03-11 11:34:27 -05:00
* @ param mixed $current ( true ) The other value to compare if not just true
* @ param bool $echo Whether to echo or just return the string
* @ return string html attribute or empty string
*/
function selected ( $selected , $current = true , $echo = true ) {
return __checked_selected_helper ( $selected , $current , $echo , 'selected' );
}
/**
* Outputs the html disabled attribute .
*
* Compares the first two arguments and if identical marks as disabled
*
* @ since 3.0 . 0
*
* @ param mixed $disabled One of the values to compare
* @ param mixed $current ( true ) The other value to compare if not just true
* @ param bool $echo Whether to echo or just return the string
* @ return string html attribute or empty string
*/
function disabled ( $disabled , $current = true , $echo = true ) {
return __checked_selected_helper ( $disabled , $current , $echo , 'disabled' );
}
/**
* Private helper function for checked , selected , and disabled .
*
* Compares the first two arguments and if identical marks as $type
*
2010-12-01 14:24:38 -05:00
* @ since 2.8 . 0
2010-03-11 11:34:27 -05:00
* @ access private
*
2012-09-20 09:52:36 -04:00
* @ param mixed $helper One of the values to compare
* @ param mixed $current ( true ) The other value to compare if not just true
2010-03-11 11:34:27 -05:00
* @ param bool $echo Whether to echo or just return the string
* @ param string $type The type of checked | selected | disabled we are doing
* @ return string html attribute or empty string
*/
function __checked_selected_helper ( $helper , $current , $echo , $type ) {
if ( ( string ) $helper === ( string ) $current )
$result = " $type =' $type ' " ;
else
$result = '' ;
if ( $echo )
echo $result ;
return $result ;
}
2013-01-29 01:15:25 -05:00
/**
* Default settings for heartbeat
*
* Outputs the nonce used in the heartbeat XHR
*
* @ since 3.6 . 0
*
* @ param array $settings
* @ return array $settings
*/
function wp_heartbeat_settings ( $settings ) {
2013-03-30 19:32:12 -04:00
if ( ! is_admin () )
$settings [ 'ajaxurl' ] = admin_url ( 'admin-ajax.php' , 'relative' );
2013-02-24 21:32:22 -05:00
if ( is_user_logged_in () )
2013-02-24 23:19:51 -05:00
$settings [ 'nonce' ] = wp_create_nonce ( 'heartbeat-nonce' );
2013-02-24 21:32:22 -05:00
2013-02-24 23:19:51 -05:00
return $settings ;
2013-01-29 01:15:25 -05:00
}