3 * General template tags that can go anywhere in a template.
10 * Load header template.
12 * Includes the header template for a theme or if a name is specified then a
13 * specialised header will be included.
15 * For the parameter, if the file is called "header-special.php" then specify
18 * @uses locate_template()
20 * @uses do_action() Calls 'get_header' action.
22 * @param string $name The name of the specialised header.
24 function get_header( $name = null ) {
25 do_action( 'get_header', $name );
29 $templates[] = "header-{$name}.php";
31 $templates[] = 'header.php';
33 // Backward compat code will be removed in a future release
34 if ('' == locate_template($templates, true))
35 load_template( ABSPATH . WPINC . '/theme-compat/header.php');
39 * Load footer template.
41 * Includes the footer template for a theme or if a name is specified then a
42 * specialised footer will be included.
44 * For the parameter, if the file is called "footer-special.php" then specify
47 * @uses locate_template()
49 * @uses do_action() Calls 'get_footer' action.
51 * @param string $name The name of the specialised footer.
53 function get_footer( $name = null ) {
54 do_action( 'get_footer', $name );
58 $templates[] = "footer-{$name}.php";
60 $templates[] = 'footer.php';
62 // Backward compat code will be removed in a future release
63 if ('' == locate_template($templates, true))
64 load_template( ABSPATH . WPINC . '/theme-compat/footer.php');
68 * Load sidebar template.
70 * Includes the sidebar template for a theme or if a name is specified then a
71 * specialised sidebar will be included.
73 * For the parameter, if the file is called "sidebar-special.php" then specify
76 * @uses locate_template()
78 * @uses do_action() Calls 'get_sidebar' action.
80 * @param string $name The name of the specialised sidebar.
82 function get_sidebar( $name = null ) {
83 do_action( 'get_sidebar', $name );
87 $templates[] = "sidebar-{$name}.php";
89 $templates[] = 'sidebar.php';
91 // Backward compat code will be removed in a future release
92 if ('' == locate_template($templates, true))
93 load_template( ABSPATH . WPINC . '/theme-compat/sidebar.php');
97 * Load a template part into a template
99 * Makes it easy for a theme to reuse sections of code in a easy to overload way
102 * Includes the named template part for a theme or if a name is specified then a
103 * specialised part will be included. If the theme contains no {slug}.php file
104 * then no template will be included.
106 * The template is included using require, not require_once, so you may include the
107 * same template part multiple times.
109 * For the $name parameter, if the file is called "{slug}-special.php" then specify
112 * @uses locate_template()
114 * @uses do_action() Calls 'get_template_part_{$slug}' action.
116 * @param string $slug The slug name for the generic template.
117 * @param string $name The name of the specialised template.
119 function get_template_part( $slug, $name = null ) {
120 do_action( "get_template_part_{$slug}", $slug, $name );
122 $templates = array();
124 $templates[] = "{$slug}-{$name}.php";
126 $templates[] = "{$slug}.php";
128 locate_template($templates, true, false);
132 * Display search form.
134 * Will first attempt to locate the searchform.php file in either the child or
135 * the parent, then load it. If it doesn't exist, then the default search form
136 * will be displayed. The default search form is HTML, which will be displayed.
137 * There is a filter applied to the search form HTML in order to edit or replace
138 * it. The filter is 'get_search_form'.
140 * This function is primarily used by themes which want to hardcode the search
141 * form into the sidebar and also by the search widget in WordPress.
143 * There is also an action that is called whenever the function is run called,
144 * 'get_search_form'. This can be useful for outputting JavaScript that the
145 * search relies on or various formatting that applies to the beginning of the
146 * search. To give a few examples of what it can be used for.
149 * @param boolean $echo Default to echo and not return the form.
150 * @return string|null String when retrieving, null when displaying or if searchform.php exists.
152 function get_search_form($echo = true) {
153 do_action( 'get_search_form' );
155 $search_form_template = locate_template('searchform.php');
156 if ( '' != $search_form_template ) {
157 require($search_form_template);
161 $form = '<form role="search" method="get" id="searchform" action="' . esc_url( home_url( '/' ) ) . '" >
162 <div><label class="screen-reader-text" for="s">' . __('Search for:') . '</label>
163 <input type="text" value="' . get_search_query() . '" name="s" id="s" />
164 <input type="submit" id="searchsubmit" value="'. esc_attr__('Search') .'" />
169 echo apply_filters('get_search_form', $form);
171 return apply_filters('get_search_form', $form);
175 * Display the Log In/Out link.
177 * Displays a link, which allows users to navigate to the Log In page to log in
178 * or log out depending on whether they are currently logged in.
181 * @uses apply_filters() Calls 'loginout' hook on HTML link content.
183 * @param string $redirect Optional path to redirect to on login/logout.
184 * @param boolean $echo Default to echo and not return the link.
185 * @return string|null String when retrieving, null when displaying.
187 function wp_loginout($redirect = '', $echo = true) {
188 if ( ! is_user_logged_in() )
189 $link = '<a href="' . esc_url( wp_login_url($redirect) ) . '">' . __('Log in') . '</a>';
191 $link = '<a href="' . esc_url( wp_logout_url($redirect) ) . '">' . __('Log out') . '</a>';
194 echo apply_filters('loginout', $link);
196 return apply_filters('loginout', $link);
200 * Returns the Log Out URL.
202 * Returns the URL that allows the user to log out of the site
205 * @uses wp_nonce_url() To protect against CSRF
206 * @uses site_url() To generate the log in URL
207 * @uses apply_filters() calls 'logout_url' hook on final logout url
209 * @param string $redirect Path to redirect to on logout.
210 * @return string A log out URL.
212 function wp_logout_url($redirect = '') {
213 $args = array( 'action' => 'logout' );
214 if ( !empty($redirect) ) {
215 $args['redirect_to'] = urlencode( $redirect );
218 $logout_url = add_query_arg($args, site_url('wp-login.php', 'login'));
219 $logout_url = wp_nonce_url( $logout_url, 'log-out' );
221 return apply_filters('logout_url', $logout_url, $redirect);
225 * Returns the Log In URL.
227 * Returns the URL that allows the user to log in to the site
230 * @uses site_url() To generate the log in URL
231 * @uses apply_filters() calls 'login_url' hook on final login url
233 * @param string $redirect Path to redirect to on login.
234 * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false.
235 * @return string A log in URL.
237 function wp_login_url($redirect = '', $force_reauth = false) {
238 $login_url = site_url('wp-login.php', 'login');
240 if ( !empty($redirect) )
241 $login_url = add_query_arg('redirect_to', urlencode($redirect), $login_url);
244 $login_url = add_query_arg('reauth', '1', $login_url);
246 return apply_filters('login_url', $login_url, $redirect);
250 * Provides a simple login form for use anywhere within WordPress. By default, it echoes
251 * the HTML immediately. Pass array('echo'=>false) to return the string instead.
254 * @param array $args Configuration options to modify the form output.
255 * @return string|null String when retrieving, null when displaying.
257 function wp_login_form( $args = array() ) {
258 $defaults = array( 'echo' => true,
259 'redirect' => ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], // Default redirect is back to the current page
260 'form_id' => 'loginform',
261 'label_username' => __( 'Username' ),
262 'label_password' => __( 'Password' ),
263 'label_remember' => __( 'Remember Me' ),
264 'label_log_in' => __( 'Log In' ),
265 'id_username' => 'user_login',
266 'id_password' => 'user_pass',
267 'id_remember' => 'rememberme',
268 'id_submit' => 'wp-submit',
270 'value_username' => '',
271 'value_remember' => false, // Set this to true to default the "Remember me" checkbox to checked
273 $args = wp_parse_args( $args, apply_filters( 'login_form_defaults', $defaults ) );
276 <form name="' . $args['form_id'] . '" id="' . $args['form_id'] . '" action="' . esc_url( site_url( 'wp-login.php', 'login_post' ) ) . '" method="post">
277 ' . apply_filters( 'login_form_top', '', $args ) . '
278 <p class="login-username">
279 <label for="' . esc_attr( $args['id_username'] ) . '">' . esc_html( $args['label_username'] ) . '</label>
280 <input type="text" name="log" id="' . esc_attr( $args['id_username'] ) . '" class="input" value="' . esc_attr( $args['value_username'] ) . '" size="20" />
282 <p class="login-password">
283 <label for="' . esc_attr( $args['id_password'] ) . '">' . esc_html( $args['label_password'] ) . '</label>
284 <input type="password" name="pwd" id="' . esc_attr( $args['id_password'] ) . '" class="input" value="" size="20" />
286 ' . apply_filters( 'login_form_middle', '', $args ) . '
287 ' . ( $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>' : '' ) . '
288 <p class="login-submit">
289 <input type="submit" name="wp-submit" id="' . esc_attr( $args['id_submit'] ) . '" class="button-primary" value="' . esc_attr( $args['label_log_in'] ) . '" />
290 <input type="hidden" name="redirect_to" value="' . esc_url( $args['redirect'] ) . '" />
292 ' . apply_filters( 'login_form_bottom', '', $args ) . '
302 * Returns the Lost Password URL.
304 * Returns the URL that allows the user to retrieve the lost password
307 * @uses site_url() To generate the lost password URL
308 * @uses apply_filters() calls 'lostpassword_url' hook on the lostpassword url
310 * @param string $redirect Path to redirect to on login.
311 * @return string Lost password URL.
313 function wp_lostpassword_url( $redirect = '' ) {
314 $args = array( 'action' => 'lostpassword' );
315 if ( !empty($redirect) ) {
316 $args['redirect_to'] = $redirect;
319 $lostpassword_url = add_query_arg( $args, network_site_url('wp-login.php', 'login') );
320 return apply_filters( 'lostpassword_url', $lostpassword_url, $redirect );
324 * Display the Registration or Admin link.
326 * Display a link which allows the user to navigate to the registration page if
327 * not logged in and registration is enabled or to the dashboard if logged in.
330 * @uses apply_filters() Calls 'register' hook on register / admin link content.
332 * @param string $before Text to output before the link (defaults to <li>).
333 * @param string $after Text to output after the link (defaults to </li>).
334 * @param boolean $echo Default to echo and not return the link.
335 * @return string|null String when retrieving, null when displaying.
337 function wp_register( $before = '<li>', $after = '</li>', $echo = true ) {
339 if ( ! is_user_logged_in() ) {
340 if ( get_option('users_can_register') )
341 $link = $before . '<a href="' . site_url('wp-login.php?action=register', 'login') . '">' . __('Register') . '</a>' . $after;
345 $link = $before . '<a href="' . admin_url() . '">' . __('Site Admin') . '</a>' . $after;
349 echo apply_filters('register', $link);
351 return apply_filters('register', $link);
355 * Theme container function for the 'wp_meta' action.
357 * The 'wp_meta' action can have several purposes, depending on how you use it,
358 * but one purpose might have been to allow for theme switching.
361 * @link http://trac.wordpress.org/ticket/1458 Explanation of 'wp_meta' action.
362 * @uses do_action() Calls 'wp_meta' hook.
365 do_action('wp_meta');
369 * Display information about the blog.
371 * @see get_bloginfo() For possible values for the parameter.
374 * @param string $show What to display.
376 function bloginfo( $show='' ) {
377 echo get_bloginfo( $show, 'display' );
381 * Retrieve information about the blog.
383 * Some show parameter values are deprecated and will be removed in future
384 * versions. These options will trigger the _deprecated_argument() function.
385 * The deprecated blog info options are listed in the function contents.
387 * The possible values for the 'show' parameter are listed below.
389 * <li><strong>url</strong> - Blog URI to homepage.</li>
390 * <li><strong>wpurl</strong> - Blog URI path to WordPress.</li>
391 * <li><strong>description</strong> - Secondary title</li>
394 * The feed URL options can be retrieved from 'rdf_url' (RSS 0.91),
395 * 'rss_url' (RSS 1.0), 'rss2_url' (RSS 2.0), or 'atom_url' (Atom feed). The
396 * comment feeds can be retrieved from the 'comments_atom_url' (Atom comment
397 * feed) or 'comments_rss2_url' (RSS 2.0 comment feed).
401 * @param string $show Blog info to retrieve.
402 * @param string $filter How to filter what is retrieved.
403 * @return string Mostly string values, might be empty.
405 function get_bloginfo( $show = '', $filter = 'raw' ) {
408 case 'home' : // DEPRECATED
409 case 'siteurl' : // DEPRECATED
410 _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' ) );
412 $output = home_url();
415 $output = site_url();
418 $output = get_option('blogdescription');
421 $output = get_feed_link('rdf');
424 $output = get_feed_link('rss');
427 $output = get_feed_link('rss2');
430 $output = get_feed_link('atom');
432 case 'comments_atom_url':
433 $output = get_feed_link('comments_atom');
435 case 'comments_rss2_url':
436 $output = get_feed_link('comments_rss2');
439 $output = get_option('siteurl') .'/xmlrpc.php';
441 case 'stylesheet_url':
442 $output = get_stylesheet_uri();
444 case 'stylesheet_directory':
445 $output = get_stylesheet_directory_uri();
447 case 'template_directory':
449 $output = get_template_directory_uri();
452 $output = get_option('admin_email');
455 $output = get_option('blog_charset');
456 if ('' == $output) $output = 'UTF-8';
459 $output = get_option('html_type');
463 $output = $wp_version;
466 $output = get_locale();
467 $output = str_replace('_', '-', $output);
469 case 'text_direction':
470 //_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()' ) );
471 if ( function_exists( 'is_rtl' ) ) {
472 $output = is_rtl() ? 'rtl' : 'ltr';
479 $output = get_option('blogname');
484 if (strpos($show, 'url') === false &&
485 strpos($show, 'directory') === false &&
486 strpos($show, 'home') === false)
489 if ( 'display' == $filter ) {
491 $output = apply_filters('bloginfo_url', $output, $show);
493 $output = apply_filters('bloginfo', $output, $show);
500 * Display or retrieve page title for all areas of blog.
502 * By default, the page title will display the separator before the page title,
503 * so that the blog title will be before the page title. This is not good for
504 * title display, since the blog title shows up on most tabs and not what is
505 * important, which is the page that the user is looking at.
507 * There are also SEO benefits to having the blog title after or to the 'right'
508 * or the page title. However, it is mostly common sense to have the blog title
509 * to the right with most browsers supporting tabs. You can achieve this by
510 * using the seplocation parameter and setting the value to 'right'. This change
511 * was introduced around 2.5.0, in case backwards compatibility of themes is
516 * @param string $sep Optional, default is '»'. How to separate the various items within the page title.
517 * @param bool $display Optional, default is true. Whether to display or retrieve title.
518 * @param string $seplocation Optional. Direction to display title, 'right'.
519 * @return string|null String on retrieve, null when displaying.
521 function wp_title($sep = '»', $display = true, $seplocation = '') {
522 global $wpdb, $wp_locale;
524 $m = get_query_var('m');
525 $year = get_query_var('year');
526 $monthnum = get_query_var('monthnum');
527 $day = get_query_var('day');
528 $search = get_query_var('s');
531 $t_sep = '%WP_TITILE_SEP%'; // Temporary separator, for accurate flipping, if necessary
533 // If there is a post
534 if ( is_single() || ( is_home() && !is_front_page() ) || ( is_page() && !is_front_page() ) ) {
535 $title = single_post_title( '', false );
538 // If there's a category or tag
539 if ( is_category() || is_tag() ) {
540 $title = single_term_title( '', false );
543 // If there's a taxonomy
545 $term = get_queried_object();
546 $tax = get_taxonomy( $term->taxonomy );
547 $title = single_term_title( $tax->labels->name . $t_sep, false );
550 // If there's an author
552 $author = get_queried_object();
553 $title = $author->display_name;
556 // If there's a post type archive
557 if ( is_post_type_archive() )
558 $title = post_type_archive_title( '', false );
560 // If there's a month
561 if ( is_archive() && !empty($m) ) {
562 $my_year = substr($m, 0, 4);
563 $my_month = $wp_locale->get_month(substr($m, 4, 2));
564 $my_day = intval(substr($m, 6, 2));
565 $title = $my_year . ( $my_month ? $t_sep . $my_month : '' ) . ( $my_day ? $t_sep . $my_day : '' );
569 if ( is_archive() && !empty($year) ) {
571 if ( !empty($monthnum) )
572 $title .= $t_sep . $wp_locale->get_month($monthnum);
574 $title .= $t_sep . zeroise($day, 2);
579 /* translators: 1: separator, 2: search phrase */
580 $title = sprintf(__('Search Results %1$s %2$s'), $t_sep, strip_tags($search));
583 // If it's a 404 page
585 $title = __('Page not found');
589 if ( !empty($title) )
592 // Determines position of the separator and direction of the breadcrumb
593 if ( 'right' == $seplocation ) { // sep on right, so reverse the order
594 $title_array = explode( $t_sep, $title );
595 $title_array = array_reverse( $title_array );
596 $title = implode( " $sep ", $title_array ) . $prefix;
598 $title_array = explode( $t_sep, $title );
599 $title = $prefix . implode( " $sep ", $title_array );
602 $title = apply_filters('wp_title', $title, $sep, $seplocation);
613 * Display or retrieve page title for post.
615 * This is optimized for single.php template file for displaying the post title.
617 * It does not support placing the separator after the title, but by leaving the
618 * prefix parameter empty, you can set the title separator manually. The prefix
619 * does not automatically place a space between the prefix, so if there should
620 * be a space, the parameter value will need to have it at the end.
624 * @param string $prefix Optional. What to display before the title.
625 * @param bool $display Optional, default is true. Whether to display or retrieve title.
626 * @return string|null Title when retrieving, null when displaying or failure.
628 function single_post_title($prefix = '', $display = true) {
629 $_post = get_queried_object();
631 if ( !isset($_post->post_title) )
634 $title = apply_filters('single_post_title', $_post->post_title, $_post);
636 echo $prefix . $title;
642 * Display or retrieve title for a post type archive.
644 * This is optimized for archive.php and archive-{$post_type}.php template files
645 * for displaying the title of the post type.
649 * @param string $prefix Optional. What to display before the title.
650 * @param bool $display Optional, default is true. Whether to display or retrieve title.
651 * @return string|null Title when retrieving, null when displaying or failure.
653 function post_type_archive_title( $prefix = '', $display = true ) {
654 if ( ! is_post_type_archive() )
657 $post_type_obj = get_queried_object();
658 $title = apply_filters('post_type_archive_title', $post_type_obj->labels->name );
661 echo $prefix . $title;
667 * Display or retrieve page title for category archive.
669 * This is useful for category template file or files, because it is optimized
670 * for category page title and with less overhead than {@link wp_title()}.
672 * It does not support placing the separator after the title, but by leaving the
673 * prefix parameter empty, you can set the title separator manually. The prefix
674 * does not automatically place a space between the prefix, so if there should
675 * be a space, the parameter value will need to have it at the end.
679 * @param string $prefix Optional. What to display before the title.
680 * @param bool $display Optional, default is true. Whether to display or retrieve title.
681 * @return string|null Title when retrieving, null when displaying or failure.
683 function single_cat_title( $prefix = '', $display = true ) {
684 return single_term_title( $prefix, $display );
688 * Display or retrieve page title for tag post archive.
690 * Useful for tag template files for displaying the tag page title. It has less
691 * overhead than {@link wp_title()}, because of its limited implementation.
693 * It does not support placing the separator after the title, but by leaving the
694 * prefix parameter empty, you can set the title separator manually. The prefix
695 * does not automatically place a space between the prefix, so if there should
696 * be a space, the parameter value will need to have it at the end.
700 * @param string $prefix Optional. What to display before the title.
701 * @param bool $display Optional, default is true. Whether to display or retrieve title.
702 * @return string|null Title when retrieving, null when displaying or failure.
704 function single_tag_title( $prefix = '', $display = true ) {
705 return single_term_title( $prefix, $display );
709 * Display or retrieve page title for taxonomy term archive.
711 * Useful for taxonomy term template files for displaying the taxonomy term page title.
712 * It has less overhead than {@link wp_title()}, because of its limited implementation.
714 * It does not support placing the separator after the title, but by leaving the
715 * prefix parameter empty, you can set the title separator manually. The prefix
716 * does not automatically place a space between the prefix, so if there should
717 * be a space, the parameter value will need to have it at the end.
721 * @param string $prefix Optional. What to display before the title.
722 * @param bool $display Optional, default is true. Whether to display or retrieve title.
723 * @return string|null Title when retrieving, null when displaying or failure.
725 function single_term_title( $prefix = '', $display = true ) {
726 $term = get_queried_object();
732 $term_name = apply_filters( 'single_cat_title', $term->name );
734 $term_name = apply_filters( 'single_tag_title', $term->name );
736 $term_name = apply_filters( 'single_term_title', $term->name );
740 if ( empty( $term_name ) )
744 echo $prefix . $term_name;
750 * Display or retrieve page title for post archive based on date.
752 * Useful for when the template only needs to display the month and year, if
753 * either are available. Optimized for just this purpose, so if it is all that
754 * is needed, should be better than {@link wp_title()}.
756 * It does not support placing the separator after the title, but by leaving the
757 * prefix parameter empty, you can set the title separator manually. The prefix
758 * does not automatically place a space between the prefix, so if there should
759 * be a space, the parameter value will need to have it at the end.
763 * @param string $prefix Optional. What to display before the title.
764 * @param bool $display Optional, default is true. Whether to display or retrieve title.
765 * @return string|null Title when retrieving, null when displaying or failure.
767 function single_month_title($prefix = '', $display = true ) {
770 $m = get_query_var('m');
771 $year = get_query_var('year');
772 $monthnum = get_query_var('monthnum');
774 if ( !empty($monthnum) && !empty($year) ) {
776 $my_month = $wp_locale->get_month($monthnum);
777 } elseif ( !empty($m) ) {
778 $my_year = substr($m, 0, 4);
779 $my_month = $wp_locale->get_month(substr($m, 4, 2));
782 if ( empty($my_month) )
785 $result = $prefix . $my_month . $prefix . $my_year;
793 * Retrieve archive link content based on predefined or custom code.
795 * The format can be one of four styles. The 'link' for head element, 'option'
796 * for use in the select element, 'html' for use in list (either ol or ul HTML
797 * elements). Custom content is also supported using the before and after
800 * The 'link' format uses the link HTML element with the <em>archives</em>
801 * relationship. The before and after parameters are not used. The text
802 * parameter is used to describe the link.
804 * The 'option' format uses the option HTML element for use in select element.
805 * The value is the url parameter and the before and after parameters are used
806 * between the text description.
808 * The 'html' format, which is the default, uses the li HTML element for use in
809 * the list HTML elements. The before parameter is before the link and the after
810 * parameter is after the closing link.
812 * The custom format uses the before parameter before the link ('a' HTML
813 * element) and the after parameter after the closing link tag. If the above
814 * three values for the format are not used, then custom format is assumed.
818 * @param string $url URL to archive.
819 * @param string $text Archive text description.
820 * @param string $format Optional, default is 'html'. Can be 'link', 'option', 'html', or custom.
821 * @param string $before Optional.
822 * @param string $after Optional.
823 * @return string HTML link content for archive.
825 function get_archives_link($url, $text, $format = 'html', $before = '', $after = '') {
826 $text = wptexturize($text);
827 $title_text = esc_attr($text);
828 $url = esc_url($url);
830 if ('link' == $format)
831 $link_html = "\t<link rel='archives' title='$title_text' href='$url' />\n";
832 elseif ('option' == $format)
833 $link_html = "\t<option value='$url'>$before $text $after</option>\n";
834 elseif ('html' == $format)
835 $link_html = "\t<li>$before<a href='$url' title='$title_text'>$text</a>$after</li>\n";
837 $link_html = "\t$before<a href='$url' title='$title_text'>$text</a>$after\n";
839 $link_html = apply_filters( 'get_archives_link', $link_html );
845 * Display archive links based on type and format.
847 * The 'type' argument offers a few choices and by default will display monthly
848 * archive links. The other options for values are 'daily', 'weekly', 'monthly',
849 * 'yearly', 'postbypost' or 'alpha'. Both 'postbypost' and 'alpha' display the
850 * same archive link list, the difference between the two is that 'alpha'
851 * will order by post title and 'postbypost' will order by post date.
853 * The date archives will logically display dates with links to the archive post
854 * page. The 'postbypost' and 'alpha' values for 'type' argument will display
857 * The 'limit' argument will only display a limited amount of links, specified
858 * by the 'limit' integer value. By default, there is no limit. The
859 * 'show_post_count' argument will show how many posts are within the archive.
860 * By default, the 'show_post_count' argument is set to false.
862 * For the 'format', 'before', and 'after' arguments, see {@link
863 * get_archives_link()}. The values of these arguments have to do with that
868 * @param string|array $args Optional. Override defaults.
869 * @return string|null String when retrieving, null when displaying.
871 function wp_get_archives($args = '') {
872 global $wpdb, $wp_locale;
875 'type' => 'monthly', 'limit' => '',
876 'format' => 'html', 'before' => '',
877 'after' => '', 'show_post_count' => false,
878 'echo' => 1, 'order' => 'DESC',
881 $r = wp_parse_args( $args, $defaults );
882 extract( $r, EXTR_SKIP );
887 if ( '' != $limit ) {
888 $limit = absint($limit);
889 $limit = ' LIMIT '.$limit;
892 $order = strtoupper( $order );
893 if ( $order !== 'ASC' )
896 // this is what will separate dates on weekly archive links
897 $archive_week_separator = '–';
899 // over-ride general date format ? 0 = no: use the date format set in Options, 1 = yes: over-ride
900 $archive_date_format_over_ride = 0;
902 // options for daily archive (only if you over-ride the general date format)
903 $archive_day_date_format = 'Y/m/d';
905 // options for weekly archive (only if you over-ride the general date format)
906 $archive_week_start_date_format = 'Y/m/d';
907 $archive_week_end_date_format = 'Y/m/d';
909 if ( !$archive_date_format_over_ride ) {
910 $archive_day_date_format = get_option('date_format');
911 $archive_week_start_date_format = get_option('date_format');
912 $archive_week_end_date_format = get_option('date_format');
916 $where = apply_filters( 'getarchives_where', "WHERE post_type = 'post' AND post_status = 'publish'", $r );
917 $join = apply_filters( 'getarchives_join', '', $r );
921 if ( 'monthly' == $type ) {
922 $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";
924 $cache = wp_cache_get( 'wp_get_archives' , 'general');
925 if ( !isset( $cache[ $key ] ) ) {
926 $arcresults = $wpdb->get_results($query);
927 $cache[ $key ] = $arcresults;
928 wp_cache_set( 'wp_get_archives', $cache, 'general' );
930 $arcresults = $cache[ $key ];
933 $afterafter = $after;
934 foreach ( (array) $arcresults as $arcresult ) {
935 $url = get_month_link( $arcresult->year, $arcresult->month );
936 /* translators: 1: month name, 2: 4-digit year */
937 $text = sprintf(__('%1$s %2$d'), $wp_locale->get_month($arcresult->month), $arcresult->year);
938 if ( $show_post_count )
939 $after = ' ('.$arcresult->posts.')' . $afterafter;
940 $output .= get_archives_link($url, $text, $format, $before, $after);
943 } elseif ('yearly' == $type) {
944 $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";
946 $cache = wp_cache_get( 'wp_get_archives' , 'general');
947 if ( !isset( $cache[ $key ] ) ) {
948 $arcresults = $wpdb->get_results($query);
949 $cache[ $key ] = $arcresults;
950 wp_cache_set( 'wp_get_archives', $cache, 'general' );
952 $arcresults = $cache[ $key ];
955 $afterafter = $after;
956 foreach ( (array) $arcresults as $arcresult) {
957 $url = get_year_link($arcresult->year);
958 $text = sprintf('%d', $arcresult->year);
959 if ($show_post_count)
960 $after = ' ('.$arcresult->posts.')' . $afterafter;
961 $output .= get_archives_link($url, $text, $format, $before, $after);
964 } elseif ( 'daily' == $type ) {
965 $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";
967 $cache = wp_cache_get( 'wp_get_archives' , 'general');
968 if ( !isset( $cache[ $key ] ) ) {
969 $arcresults = $wpdb->get_results($query);
970 $cache[ $key ] = $arcresults;
971 wp_cache_set( 'wp_get_archives', $cache, 'general' );
973 $arcresults = $cache[ $key ];
976 $afterafter = $after;
977 foreach ( (array) $arcresults as $arcresult ) {
978 $url = get_day_link($arcresult->year, $arcresult->month, $arcresult->dayofmonth);
979 $date = sprintf('%1$d-%2$02d-%3$02d 00:00:00', $arcresult->year, $arcresult->month, $arcresult->dayofmonth);
980 $text = mysql2date($archive_day_date_format, $date);
981 if ($show_post_count)
982 $after = ' ('.$arcresult->posts.')'.$afterafter;
983 $output .= get_archives_link($url, $text, $format, $before, $after);
986 } elseif ( 'weekly' == $type ) {
987 $week = _wp_mysql_week( '`post_date`' );
988 $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";
990 $cache = wp_cache_get( 'wp_get_archives' , 'general');
991 if ( !isset( $cache[ $key ] ) ) {
992 $arcresults = $wpdb->get_results($query);
993 $cache[ $key ] = $arcresults;
994 wp_cache_set( 'wp_get_archives', $cache, 'general' );
996 $arcresults = $cache[ $key ];
999 $afterafter = $after;
1000 if ( $arcresults ) {
1001 foreach ( (array) $arcresults as $arcresult ) {
1002 if ( $arcresult->week != $arc_w_last ) {
1003 $arc_year = $arcresult->yr;
1004 $arc_w_last = $arcresult->week;
1005 $arc_week = get_weekstartend($arcresult->yyyymmdd, get_option('start_of_week'));
1006 $arc_week_start = date_i18n($archive_week_start_date_format, $arc_week['start']);
1007 $arc_week_end = date_i18n($archive_week_end_date_format, $arc_week['end']);
1008 $url = sprintf('%1$s/%2$s%3$sm%4$s%5$s%6$sw%7$s%8$d', home_url(), '', '?', '=', $arc_year, '&', '=', $arcresult->week);
1009 $text = $arc_week_start . $archive_week_separator . $arc_week_end;
1010 if ($show_post_count)
1011 $after = ' ('.$arcresult->posts.')'.$afterafter;
1012 $output .= get_archives_link($url, $text, $format, $before, $after);
1016 } elseif ( ( 'postbypost' == $type ) || ('alpha' == $type) ) {
1017 $orderby = ('alpha' == $type) ? 'post_title ASC ' : 'post_date DESC ';
1018 $query = "SELECT * FROM $wpdb->posts $join $where ORDER BY $orderby $limit";
1020 $cache = wp_cache_get( 'wp_get_archives' , 'general');
1021 if ( !isset( $cache[ $key ] ) ) {
1022 $arcresults = $wpdb->get_results($query);
1023 $cache[ $key ] = $arcresults;
1024 wp_cache_set( 'wp_get_archives', $cache, 'general' );
1026 $arcresults = $cache[ $key ];
1028 if ( $arcresults ) {
1029 foreach ( (array) $arcresults as $arcresult ) {
1030 if ( $arcresult->post_date != '0000-00-00 00:00:00' ) {
1031 $url = get_permalink( $arcresult );
1032 if ( $arcresult->post_title )
1033 $text = strip_tags( apply_filters( 'the_title', $arcresult->post_title, $arcresult->ID ) );
1035 $text = $arcresult->ID;
1036 $output .= get_archives_link($url, $text, $format, $before, $after);
1048 * Get number of days since the start of the week.
1052 * @param int $num Number of day.
1053 * @return int Days since the start of the week.
1055 function calendar_week_mod($num) {
1057 return ($num - $base*floor($num/$base));
1061 * Display calendar with days that have posts as links.
1063 * The calendar is cached, which will be retrieved, if it exists. If there are
1064 * no posts for the month, then it will not be displayed.
1067 * @uses calendar_week_mod()
1069 * @param bool $initial Optional, default is true. Use initial calendar names.
1070 * @param bool $echo Optional, default is true. Set to false for return.
1071 * @return string|null String when retrieving, null when displaying.
1073 function get_calendar($initial = true, $echo = true) {
1074 global $wpdb, $m, $monthnum, $year, $wp_locale, $posts;
1077 $key = md5( $m . $monthnum . $year );
1078 if ( $cache = wp_cache_get( 'get_calendar', 'calendar' ) ) {
1079 if ( is_array($cache) && isset( $cache[ $key ] ) ) {
1081 echo apply_filters( 'get_calendar', $cache[$key] );
1084 return apply_filters( 'get_calendar', $cache[$key] );
1089 if ( !is_array($cache) )
1092 // Quick check. If we have no posts at all, abort!
1094 $gotsome = $wpdb->get_var("SELECT 1 as test FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish' LIMIT 1");
1096 $cache[ $key ] = '';
1097 wp_cache_set( 'get_calendar', $cache, 'calendar' );
1102 if ( isset($_GET['w']) )
1103 $w = ''.intval($_GET['w']);
1105 // week_begins = 0 stands for Sunday
1106 $week_begins = intval(get_option('start_of_week'));
1108 // Let's figure out when we are
1109 if ( !empty($monthnum) && !empty($year) ) {
1110 $thismonth = ''.zeroise(intval($monthnum), 2);
1111 $thisyear = ''.intval($year);
1112 } elseif ( !empty($w) ) {
1113 // We need to get the month from MySQL
1114 $thisyear = ''.intval(substr($m, 0, 4));
1115 $d = (($w - 1) * 7) + 6; //it seems MySQL's weeks disagree with PHP's
1116 $thismonth = $wpdb->get_var("SELECT DATE_FORMAT((DATE_ADD('{$thisyear}0101', INTERVAL $d DAY) ), '%m')");
1117 } elseif ( !empty($m) ) {
1118 $thisyear = ''.intval(substr($m, 0, 4));
1119 if ( strlen($m) < 6 )
1122 $thismonth = ''.zeroise(intval(substr($m, 4, 2)), 2);
1124 $thisyear = gmdate('Y', current_time('timestamp'));
1125 $thismonth = gmdate('m', current_time('timestamp'));
1128 $unixmonth = mktime(0, 0 , 0, $thismonth, 1, $thisyear);
1129 $last_day = date('t', $unixmonth);
1131 // Get the next and previous month and year with at least one post
1132 $previous = $wpdb->get_row("SELECT MONTH(post_date) AS month, YEAR(post_date) AS year
1134 WHERE post_date < '$thisyear-$thismonth-01'
1135 AND post_type = 'post' AND post_status = 'publish'
1136 ORDER BY post_date DESC
1138 $next = $wpdb->get_row("SELECT MONTH(post_date) AS month, YEAR(post_date) AS year
1140 WHERE post_date > '$thisyear-$thismonth-{$last_day} 23:59:59'
1141 AND post_type = 'post' AND post_status = 'publish'
1142 ORDER BY post_date ASC
1145 /* translators: Calendar caption: 1: month name, 2: 4-digit year */
1146 $calendar_caption = _x('%1$s %2$s', 'calendar caption');
1147 $calendar_output = '<table id="wp-calendar">
1148 <caption>' . sprintf($calendar_caption, $wp_locale->get_month($thismonth), date('Y', $unixmonth)) . '</caption>
1154 for ( $wdcount=0; $wdcount<=6; $wdcount++ ) {
1155 $myweek[] = $wp_locale->get_weekday(($wdcount+$week_begins)%7);
1158 foreach ( $myweek as $wd ) {
1159 $day_name = (true == $initial) ? $wp_locale->get_weekday_initial($wd) : $wp_locale->get_weekday_abbrev($wd);
1160 $wd = esc_attr($wd);
1161 $calendar_output .= "\n\t\t<th scope=\"col\" title=\"$wd\">$day_name</th>";
1164 $calendar_output .= '
1172 $calendar_output .= "\n\t\t".'<td colspan="3" id="prev"><a href="' . get_month_link($previous->year, $previous->month) . '" title="' . esc_attr( sprintf(__('View posts for %1$s %2$s'), $wp_locale->get_month($previous->month), date('Y', mktime(0, 0 , 0, $previous->month, 1, $previous->year)))) . '">« ' . $wp_locale->get_month_abbrev($wp_locale->get_month($previous->month)) . '</a></td>';
1174 $calendar_output .= "\n\t\t".'<td colspan="3" id="prev" class="pad"> </td>';
1177 $calendar_output .= "\n\t\t".'<td class="pad"> </td>';
1180 $calendar_output .= "\n\t\t".'<td colspan="3" id="next"><a href="' . get_month_link($next->year, $next->month) . '" title="' . esc_attr( sprintf(__('View posts for %1$s %2$s'), $wp_locale->get_month($next->month), date('Y', mktime(0, 0 , 0, $next->month, 1, $next->year))) ) . '">' . $wp_locale->get_month_abbrev($wp_locale->get_month($next->month)) . ' »</a></td>';
1182 $calendar_output .= "\n\t\t".'<td colspan="3" id="next" class="pad"> </td>';
1185 $calendar_output .= '
1192 // Get days with posts
1193 $dayswithposts = $wpdb->get_results("SELECT DISTINCT DAYOFMONTH(post_date)
1194 FROM $wpdb->posts WHERE post_date >= '{$thisyear}-{$thismonth}-01 00:00:00'
1195 AND post_type = 'post' AND post_status = 'publish'
1196 AND post_date <= '{$thisyear}-{$thismonth}-{$last_day} 23:59:59'", ARRAY_N);
1197 if ( $dayswithposts ) {
1198 foreach ( (array) $dayswithposts as $daywith ) {
1199 $daywithpost[] = $daywith[0];
1202 $daywithpost = array();
1205 if (strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE') !== false || stripos($_SERVER['HTTP_USER_AGENT'], 'camino') !== false || stripos($_SERVER['HTTP_USER_AGENT'], 'safari') !== false)
1206 $ak_title_separator = "\n";
1208 $ak_title_separator = ', ';
1210 $ak_titles_for_day = array();
1211 $ak_post_titles = $wpdb->get_results("SELECT ID, post_title, DAYOFMONTH(post_date) as dom "
1212 ."FROM $wpdb->posts "
1213 ."WHERE post_date >= '{$thisyear}-{$thismonth}-01 00:00:00' "
1214 ."AND post_date <= '{$thisyear}-{$thismonth}-{$last_day} 23:59:59' "
1215 ."AND post_type = 'post' AND post_status = 'publish'"
1217 if ( $ak_post_titles ) {
1218 foreach ( (array) $ak_post_titles as $ak_post_title ) {
1220 $post_title = esc_attr( apply_filters( 'the_title', $ak_post_title->post_title, $ak_post_title->ID ) );
1222 if ( empty($ak_titles_for_day['day_'.$ak_post_title->dom]) )
1223 $ak_titles_for_day['day_'.$ak_post_title->dom] = '';
1224 if ( empty($ak_titles_for_day["$ak_post_title->dom"]) ) // first one
1225 $ak_titles_for_day["$ak_post_title->dom"] = $post_title;
1227 $ak_titles_for_day["$ak_post_title->dom"] .= $ak_title_separator . $post_title;
1231 // See how much we should pad in the beginning
1232 $pad = calendar_week_mod(date('w', $unixmonth)-$week_begins);
1234 $calendar_output .= "\n\t\t".'<td colspan="'. esc_attr($pad) .'" class="pad"> </td>';
1236 $daysinmonth = intval(date('t', $unixmonth));
1237 for ( $day = 1; $day <= $daysinmonth; ++$day ) {
1238 if ( isset($newrow) && $newrow )
1239 $calendar_output .= "\n\t</tr>\n\t<tr>\n\t\t";
1242 if ( $day == gmdate('j', current_time('timestamp')) && $thismonth == gmdate('m', current_time('timestamp')) && $thisyear == gmdate('Y', current_time('timestamp')) )
1243 $calendar_output .= '<td id="today">';
1245 $calendar_output .= '<td>';
1247 if ( in_array($day, $daywithpost) ) // any posts today?
1248 $calendar_output .= '<a href="' . get_day_link( $thisyear, $thismonth, $day ) . '" title="' . esc_attr( $ak_titles_for_day[ $day ] ) . "\">$day</a>";
1250 $calendar_output .= $day;
1251 $calendar_output .= '</td>';
1253 if ( 6 == calendar_week_mod(date('w', mktime(0, 0 , 0, $thismonth, $day, $thisyear))-$week_begins) )
1257 $pad = 7 - calendar_week_mod(date('w', mktime(0, 0 , 0, $thismonth, $day, $thisyear))-$week_begins);
1258 if ( $pad != 0 && $pad != 7 )
1259 $calendar_output .= "\n\t\t".'<td class="pad" colspan="'. esc_attr($pad) .'"> </td>';
1261 $calendar_output .= "\n\t</tr>\n\t</tbody>\n\t</table>";
1263 $cache[ $key ] = $calendar_output;
1264 wp_cache_set( 'get_calendar', $cache, 'calendar' );
1267 echo apply_filters( 'get_calendar', $calendar_output );
1269 return apply_filters( 'get_calendar', $calendar_output );
1274 * Purge the cached results of get_calendar.
1279 function delete_get_calendar_cache() {
1280 wp_cache_delete( 'get_calendar', 'calendar' );
1282 add_action( 'save_post', 'delete_get_calendar_cache' );
1283 add_action( 'delete_post', 'delete_get_calendar_cache' );
1284 add_action( 'update_option_start_of_week', 'delete_get_calendar_cache' );
1285 add_action( 'update_option_gmt_offset', 'delete_get_calendar_cache' );
1288 * Display all of the allowed tags in HTML format with attributes.
1290 * This is useful for displaying in the comment area, which elements and
1291 * attributes are supported. As well as any plugins which want to display it.
1294 * @uses $allowedtags
1296 * @return string HTML allowed tags entity encoded.
1298 function allowed_tags() {
1299 global $allowedtags;
1301 foreach ( (array) $allowedtags as $tag => $attributes ) {
1302 $allowed .= '<'.$tag;
1303 if ( 0 < count($attributes) ) {
1304 foreach ( $attributes as $attribute => $limits ) {
1305 $allowed .= ' '.$attribute.'=""';
1310 return htmlentities($allowed);
1313 /***** Date/Time tags *****/
1316 * Outputs the date in iso8601 format for xml files.
1320 function the_date_xml() {
1321 echo mysql2date( 'Y-m-d', get_post()->post_date, false );
1325 * Display or Retrieve the date the current $post was written (once per date)
1327 * Will only output the date if the current post's date is different from the
1328 * previous one output.
1330 * i.e. Only one date listing will show per day worth of posts shown in the loop, even if the
1331 * function is called several times for each post.
1333 * HTML output can be filtered with 'the_date'.
1334 * Date string output can be filtered with 'get_the_date'.
1337 * @uses get_the_date()
1338 * @param string $d Optional. PHP date format defaults to the date_format option if not specified.
1339 * @param string $before Optional. Output before the date.
1340 * @param string $after Optional. Output after the date.
1341 * @param bool $echo Optional, default is display. Whether to echo the date or return it.
1342 * @return string|null Null if displaying, string if retrieving.
1344 function the_date( $d = '', $before = '', $after = '', $echo = true ) {
1345 global $currentday, $previousday;
1347 if ( $currentday != $previousday ) {
1348 $the_date .= $before;
1349 $the_date .= get_the_date( $d );
1350 $the_date .= $after;
1351 $previousday = $currentday;
1353 $the_date = apply_filters('the_date', $the_date, $d, $before, $after);
1365 * Retrieve the date the current $post was written.
1367 * Unlike the_date() this function will always return the date.
1368 * Modify output with 'get_the_date' filter.
1372 * @param string $d Optional. PHP date format defaults to the date_format option if not specified.
1373 * @return string|null Null if displaying, string if retrieving.
1375 function get_the_date( $d = '' ) {
1380 $the_date .= mysql2date(get_option('date_format'), $post->post_date);
1382 $the_date .= mysql2date($d, $post->post_date);
1384 return apply_filters('get_the_date', $the_date, $d);
1388 * Display the date on which the post was last modified.
1392 * @param string $d Optional. PHP date format defaults to the date_format option if not specified.
1393 * @param string $before Optional. Output before the date.
1394 * @param string $after Optional. Output after the date.
1395 * @param bool $echo Optional, default is display. Whether to echo the date or return it.
1396 * @return string|null Null if displaying, string if retrieving.
1398 function the_modified_date($d = '', $before='', $after='', $echo = true) {
1400 $the_modified_date = $before . get_the_modified_date($d) . $after;
1401 $the_modified_date = apply_filters('the_modified_date', $the_modified_date, $d, $before, $after);
1404 echo $the_modified_date;
1406 return $the_modified_date;
1411 * Retrieve the date on which the post was last modified.
1415 * @param string $d Optional. PHP date format. Defaults to the "date_format" option
1418 function get_the_modified_date($d = '') {
1420 $the_time = get_post_modified_time(get_option('date_format'), null, null, true);
1422 $the_time = get_post_modified_time($d, null, null, true);
1423 return apply_filters('get_the_modified_date', $the_time, $d);
1427 * Display the time at which the post was written.
1431 * @param string $d Either 'G', 'U', or php date format.
1433 function the_time( $d = '' ) {
1434 echo apply_filters('the_time', get_the_time( $d ), $d);
1438 * Retrieve the time at which the post was written.
1442 * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
1443 * @param int|object $post Optional post ID or object. Default is global $post object.
1446 function get_the_time( $d = '', $post = null ) {
1447 $post = get_post($post);
1450 $the_time = get_post_time(get_option('time_format'), false, $post, true);
1452 $the_time = get_post_time($d, false, $post, true);
1453 return apply_filters('get_the_time', $the_time, $d, $post);
1457 * Retrieve the time at which the post was written.
1461 * @param string $d Optional Either 'G', 'U', or php date format.
1462 * @param bool $gmt Optional, default is false. Whether to return the gmt time.
1463 * @param int|object $post Optional post ID or object. Default is global $post object.
1464 * @param bool $translate Whether to translate the time string
1467 function get_post_time( $d = 'U', $gmt = false, $post = null, $translate = false ) { // returns timestamp
1468 $post = get_post($post);
1471 $time = $post->post_date_gmt;
1473 $time = $post->post_date;
1475 $time = mysql2date($d, $time, $translate);
1476 return apply_filters('get_post_time', $time, $d, $gmt);
1480 * Display the time at which the post was last modified.
1484 * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
1486 function the_modified_time($d = '') {
1487 echo apply_filters('the_modified_time', get_the_modified_time($d), $d);
1491 * Retrieve the time at which the post was last modified.
1495 * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
1498 function get_the_modified_time($d = '') {
1500 $the_time = get_post_modified_time(get_option('time_format'), null, null, true);
1502 $the_time = get_post_modified_time($d, null, null, true);
1503 return apply_filters('get_the_modified_time', $the_time, $d);
1507 * Retrieve the time at which the post was last modified.
1511 * @param string $d Optional, default is 'U'. Either 'G', 'U', or php date format.
1512 * @param bool $gmt Optional, default is false. Whether to return the gmt time.
1513 * @param int|object $post Optional, default is global post object. A post_id or post object
1514 * @param bool $translate Optional, default is false. Whether to translate the result
1515 * @return string Returns timestamp
1517 function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
1518 $post = get_post($post);
1521 $time = $post->post_modified_gmt;
1523 $time = $post->post_modified;
1524 $time = mysql2date($d, $time, $translate);
1526 return apply_filters('get_post_modified_time', $time, $d, $gmt);
1530 * Display the weekday on which the post was written.
1536 function the_weekday() {
1538 $the_weekday = $wp_locale->get_weekday( mysql2date( 'w', get_post()->post_date, false ) );
1539 $the_weekday = apply_filters('the_weekday', $the_weekday);
1544 * Display the weekday on which the post was written.
1546 * Will only output the weekday if the current post's weekday is different from
1547 * the previous one output.
1551 * @param string $before Optional Output before the date.
1552 * @param string $after Optional Output after the date.
1554 function the_weekday_date($before='',$after='') {
1555 global $wp_locale, $day, $previousweekday;
1556 $the_weekday_date = '';
1557 if ( $currentday != $previousweekday ) {
1558 $the_weekday_date .= $before;
1559 $the_weekday_date .= $wp_locale->get_weekday( mysql2date( 'w', get_post()->post_date, false ) );
1560 $the_weekday_date .= $after;
1561 $previousweekday = $currentday;
1563 $the_weekday_date = apply_filters('the_weekday_date', $the_weekday_date, $before, $after);
1564 echo $the_weekday_date;
1568 * Fire the wp_head action
1571 * @uses do_action() Calls 'wp_head' hook.
1573 function wp_head() {
1574 do_action('wp_head');
1578 * Fire the wp_footer action
1581 * @uses do_action() Calls 'wp_footer' hook.
1583 function wp_footer() {
1584 do_action('wp_footer');
1588 * Display the links to the general feeds.
1592 * @param array $args Optional arguments.
1594 function feed_links( $args = array() ) {
1595 if ( !current_theme_supports('automatic-feed-links') )
1599 /* translators: Separator between blog name and feed type in feed links */
1600 'separator' => _x('»', 'feed link'),
1601 /* translators: 1: blog title, 2: separator (raquo) */
1602 'feedtitle' => __('%1$s %2$s Feed'),
1603 /* translators: %s: blog title, 2: separator (raquo) */
1604 'comstitle' => __('%1$s %2$s Comments Feed'),
1607 $args = wp_parse_args( $args, $defaults );
1609 echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . esc_attr(sprintf( $args['feedtitle'], get_bloginfo('name'), $args['separator'] )) . '" href="' . get_feed_link() . "\" />\n";
1610 echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . esc_attr(sprintf( $args['comstitle'], get_bloginfo('name'), $args['separator'] )) . '" href="' . get_feed_link( 'comments_' . get_default_feed() ) . "\" />\n";
1614 * Display the links to the extra feeds such as category feeds.
1618 * @param array $args Optional arguments.
1620 function feed_links_extra( $args = array() ) {
1622 /* translators: Separator between blog name and feed type in feed links */
1623 'separator' => _x('»', 'feed link'),
1624 /* translators: 1: blog name, 2: separator(raquo), 3: post title */
1625 'singletitle' => __('%1$s %2$s %3$s Comments Feed'),
1626 /* translators: 1: blog name, 2: separator(raquo), 3: category name */
1627 'cattitle' => __('%1$s %2$s %3$s Category Feed'),
1628 /* translators: 1: blog name, 2: separator(raquo), 3: tag name */
1629 'tagtitle' => __('%1$s %2$s %3$s Tag Feed'),
1630 /* translators: 1: blog name, 2: separator(raquo), 3: author name */
1631 'authortitle' => __('%1$s %2$s Posts by %3$s Feed'),
1632 /* translators: 1: blog name, 2: separator(raquo), 3: search phrase */
1633 'searchtitle' => __('%1$s %2$s Search Results for “%3$s” Feed'),
1634 /* translators: 1: blog name, 2: separator(raquo), 3: post type name */
1635 'posttypetitle' => __('%1$s %2$s %3$s Feed'),
1638 $args = wp_parse_args( $args, $defaults );
1640 if ( is_single() || is_page() ) {
1642 $post = get_post( $id );
1644 if ( comments_open() || pings_open() || $post->comment_count > 0 ) {
1645 $title = sprintf( $args['singletitle'], get_bloginfo('name'), $args['separator'], esc_html( get_the_title() ) );
1646 $href = get_post_comments_feed_link( $post->ID );
1648 } elseif ( is_category() ) {
1649 $term = get_queried_object();
1651 $title = sprintf( $args['cattitle'], get_bloginfo('name'), $args['separator'], $term->name );
1652 $href = get_category_feed_link( $term->term_id );
1653 } elseif ( is_tag() ) {
1654 $term = get_queried_object();
1656 $title = sprintf( $args['tagtitle'], get_bloginfo('name'), $args['separator'], $term->name );
1657 $href = get_tag_feed_link( $term->term_id );
1658 } elseif ( is_author() ) {
1659 $author_id = intval( get_query_var('author') );
1661 $title = sprintf( $args['authortitle'], get_bloginfo('name'), $args['separator'], get_the_author_meta( 'display_name', $author_id ) );
1662 $href = get_author_feed_link( $author_id );
1663 } elseif ( is_search() ) {
1664 $title = sprintf( $args['searchtitle'], get_bloginfo('name'), $args['separator'], get_search_query( false ) );
1665 $href = get_search_feed_link();
1666 } elseif ( is_post_type_archive() ) {
1667 $title = sprintf( $args['posttypetitle'], get_bloginfo('name'), $args['separator'], post_type_archive_title( '', false ) );
1668 $href = get_post_type_archive_feed_link( get_queried_object()->name );
1671 if ( isset($title) && isset($href) )
1672 echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . esc_attr( $title ) . '" href="' . esc_url( $href ) . '" />' . "\n";
1676 * Display the link to the Really Simple Discovery service endpoint.
1678 * @link http://archipelago.phrasewise.com/rsd
1681 function rsd_link() {
1682 echo '<link rel="EditURI" type="application/rsd+xml" title="RSD" href="' . get_bloginfo('wpurl') . "/xmlrpc.php?rsd\" />\n";
1686 * Display the link to the Windows Live Writer manifest file.
1688 * @link http://msdn.microsoft.com/en-us/library/bb463265.aspx
1691 function wlwmanifest_link() {
1692 echo '<link rel="wlwmanifest" type="application/wlwmanifest+xml" href="'
1693 . get_bloginfo('wpurl') . '/wp-includes/wlwmanifest.xml" /> ' . "\n";
1697 * Display a noindex meta tag if required by the blog configuration.
1699 * If a blog is marked as not being public then the noindex meta tag will be
1700 * output to tell web robots not to index the page content. Add this to the wp_head action.
1701 * Typical usage is as a wp_head callback. add_action( 'wp_head', 'noindex' );
1707 function noindex() {
1708 // If the blog is not public, tell robots to go away.
1709 if ( '0' == get_option('blog_public') )
1714 * Display a noindex meta tag.
1716 * Outputs a noindex meta tag that tells web robots not to index the page content.
1717 * Typical usage is as a wp_head callback. add_action( 'wp_head', 'wp_no_robots' );
1721 function wp_no_robots() {
1722 echo "<meta name='robots' content='noindex,nofollow' />\n";
1726 * Determine if TinyMCE is available.
1728 * Checks to see if the user has deleted the tinymce files to slim down there WordPress install.
1732 * @return bool Whether TinyMCE exists.
1734 function rich_edit_exists() {
1735 global $wp_rich_edit_exists;
1736 if ( !isset($wp_rich_edit_exists) )
1737 $wp_rich_edit_exists = file_exists(ABSPATH . WPINC . '/js/tinymce/tiny_mce.js');
1738 return $wp_rich_edit_exists;
1742 * Whether the user should have a WYSIWIG editor.
1744 * Checks that the user requires a WYSIWIG editor and that the editor is
1745 * supported in the users browser.
1751 function user_can_richedit() {
1752 global $wp_rich_edit, $is_gecko, $is_opera, $is_safari, $is_chrome, $is_IE;
1754 if ( !isset($wp_rich_edit) ) {
1755 $wp_rich_edit = false;
1757 if ( get_user_option( 'rich_editing' ) == 'true' || ! is_user_logged_in() ) { // default to 'true' for logged out users
1759 $wp_rich_edit = ! wp_is_mobile() || ( preg_match( '!AppleWebKit/(\d+)!', $_SERVER['HTTP_USER_AGENT'], $match ) && intval( $match[1] ) >= 534 );
1760 } elseif ( $is_gecko || $is_chrome || $is_IE || ( $is_opera && !wp_is_mobile() ) ) {
1761 $wp_rich_edit = true;
1766 return apply_filters('user_can_richedit', $wp_rich_edit);
1770 * Find out which editor should be displayed by default.
1772 * Works out which of the two editors to display as the current editor for a
1773 * user. The 'html' setting is for the "Text" editor tab.
1777 * @return string Either 'tinymce', or 'html', or 'test'
1779 function wp_default_editor() {
1780 $r = user_can_richedit() ? 'tinymce' : 'html'; // defaults
1781 if ( $user = wp_get_current_user() ) { // look for cookie
1782 $ed = get_user_setting('editor', 'tinymce');
1783 $r = ( in_array($ed, array('tinymce', 'html', 'test') ) ) ? $ed : $r;
1785 return apply_filters( 'wp_default_editor', $r ); // filter
1789 * Renders an editor.
1791 * Using this function is the proper way to output all needed components for both TinyMCE and Quicktags.
1792 * _WP_Editors should not be used directly. See http://core.trac.wordpress.org/ticket/17144.
1794 * NOTE: Once initialized the TinyMCE editor cannot be safely moved in the DOM. For that reason
1795 * running wp_editor() inside of a metabox is not a good idea unless only Quicktags is used.
1796 * On the post edit screen several actions can be used to include additional editors
1797 * containing TinyMCE: 'edit_page_form', 'edit_form_advanced' and 'dbx_post_sidebar'.
1798 * See http://core.trac.wordpress.org/ticket/19173 for more information.
1800 * @see wp-includes/class-wp-editor.php
1803 * @param string $content Initial content for the editor.
1804 * @param string $editor_id HTML ID attribute value for the textarea and TinyMCE. Can only be /[a-z]+/.
1805 * @param array $settings See _WP_Editors::editor().
1807 function wp_editor( $content, $editor_id, $settings = array() ) {
1808 if ( ! class_exists( '_WP_Editors' ) )
1809 require( ABSPATH . WPINC . '/class-wp-editor.php' );
1811 _WP_Editors::editor($content, $editor_id, $settings);
1815 * Retrieve the contents of the search WordPress query variable.
1817 * The search query string is passed through {@link esc_attr()}
1818 * to ensure that it is safe for placing in an html attribute.
1823 * @param bool $escaped Whether the result is escaped. Default true.
1824 * Only use when you are later escaping it. Do not use unescaped.
1827 function get_search_query( $escaped = true ) {
1828 $query = apply_filters( 'get_search_query', get_query_var( 's' ) );
1830 $query = esc_attr( $query );
1835 * Display the contents of the search query variable.
1837 * The search query string is passed through {@link esc_attr()}
1838 * to ensure that it is safe for placing in an html attribute.
1843 function the_search_query() {
1844 echo esc_attr( apply_filters( 'the_search_query', get_search_query( false ) ) );
1848 * Display the language attributes for the html tag.
1850 * Builds up a set of html attributes containing the text direction and language
1851 * information for the page.
1855 * @param string $doctype The type of html document (xhtml|html).
1857 function language_attributes($doctype = 'html') {
1858 $attributes = array();
1861 if ( function_exists( 'is_rtl' ) && is_rtl() )
1862 $attributes[] = 'dir="rtl"';
1864 if ( $lang = get_bloginfo('language') ) {
1865 if ( get_option('html_type') == 'text/html' || $doctype == 'html' )
1866 $attributes[] = "lang=\"$lang\"";
1868 if ( get_option('html_type') != 'text/html' || $doctype == 'xhtml' )
1869 $attributes[] = "xml:lang=\"$lang\"";
1872 $output = implode(' ', $attributes);
1873 $output = apply_filters('language_attributes', $output);
1878 * Retrieve paginated link for archive post pages.
1880 * Technically, the function can be used to create paginated link list for any
1881 * area. The 'base' argument is used to reference the url, which will be used to
1882 * create the paginated links. The 'format' argument is then used for replacing
1883 * the page number. It is however, most likely and by default, to be used on the
1884 * archive post pages.
1886 * The 'type' argument controls format of the returned value. The default is
1887 * 'plain', which is just a string with the links separated by a newline
1888 * character. The other possible values are either 'array' or 'list'. The
1889 * 'array' value will return an array of the paginated link list to offer full
1890 * control of display. The 'list' value will place all of the paginated links in
1891 * an unordered HTML list.
1893 * The 'total' argument is the total amount of pages and is an integer. The
1894 * 'current' argument is the current page number and is also an integer.
1896 * An example of the 'base' argument is "http://example.com/all_posts.php%_%"
1897 * and the '%_%' is required. The '%_%' will be replaced by the contents of in
1898 * the 'format' argument. An example for the 'format' argument is "?page=%#%"
1899 * and the '%#%' is also required. The '%#%' will be replaced with the page
1902 * You can include the previous and next links in the list by setting the
1903 * 'prev_next' argument to true, which it is by default. You can set the
1904 * previous text, by using the 'prev_text' argument. You can set the next text
1905 * by setting the 'next_text' argument.
1907 * If the 'show_all' argument is set to true, then it will show all of the pages
1908 * instead of a short list of the pages near the current page. By default, the
1909 * 'show_all' is set to false and controlled by the 'end_size' and 'mid_size'
1910 * arguments. The 'end_size' argument is how many numbers on either the start
1911 * and the end list edges, by default is 1. The 'mid_size' argument is how many
1912 * numbers to either side of current page, but not including current page.
1914 * It is possible to add query vars to the link by using the 'add_args' argument
1915 * and see {@link add_query_arg()} for more information.
1919 * @param string|array $args Optional. Override defaults.
1920 * @return array|string String of page links or array of page links.
1922 function paginate_links( $args = '' ) {
1924 'base' => '%_%', // http://example.com/all_posts.php%_% : %_% is replaced by format (below)
1925 'format' => '?page=%#%', // ?page=%#% : %#% is replaced by the page number
1928 'show_all' => false,
1929 'prev_next' => true,
1930 'prev_text' => __('« Previous'),
1931 'next_text' => __('Next »'),
1935 'add_args' => false, // array of query args to add
1936 'add_fragment' => ''
1939 $args = wp_parse_args( $args, $defaults );
1940 extract($args, EXTR_SKIP);
1942 // Who knows what else people pass in $args
1943 $total = (int) $total;
1946 $current = (int) $current;
1947 $end_size = 0 < (int) $end_size ? (int) $end_size : 1; // Out of bounds? Make it the default.
1948 $mid_size = 0 <= (int) $mid_size ? (int) $mid_size : 2;
1949 $add_args = is_array($add_args) ? $add_args : false;
1951 $page_links = array();
1955 if ( $prev_next && $current && 1 < $current ) :
1956 $link = str_replace('%_%', 2 == $current ? '' : $format, $base);
1957 $link = str_replace('%#%', $current - 1, $link);
1959 $link = add_query_arg( $add_args, $link );
1960 $link .= $add_fragment;
1961 $page_links[] = '<a class="prev page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $prev_text . '</a>';
1963 for ( $n = 1; $n <= $total; $n++ ) :
1964 $n_display = number_format_i18n($n);
1965 if ( $n == $current ) :
1966 $page_links[] = "<span class='page-numbers current'>$n_display</span>";
1969 if ( $show_all || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :
1970 $link = str_replace('%_%', 1 == $n ? '' : $format, $base);
1971 $link = str_replace('%#%', $n, $link);
1973 $link = add_query_arg( $add_args, $link );
1974 $link .= $add_fragment;
1975 $page_links[] = "<a class='page-numbers' href='" . esc_url( apply_filters( 'paginate_links', $link ) ) . "'>$n_display</a>";
1977 elseif ( $dots && !$show_all ) :
1978 $page_links[] = '<span class="page-numbers dots">' . __( '…' ) . '</span>';
1983 if ( $prev_next && $current && ( $current < $total || -1 == $total ) ) :
1984 $link = str_replace('%_%', $format, $base);
1985 $link = str_replace('%#%', $current + 1, $link);
1987 $link = add_query_arg( $add_args, $link );
1988 $link .= $add_fragment;
1989 $page_links[] = '<a class="next page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $next_text . '</a>';
1996 $r .= "<ul class='page-numbers'>\n\t<li>";
1997 $r .= join("</li>\n\t<li>", $page_links);
1998 $r .= "</li>\n</ul>\n";
2001 $r = join("\n", $page_links);
2008 * Registers an admin colour scheme css file.
2010 * Allows a plugin to register a new admin colour scheme. For example:
2012 * wp_admin_css_color('classic', __('Classic'), admin_url("css/colors-classic.css"),
2013 * array('#07273E', '#14568A', '#D54E21', '#2683AE'));
2018 * @param string $key The unique key for this theme.
2019 * @param string $name The name of the theme.
2020 * @param string $url The url of the css file containing the colour scheme.
2021 * @param array $colors Optional An array of CSS color definitions which are used to give the user a feel for the theme.
2023 function wp_admin_css_color($key, $name, $url, $colors = array()) {
2024 global $_wp_admin_css_colors;
2026 if ( !isset($_wp_admin_css_colors) )
2027 $_wp_admin_css_colors = array();
2029 $_wp_admin_css_colors[$key] = (object) array('name' => $name, 'url' => $url, 'colors' => $colors);
2033 * Registers the default Admin color schemes
2037 function register_admin_color_schemes() {
2038 wp_admin_css_color( 'classic', _x( 'Blue', 'admin color scheme' ), admin_url( 'css/colors-classic.min.css' ),
2039 array( '#5589aa', '#cfdfe9', '#d1e5ee', '#eff8ff' ) );
2040 wp_admin_css_color( 'fresh', _x( 'Gray', 'admin color scheme' ), admin_url( 'css/colors-fresh.min.css' ),
2041 array( '#555', '#a0a0a0', '#ccc', '#f1f1f1' ) );
2045 * Display the URL of a WordPress admin CSS file.
2047 * @see WP_Styles::_css_href and its style_loader_src filter.
2051 * @param string $file file relative to wp-admin/ without its ".css" extension.
2053 function wp_admin_css_uri( $file = 'wp-admin' ) {
2054 if ( defined('WP_INSTALLING') ) {
2055 $_file = "./$file.css";
2057 $_file = admin_url("$file.css");
2059 $_file = add_query_arg( 'version', get_bloginfo( 'version' ), $_file );
2061 return apply_filters( 'wp_admin_css_uri', $_file, $file );
2065 * Enqueues or directly prints a stylesheet link to the specified CSS file.
2067 * "Intelligently" decides to enqueue or to print the CSS file. If the
2068 * 'wp_print_styles' action has *not* yet been called, the CSS file will be
2069 * enqueued. If the wp_print_styles action *has* been called, the CSS link will
2070 * be printed. Printing may be forced by passing true as the $force_echo
2071 * (second) parameter.
2073 * For backward compatibility with WordPress 2.3 calling method: If the $file
2074 * (first) parameter does not correspond to a registered CSS file, we assume
2075 * $file is a file relative to wp-admin/ without its ".css" extension. A
2076 * stylesheet link to that generated URL is printed.
2078 * @package WordPress
2080 * @uses $wp_styles WordPress Styles Object
2082 * @param string $file Optional. Style handle name or file name (without ".css" extension) relative
2083 * to wp-admin/. Defaults to 'wp-admin'.
2084 * @param bool $force_echo Optional. Force the stylesheet link to be printed rather than enqueued.
2086 function wp_admin_css( $file = 'wp-admin', $force_echo = false ) {
2088 if ( !is_a($wp_styles, 'WP_Styles') )
2089 $wp_styles = new WP_Styles();
2091 // For backward compatibility
2092 $handle = 0 === strpos( $file, 'css/' ) ? substr( $file, 4 ) : $file;
2094 if ( $wp_styles->query( $handle ) ) {
2095 if ( $force_echo || did_action( 'wp_print_styles' ) ) // we already printed the style queue. Print this one immediately
2096 wp_print_styles( $handle );
2097 else // Add to style queue
2098 wp_enqueue_style( $handle );
2102 echo apply_filters( 'wp_admin_css', "<link rel='stylesheet' href='" . esc_url( wp_admin_css_uri( $file ) ) . "' type='text/css' />\n", $file );
2103 if ( function_exists( 'is_rtl' ) && is_rtl() )
2104 echo apply_filters( 'wp_admin_css', "<link rel='stylesheet' href='" . esc_url( wp_admin_css_uri( "$file-rtl" ) ) . "' type='text/css' />\n", "$file-rtl" );
2108 * Enqueues the default ThickBox js and css.
2110 * If any of the settings need to be changed, this can be done with another js
2111 * file similar to media-upload.js. That file should
2112 * require array('thickbox') to ensure it is loaded after.
2116 function add_thickbox() {
2117 wp_enqueue_script( 'thickbox' );
2118 wp_enqueue_style( 'thickbox' );
2120 if ( is_network_admin() )
2121 add_action( 'admin_head', '_thickbox_path_admin_subfolder' );
2125 * Display the XHTML generator that is generated on the wp_head hook.
2129 function wp_generator() {
2130 the_generator( apply_filters( 'wp_generator_type', 'xhtml' ) );
2134 * Display the generator XML or Comment for RSS, ATOM, etc.
2136 * Returns the correct generator type for the requested output format. Allows
2137 * for a plugin to filter generators overall the the_generator filter.
2140 * @uses apply_filters() Calls 'the_generator' hook.
2142 * @param string $type The type of generator to output - (html|xhtml|atom|rss2|rdf|comment|export).
2144 function the_generator( $type ) {
2145 echo apply_filters('the_generator', get_the_generator($type), $type) . "\n";
2149 * Creates the generator XML or Comment for RSS, ATOM, etc.
2151 * Returns the correct generator type for the requested output format. Allows
2152 * for a plugin to filter generators on an individual basis using the
2153 * 'get_the_generator_{$type}' filter.
2156 * @uses apply_filters() Calls 'get_the_generator_$type' hook.
2158 * @param string $type The type of generator to return - (html|xhtml|atom|rss2|rdf|comment|export).
2159 * @return string The HTML content for the generator.
2161 function get_the_generator( $type = '' ) {
2162 if ( empty( $type ) ) {
2164 $current_filter = current_filter();
2165 if ( empty( $current_filter ) )
2168 switch ( $current_filter ) {
2170 case 'commentsrss2_head' :
2181 case 'comments_atom_head' :
2190 $gen = '<meta name="generator" content="WordPress ' . get_bloginfo( 'version' ) . '">';
2193 $gen = '<meta name="generator" content="WordPress ' . get_bloginfo( 'version' ) . '" />';
2196 $gen = '<generator uri="http://wordpress.org/" version="' . get_bloginfo_rss( 'version' ) . '">WordPress</generator>';
2199 $gen = '<generator>http://wordpress.org/?v=' . get_bloginfo_rss( 'version' ) . '</generator>';
2202 $gen = '<admin:generatorAgent rdf:resource="http://wordpress.org/?v=' . get_bloginfo_rss( 'version' ) . '" />';
2205 $gen = '<!-- generator="WordPress/' . get_bloginfo( 'version' ) . '" -->';
2208 $gen = '<!-- generator="WordPress/' . get_bloginfo_rss('version') . '" created="'. date('Y-m-d H:i') . '" -->';
2211 return apply_filters( "get_the_generator_{$type}", $gen, $type );
2215 * Outputs the html checked attribute.
2217 * Compares the first two arguments and if identical marks as checked
2221 * @param mixed $checked One of the values to compare
2222 * @param mixed $current (true) The other value to compare if not just true
2223 * @param bool $echo Whether to echo or just return the string
2224 * @return string html attribute or empty string
2226 function checked( $checked, $current = true, $echo = true ) {
2227 return __checked_selected_helper( $checked, $current, $echo, 'checked' );
2231 * Outputs the html selected attribute.
2233 * Compares the first two arguments and if identical marks as selected
2237 * @param mixed $selected One of the values to compare
2238 * @param mixed $current (true) The other value to compare if not just true
2239 * @param bool $echo Whether to echo or just return the string
2240 * @return string html attribute or empty string
2242 function selected( $selected, $current = true, $echo = true ) {
2243 return __checked_selected_helper( $selected, $current, $echo, 'selected' );
2247 * Outputs the html disabled attribute.
2249 * Compares the first two arguments and if identical marks as disabled
2253 * @param mixed $disabled One of the values to compare
2254 * @param mixed $current (true) The other value to compare if not just true
2255 * @param bool $echo Whether to echo or just return the string
2256 * @return string html attribute or empty string
2258 function disabled( $disabled, $current = true, $echo = true ) {
2259 return __checked_selected_helper( $disabled, $current, $echo, 'disabled' );
2263 * Private helper function for checked, selected, and disabled.
2265 * Compares the first two arguments and if identical marks as $type
2270 * @param mixed $helper One of the values to compare
2271 * @param mixed $current (true) The other value to compare if not just true
2272 * @param bool $echo Whether to echo or just return the string
2273 * @param string $type The type of checked|selected|disabled we are doing
2274 * @return string html attribute or empty string
2276 function __checked_selected_helper( $helper, $current, $echo, $type ) {
2277 if ( (string) $helper === (string) $current )
2278 $result = " $type='$type'";