WordPress.org

Make WordPress Core

Ticket #16177: general-template.php

File general-template.php, 78.8 KB (added by jtlowe22, 4 years ago)

general-template.php containing the updated bloginfo() parameter

Line 
1<?php
2/**
3 * General template tags that can go anywhere in a template.
4 *
5 * @package WordPress
6 * @subpackage Template
7 */
8
9/**
10 * Load header template.
11 *
12 * Includes the header template for a theme or if a name is specified then a
13 * specialised header will be included.
14 *
15 * For the parameter, if the file is called "header-special.php" then specify
16 * "special".
17 *
18 * @uses locate_template()
19 * @since 1.5.0
20 * @uses do_action() Calls 'get_header' action.
21 *
22 * @param string $name The name of the specialised header.
23 */
24function get_header( $name = null ) {
25        do_action( 'get_header', $name );
26
27        $templates = array();
28        if ( isset($name) )
29                $templates[] = "header-{$name}.php";
30
31        $templates[] = "header.php";
32
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');
36}
37
38/**
39 * Load footer template.
40 *
41 * Includes the footer template for a theme or if a name is specified then a
42 * specialised footer will be included.
43 *
44 * For the parameter, if the file is called "footer-special.php" then specify
45 * "special".
46 *
47 * @uses locate_template()
48 * @since 1.5.0
49 * @uses do_action() Calls 'get_footer' action.
50 *
51 * @param string $name The name of the specialised footer.
52 */
53function get_footer( $name = null ) {
54        do_action( 'get_footer', $name );
55
56        $templates = array();
57        if ( isset($name) )
58                $templates[] = "footer-{$name}.php";
59
60        $templates[] = "footer.php";
61
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');
65}
66
67/**
68 * Load sidebar template.
69 *
70 * Includes the sidebar template for a theme or if a name is specified then a
71 * specialised sidebar will be included.
72 *
73 * For the parameter, if the file is called "sidebar-special.php" then specify
74 * "special".
75 *
76 * @uses locate_template()
77 * @since 1.5.0
78 * @uses do_action() Calls 'get_sidebar' action.
79 *
80 * @param string $name The name of the specialised sidebar.
81 */
82function get_sidebar( $name = null ) {
83        do_action( 'get_sidebar', $name );
84
85        $templates = array();
86        if ( isset($name) )
87                $templates[] = "sidebar-{$name}.php";
88
89        $templates[] = "sidebar.php";
90
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');
94}
95
96/**
97 * Load a template part into a template
98 *
99 * Makes it easy for a theme to reuse sections of code in a easy to overload way
100 * for child themes.
101 *
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.
105 *
106 * The template is included using require, not require_once, so you may include the
107 * same template part multiple times.
108 *
109 * For the parameter, if the file is called "{slug}-special.php" then specify
110 * "special".
111 *
112 * @uses locate_template()
113 * @since 3.0.0
114 * @uses do_action() Calls 'get_template_part{$slug}' action.
115 *
116 * @param string $slug The slug name for the generic template.
117 * @param string $name The name of the specialised template.
118 */
119function get_template_part( $slug, $name = null ) {
120        do_action( "get_template_part_{$slug}", $slug, $name );
121
122        $templates = array();
123        if ( isset($name) )
124                $templates[] = "{$slug}-{$name}.php";
125
126        $templates[] = "{$slug}.php";
127
128        locate_template($templates, true, false);
129}
130
131/**
132 * Display search form.
133 *
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'.
139 *
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.
142 *
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.
147 *
148 * @since 2.7.0
149 * @param boolean $echo Default to echo and not return the form.
150 */
151function get_search_form($echo = true) {
152        do_action( 'get_search_form' );
153
154        $search_form_template = locate_template(array('searchform.php'));
155        if ( '' != $search_form_template ) {
156                require($search_form_template);
157                return;
158        }
159
160        $form = '<form role="search" method="get" id="searchform" action="' . home_url( '/' ) . '" >
161        <div><label class="screen-reader-text" for="s">' . __('Search for:') . '</label>
162        <input type="text" value="' . get_search_query() . '" name="s" id="s" />
163        <input type="submit" id="searchsubmit" value="'. esc_attr__('Search') .'" />
164        </div>
165        </form>';
166
167        if ( $echo )
168                echo apply_filters('get_search_form', $form);
169        else
170                return apply_filters('get_search_form', $form);
171}
172
173/**
174 * Display the Log In/Out link.
175 *
176 * Displays a link, which allows users to navigate to the Log In page to log in
177 * or log out depending on whether they are currently logged in.
178 *
179 * @since 1.5.0
180 * @uses apply_filters() Calls 'loginout' hook on HTML link content.
181 *
182 * @param string $redirect Optional path to redirect to on login/logout.
183 * @param boolean $echo Default to echo and not return the link.
184 */
185function wp_loginout($redirect = '', $echo = true) {
186        if ( ! is_user_logged_in() )
187                $link = '<a href="' . esc_url( wp_login_url($redirect) ) . '">' . __('Log in') . '</a>';
188        else
189                $link = '<a href="' . esc_url( wp_logout_url($redirect) ) . '">' . __('Log out') . '</a>';
190
191        if ( $echo )
192                echo apply_filters('loginout', $link);
193        else
194                return apply_filters('loginout', $link);
195}
196
197/**
198 * Returns the Log Out URL.
199 *
200 * Returns the URL that allows the user to log out of the site
201 *
202 * @since 2.7
203 * @uses wp_nonce_url() To protect against CSRF
204 * @uses site_url() To generate the log in URL
205 * @uses apply_filters() calls 'logout_url' hook on final logout url
206 *
207 * @param string $redirect Path to redirect to on logout.
208 */
209function wp_logout_url($redirect = '') {
210        $args = array( 'action' => 'logout' );
211        if ( !empty($redirect) ) {
212                $args['redirect_to'] = urlencode( $redirect );
213        }
214
215        $logout_url = add_query_arg($args, site_url('wp-login.php', 'login'));
216        $logout_url = wp_nonce_url( $logout_url, 'log-out' );
217
218        return apply_filters('logout_url', $logout_url, $redirect);
219}
220
221/**
222 * Returns the Log In URL.
223 *
224 * Returns the URL that allows the user to log in to the site
225 *
226 * @since 2.7
227 * @uses site_url() To generate the log in URL
228 * @uses apply_filters() calls 'login_url' hook on final login url
229 *
230 * @param string $redirect Path to redirect to on login.
231 * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false.
232 * @return string A log in url
233 */
234function wp_login_url($redirect = '', $force_reauth = false) {
235        $login_url = site_url('wp-login.php', 'login');
236
237        if ( !empty($redirect) )
238                $login_url = add_query_arg('redirect_to', urlencode($redirect), $login_url);
239
240        if ( $force_reauth )
241                $login_url = add_query_arg('reauth', '1', $login_url);
242
243        return apply_filters('login_url', $login_url, $redirect);
244}
245
246/**
247 * Provides a simple login form for use anywhere within WordPress. By default, it echoes
248 * the HTML immediately. Pass array('echo'=>false) to return the string instead.
249 *
250 * @since 3.0.0
251 * @param array $args Configuration options to modify the form output
252 * @return Void, or string containing the form
253 */
254function wp_login_form( $args = array() ) {
255        $defaults = array( 'echo' => true,
256                                                'redirect' => site_url( $_SERVER['REQUEST_URI'] ), // Default redirect is back to the current page
257                                                'form_id' => 'loginform',
258                                                'label_username' => __( 'Username' ),
259                                                'label_password' => __( 'Password' ),
260                                                'label_remember' => __( 'Remember Me' ),
261                                                'label_log_in' => __( 'Log In' ),
262                                                'id_username' => 'user_login',
263                                                'id_password' => 'user_pass',
264                                                'id_remember' => 'rememberme',
265                                                'id_submit' => 'wp-submit',
266                                                'remember' => true,
267                                                'value_username' => '',
268                                                'value_remember' => false, // Set this to true to default the "Remember me" checkbox to checked
269                                        );
270        $args = wp_parse_args( $args, apply_filters( 'login_form_defaults', $defaults ) );
271
272        $form = '
273                <form name="' . $args['form_id'] . '" id="' . $args['form_id'] . '" action="' . site_url( 'wp-login.php', 'login' ) . '" method="post">
274                        ' . apply_filters( 'login_form_top', '' ) . '
275                        <p class="login-username">
276                                <label for="' . esc_attr( $args['id_username'] ) . '">' . esc_html( $args['label_username'] ) . '</label>
277                                <input type="text" name="log" id="' . esc_attr( $args['id_username'] ) . '" class="input" value="' . esc_attr( $args['value_username'] ) . '" size="20" tabindex="10" />
278                        </p>
279                        <p class="login-password">
280                                <label for="' . esc_attr( $args['id_password'] ) . '">' . esc_html( $args['label_password'] ) . '</label>
281                                <input type="password" name="pwd" id="' . esc_attr( $args['id_password'] ) . '" class="input" value="" size="20" tabindex="20" />
282                        </p>
283                        ' . apply_filters( 'login_form_middle', '' ) . '
284                        ' . ( $args['remember'] ? '<p class="login-remember"><label><input name="rememberme" type="checkbox" id="' . esc_attr( $args['id_remember'] ) . '" value="forever" tabindex="90"' . ( $args['value_remember'] ? ' checked="checked"' : '' ) . ' /> ' . esc_html( $args['label_remember'] ) . '</label></p>' : '' ) . '
285                        <p class="login-submit">
286                                <input type="submit" name="wp-submit" id="' . esc_attr( $args['id_submit'] ) . '" class="button-primary" value="' . esc_attr( $args['label_log_in'] ) . '" tabindex="100" />
287                                <input type="hidden" name="redirect_to" value="' . esc_attr( $args['redirect'] ) . '" />
288                        </p>
289                        ' . apply_filters( 'login_form_bottom', '' ) . '
290                </form>';
291
292        if ( $args['echo'] )
293                echo $form;
294        else
295                return $form;
296}
297
298/**
299 * Returns the Lost Password URL.
300 *
301 * Returns the URL that allows the user to retrieve the lost password
302 *
303 * @since 2.8.0
304 * @uses site_url() To generate the lost password URL
305 * @uses apply_filters() calls 'lostpassword_url' hook on the lostpassword url
306 *
307 * @param string $redirect Path to redirect to on login.
308 */
309function wp_lostpassword_url($redirect = '') {
310        $args = array( 'action' => 'lostpassword' );
311        if ( !empty($redirect) ) {
312                $args['redirect_to'] = $redirect;
313        }
314
315        $lostpassword_url = add_query_arg($args, site_url('wp-login.php', 'login'));
316        return apply_filters('lostpassword_url', $lostpassword_url, $redirect);
317}
318
319/**
320 * Display the Registration or Admin link.
321 *
322 * Display a link which allows the user to navigate to the registration page if
323 * not logged in and registration is enabled or to the dashboard if logged in.
324 *
325 * @since 1.5.0
326 * @uses apply_filters() Calls 'register' hook on register / admin link content.
327 *
328 * @param string $before Text to output before the link (defaults to <li>).
329 * @param string $after Text to output after the link (defaults to </li>).
330 * @param boolean $echo Default to echo and not return the link.
331 */
332function wp_register( $before = '<li>', $after = '</li>', $echo = true ) {
333
334        if ( ! is_user_logged_in() ) {
335                if ( get_option('users_can_register') )
336                        $link = $before . '<a href="' . site_url('wp-login.php?action=register', 'login') . '">' . __('Register') . '</a>' . $after;
337                else
338                        $link = '';
339        } else {
340                $link = $before . '<a href="' . admin_url() . '">' . __('Site Admin') . '</a>' . $after;
341        }
342
343        if ( $echo )
344                echo apply_filters('register', $link);
345        else
346                return apply_filters('register', $link);
347}
348
349/**
350 * Theme container function for the 'wp_meta' action.
351 *
352 * The 'wp_meta' action can have several purposes, depending on how you use it,
353 * but one purpose might have been to allow for theme switching.
354 *
355 * @since 1.5.0
356 * @link http://trac.wordpress.org/ticket/1458 Explanation of 'wp_meta' action.
357 * @uses do_action() Calls 'wp_meta' hook.
358 */
359function wp_meta() {
360        do_action('wp_meta');
361}
362
363/**
364 * Display information about the blog.
365 *
366 * @see get_bloginfo() For possible values for the parameter.
367 * @since 0.71
368 *
369 * @param string $show What to display.
370 */
371function bloginfo( $show='' ) {
372        echo get_bloginfo( $show, 'display' );
373}
374
375/**
376 * Retrieve information about the blog.
377 *
378 * Some show parameter values are deprecated and will be removed in future
379 * versions. These options will trigger the _deprecated_argument() function.
380 * The deprecated blog info options are listed in the function contents.
381 *
382 * The possible values for the 'show' parameter are listed below.
383 * <ol>
384 * <li><strong>url<strong> - Blog URI to homepage.</li>
385 * <li><strong>wpurl</strong> - Blog URI path to WordPress.</li>
386 * <li><strong>description</strong> - Secondary title</li>
387 * </ol>
388 *
389 * The feed URL options can be retrieved from 'rdf_url' (RSS 0.91),
390 * 'rss_url' (RSS 1.0), 'rss2_url' (RSS 2.0), or 'atom_url' (Atom feed). The
391 * comment feeds can be retrieved from the 'comments_atom_url' (Atom comment
392 * feed) or 'comments_rss2_url' (RSS 2.0 comment feed).
393 *
394 * @since 0.71
395 *
396 * @param string $show Blog info to retrieve.
397 * @param string $filter How to filter what is retrieved.
398 * @return string Mostly string values, might be empty.
399 */
400function get_bloginfo( $show = '', $filter = 'raw' ) {
401
402        switch( $show ) {
403                case 'home' : // DEPRECATED
404                case 'siteurl' : // DEPRECATED
405                        _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'  ) );
406                case 'url' :
407                        $output = home_url();
408                        break;
409                case 'wpurl' :
410                        $output = site_url();
411                        break;
412                case 'description':
413                        $output = get_option('blogdescription');
414                        break;
415                case 'rdf_url':
416                        $output = get_feed_link('rdf');
417                        break;
418                case 'rss_url':
419                        $output = get_feed_link('rss');
420                        break;
421                case 'rss2_url':
422                        $output = get_feed_link('rss2');
423                        break;
424                case 'atom_url':
425                        $output = get_feed_link('atom');
426                        break;
427                case 'comments_atom_url':
428                        $output = get_feed_link('comments_atom');
429                        break;
430                case 'comments_rss2_url':
431                        $output = get_feed_link('comments_rss2');
432                        break;
433                case 'pingback_url':
434                        $output = get_option('siteurl') .'/xmlrpc.php';
435                        break;
436                case 'stylesheet_url':
437                        $output = get_stylesheet_uri();
438                        break;
439                case 'stylesheet_directory':
440                        $output = get_stylesheet_directory_uri();
441                        break;
442                case 'template_directory':
443                case 'template_url':
444                        $output = get_template_directory_uri();
445                        break;
446                case 'admin_email':
447                        $output = get_option('admin_email');
448                        break;
449                case 'charset':
450                        $output = get_option('blog_charset');
451                        if ('' == $output) $output = 'UTF-8';
452                        break;
453                case 'html_type' :
454                        $output = get_option('html_type');
455                        break;
456                case 'version':
457                        global $wp_version;
458                        $output = $wp_version;
459                        break;
460                case 'language':
461                        $output = get_locale();
462                        $output = str_replace('_', '-', $output);
463                        break;
464                case 'text_direction':
465                        //_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()'  ) );
466                        if ( function_exists( 'is_rtl' ) ) {
467                                $output = is_rtl() ? 'rtl' : 'ltr';
468                        } else {
469                                $output = 'ltr';
470                        }
471                        break;
472                case 'secure_url' :
473                        $output =  home_url();
474                        $output = str_replace('http://', 'https://', $output);
475                        break;
476                case 'name':
477                default:
478                        $output = get_option('blogname');
479                        break;
480        }
481
482        $url = true;
483        if (strpos($show, 'url') === false &&
484                strpos($show, 'directory') === false &&
485                strpos($show, 'home') === false)
486                $url = false;
487
488        if ( 'display' == $filter ) {
489                if ( $url )
490                        $output = apply_filters('bloginfo_url', $output, $show);
491                else
492                        $output = apply_filters('bloginfo', $output, $show);
493        }
494
495        return $output;
496}
497
498/**
499 * Display or retrieve page title for all areas of blog.
500 *
501 * By default, the page title will display the separator before the page title,
502 * so that the blog title will be before the page title. This is not good for
503 * title display, since the blog title shows up on most tabs and not what is
504 * important, which is the page that the user is looking at.
505 *
506 * There are also SEO benefits to having the blog title after or to the 'right'
507 * or the page title. However, it is mostly common sense to have the blog title
508 * to the right with most browsers supporting tabs. You can achieve this by
509 * using the seplocation parameter and setting the value to 'right'. This change
510 * was introduced around 2.5.0, in case backwards compatibility of themes is
511 * important.
512 *
513 * @since 1.0.0
514 *
515 * @param string $sep Optional, default is '&raquo;'. How to separate the various items within the page title.
516 * @param bool $display Optional, default is true. Whether to display or retrieve title.
517 * @param string $seplocation Optional. Direction to display title, 'right'.
518 * @return string|null String on retrieve, null when displaying.
519 */
520function wp_title($sep = '&raquo;', $display = true, $seplocation = '') {
521        global $wpdb, $wp_locale, $wp_query;
522
523        $cat = get_query_var('cat');
524        $tag = get_query_var('tag_id');
525        $category_name = get_query_var('category_name');
526        $author = get_query_var('author');
527        $author_name = get_query_var('author_name');
528        $m = get_query_var('m');
529        $year = get_query_var('year');
530        $monthnum = get_query_var('monthnum');
531        $day = get_query_var('day');
532        $search = get_query_var('s');
533        $title = '';
534
535        $t_sep = '%WP_TITILE_SEP%'; // Temporary separator, for accurate flipping, if necessary
536
537        // If there's a category
538        if ( !empty($cat) ) {
539                        // category exclusion
540                        if ( !stristr($cat,'-') )
541                                $title = apply_filters('single_cat_title', get_the_category_by_ID($cat));
542        } elseif ( !empty($category_name) ) {
543                if ( stristr($category_name,'/') ) {
544                                $category_name = explode('/',$category_name);
545                                if ( $category_name[count($category_name)-1] )
546                                        $category_name = $category_name[count($category_name)-1]; // no trailing slash
547                                else
548                                        $category_name = $category_name[count($category_name)-2]; // there was a trailling slash
549                }
550                $cat = get_term_by('slug', $category_name, 'category', OBJECT, 'display');
551                if ( $cat )
552                        $title = apply_filters('single_cat_title', $cat->name);
553        }
554
555        if ( !empty($tag) ) {
556                $tag = get_term($tag, 'post_tag', OBJECT, 'display');
557                if ( is_wp_error( $tag ) )
558                        return $tag;
559                if ( ! empty($tag->name) )
560                        $title = apply_filters('single_tag_title', $tag->name);
561        }
562
563        // If there's an author
564        if ( !empty($author) ) {
565                $title = get_userdata($author);
566                $title = $title->display_name;
567        }
568        if ( !empty($author_name) ) {
569                // We do a direct query here because we don't cache by nicename.
570                $title = $wpdb->get_var($wpdb->prepare("SELECT display_name FROM $wpdb->users WHERE user_nicename = %s", $author_name));
571        }
572
573        // If there's a month
574        if ( !empty($m) ) {
575                $my_year = substr($m, 0, 4);
576                $my_month = $wp_locale->get_month(substr($m, 4, 2));
577                $my_day = intval(substr($m, 6, 2));
578                $title = $my_year . ($my_month ? $t_sep . $my_month : "") . ($my_day ? $t_sep . $my_day : "");
579        }
580
581        if ( !empty($year) ) {
582                $title = $year;
583                if ( !empty($monthnum) )
584                        $title .= $t_sep . $wp_locale->get_month($monthnum);
585                if ( !empty($day) )
586                        $title .= $t_sep . zeroise($day, 2);
587        }
588
589        // If there is a post
590        if ( is_single() || ( is_home() && !is_front_page() ) || ( is_page() && !is_front_page() ) ) {
591                $post = $wp_query->get_queried_object();
592                $title = apply_filters( 'single_post_title', $post->post_title );
593        }
594
595        // If there's a taxonomy
596        if ( is_tax() ) {
597                $taxonomy = get_query_var( 'taxonomy' );
598                $tax = get_taxonomy( $taxonomy );
599                $term = $wp_query->get_queried_object();
600                $term = $term->name;
601                $title = $tax->labels->name . $t_sep . $term;
602        }
603
604        //If it's a search
605        if ( is_search() ) {
606                /* translators: 1: separator, 2: search phrase */
607                $title = sprintf(__('Search Results %1$s %2$s'), $t_sep, strip_tags($search));
608        }
609
610        if ( is_404() ) {
611                $title = __('Page not found');
612        }
613
614        $prefix = '';
615        if ( !empty($title) )
616                $prefix = " $sep ";
617
618        // Determines position of the separator and direction of the breadcrumb
619        if ( 'right' == $seplocation ) { // sep on right, so reverse the order
620                $title_array = explode( $t_sep, $title );
621                $title_array = array_reverse( $title_array );
622                $title = implode( " $sep ", $title_array ) . $prefix;
623        } else {
624                $title_array = explode( $t_sep, $title );
625                $title = $prefix . implode( " $sep ", $title_array );
626        }
627
628        $title = apply_filters('wp_title', $title, $sep, $seplocation);
629
630        // Send it out
631        if ( $display )
632                echo $title;
633        else
634                return $title;
635
636}
637
638/**
639 * Display or retrieve page title for post.
640 *
641 * This is optimized for single.php template file for displaying the post title.
642 * Only useful for posts, does not support pages for example.
643 *
644 * It does not support placing the separator after the title, but by leaving the
645 * prefix parameter empty, you can set the title separator manually. The prefix
646 * does not automatically place a space between the prefix, so if there should
647 * be a space, the parameter value will need to have it at the end.
648 *
649 * @since 0.71
650 * @uses $wpdb
651 *
652 * @param string $prefix Optional. What to display before the title.
653 * @param bool $display Optional, default is true. Whether to display or retrieve title.
654 * @return string|null Title when retrieving, null when displaying or failure.
655 */
656function single_post_title($prefix = '', $display = true) {
657        global $wp_query, $post;
658
659        if ( ! $post )
660                $_post = $wp_query->get_queried_object();
661        else
662                $_post = $post;
663
664        if ( !isset($_post->post_title) )
665                return;
666
667        $title = apply_filters('single_post_title', $_post->post_title, $_post);
668        if ( $display )
669                echo $prefix . $title;
670        else
671                return $title;
672}
673
674/**
675 * Display or retrieve page title for category archive.
676 *
677 * This is useful for category template file or files, because it is optimized
678 * for category page title and with less overhead than {@link wp_title()}.
679 *
680 * It does not support placing the separator after the title, but by leaving the
681 * prefix parameter empty, you can set the title separator manually. The prefix
682 * does not automatically place a space between the prefix, so if there should
683 * be a space, the parameter value will need to have it at the end.
684 *
685 * @since 0.71
686 *
687 * @param string $prefix Optional. What to display before the title.
688 * @param bool $display Optional, default is true. Whether to display or retrieve title.
689 * @return string|null Title when retrieving, null when displaying or failure.
690 */
691function single_cat_title($prefix = '', $display = true ) {
692        global $wp_query;
693
694        if ( is_tag() )
695                return single_tag_title($prefix, $display);
696
697        if ( !is_category() )
698                return;
699
700        $cat = $wp_query->get_queried_object();
701        $my_cat_name = apply_filters('single_cat_title', $cat->name);
702        if ( !empty($my_cat_name) ) {
703                if ( $display )
704                        echo $prefix . $my_cat_name;
705                else
706                        return $my_cat_name;
707        }
708}
709
710/**
711 * Display or retrieve page title for tag post archive.
712 *
713 * Useful for tag template files for displaying the tag page title. It has less
714 * overhead than {@link wp_title()}, because of its limited implementation.
715 *
716 * It does not support placing the separator after the title, but by leaving the
717 * prefix parameter empty, you can set the title separator manually. The prefix
718 * does not automatically place a space between the prefix, so if there should
719 * be a space, the parameter value will need to have it at the end.
720 *
721 * @since 2.3.0
722 *
723 * @param string $prefix Optional. What to display before the title.
724 * @param bool $display Optional, default is true. Whether to display or retrieve title.
725 * @return string|null Title when retrieving, null when displaying or failure.
726 */
727function single_tag_title($prefix = '', $display = true ) {
728        global $wp_query;
729        if ( !is_tag() )
730                return;
731
732        $tag = $wp_query->get_queried_object();
733
734        if ( ! $tag )
735                return;
736
737        $my_tag_name = apply_filters('single_tag_title', $tag->name);
738        if ( !empty($my_tag_name) ) {
739                if ( $display )
740                        echo $prefix . $my_tag_name;
741                else
742                        return $my_tag_name;
743        }
744}
745
746/**
747 * Display or retrieve page title for post archive based on date.
748 *
749 * Useful for when the template only needs to display the month and year, if
750 * either are available. Optimized for just this purpose, so if it is all that
751 * is needed, should be better than {@link wp_title()}.
752 *
753 * It does not support placing the separator after the title, but by leaving the
754 * prefix parameter empty, you can set the title separator manually. The prefix
755 * does not automatically place a space between the prefix, so if there should
756 * be a space, the parameter value will need to have it at the end.
757 *
758 * @since 0.71
759 *
760 * @param string $prefix Optional. What to display before the title.
761 * @param bool $display Optional, default is true. Whether to display or retrieve title.
762 * @return string|null Title when retrieving, null when displaying or failure.
763 */
764function single_month_title($prefix = '', $display = true ) {
765        global $wp_locale;
766
767        $m = get_query_var('m');
768        $year = get_query_var('year');
769        $monthnum = get_query_var('monthnum');
770
771        if ( !empty($monthnum) && !empty($year) ) {
772                $my_year = $year;
773                $my_month = $wp_locale->get_month($monthnum);
774        } elseif ( !empty($m) ) {
775                $my_year = substr($m, 0, 4);
776                $my_month = $wp_locale->get_month(substr($m, 4, 2));
777        }
778
779        if ( empty($my_month) )
780                return false;
781
782        $result = $prefix . $my_month . $prefix . $my_year;
783
784        if ( !$display )
785                return $result;
786        echo $result;
787}
788
789/**
790 * Retrieve archive link content based on predefined or custom code.
791 *
792 * The format can be one of four styles. The 'link' for head element, 'option'
793 * for use in the select element, 'html' for use in list (either ol or ul HTML
794 * elements). Custom content is also supported using the before and after
795 * parameters.
796 *
797 * The 'link' format uses the link HTML element with the <em>archives</em>
798 * relationship. The before and after parameters are not used. The text
799 * parameter is used to describe the link.
800 *
801 * The 'option' format uses the option HTML element for use in select element.
802 * The value is the url parameter and the before and after parameters are used
803 * between the text description.
804 *
805 * The 'html' format, which is the default, uses the li HTML element for use in
806 * the list HTML elements. The before parameter is before the link and the after
807 * parameter is after the closing link.
808 *
809 * The custom format uses the before parameter before the link ('a' HTML
810 * element) and the after parameter after the closing link tag. If the above
811 * three values for the format are not used, then custom format is assumed.
812 *
813 * @since 1.0.0
814 *
815 * @param string $url URL to archive.
816 * @param string $text Archive text description.
817 * @param string $format Optional, default is 'html'. Can be 'link', 'option', 'html', or custom.
818 * @param string $before Optional.
819 * @param string $after Optional.
820 * @return string HTML link content for archive.
821 */
822function get_archives_link($url, $text, $format = 'html', $before = '', $after = '') {
823        $text = wptexturize($text);
824        $title_text = esc_attr($text);
825        $url = esc_url($url);
826
827        if ('link' == $format)
828                $link_html = "\t<link rel='archives' title='$title_text' href='$url' />\n";
829        elseif ('option' == $format)
830                $link_html = "\t<option value='$url'>$before $text $after</option>\n";
831        elseif ('html' == $format)
832                $link_html = "\t<li>$before<a href='$url' title='$title_text'>$text</a>$after</li>\n";
833        else // custom
834                $link_html = "\t$before<a href='$url' title='$title_text'>$text</a>$after\n";
835
836        $link_html = apply_filters( "get_archives_link", $link_html );
837
838        return $link_html;
839}
840
841/**
842 * Display archive links based on type and format.
843 *
844 * The 'type' argument offers a few choices and by default will display monthly
845 * archive links. The other options for values are 'daily', 'weekly', 'monthly',
846 * 'yearly', 'postbypost' or 'alpha'. Both 'postbypost' and 'alpha' display the
847 * same archive link list, the difference between the two is that 'alpha'
848 * will order by post title and 'postbypost' will order by post date.
849 *
850 * The date archives will logically display dates with links to the archive post
851 * page. The 'postbypost' and 'alpha' values for 'type' argument will display
852 * the post titles.
853 *
854 * The 'limit' argument will only display a limited amount of links, specified
855 * by the 'limit' integer value. By default, there is no limit. The
856 * 'show_post_count' argument will show how many posts are within the archive.
857 * By default, the 'show_post_count' argument is set to false.
858 *
859 * For the 'format', 'before', and 'after' arguments, see {@link
860 * get_archives_link()}. The values of these arguments have to do with that
861 * function.
862 *
863 * @since 1.2.0
864 *
865 * @param string|array $args Optional. Override defaults.
866 */
867function wp_get_archives($args = '') {
868        global $wpdb, $wp_locale;
869
870        $defaults = array(
871                'type' => 'monthly', 'limit' => '',
872                'format' => 'html', 'before' => '',
873                'after' => '', 'show_post_count' => false,
874                'echo' => 1
875        );
876
877        $r = wp_parse_args( $args, $defaults );
878        extract( $r, EXTR_SKIP );
879
880        if ( '' == $type )
881                $type = 'monthly';
882
883        if ( '' != $limit ) {
884                $limit = absint($limit);
885                $limit = ' LIMIT '.$limit;
886        }
887
888        // this is what will separate dates on weekly archive links
889        $archive_week_separator = '&#8211;';
890
891        // over-ride general date format ? 0 = no: use the date format set in Options, 1 = yes: over-ride
892        $archive_date_format_over_ride = 0;
893
894        // options for daily archive (only if you over-ride the general date format)
895        $archive_day_date_format = 'Y/m/d';
896
897        // options for weekly archive (only if you over-ride the general date format)
898        $archive_week_start_date_format = 'Y/m/d';
899        $archive_week_end_date_format   = 'Y/m/d';
900
901        if ( !$archive_date_format_over_ride ) {
902                $archive_day_date_format = get_option('date_format');
903                $archive_week_start_date_format = get_option('date_format');
904                $archive_week_end_date_format = get_option('date_format');
905        }
906
907        //filters
908        $where = apply_filters('getarchives_where', "WHERE post_type = 'post' AND post_status = 'publish'", $r );
909        $join = apply_filters('getarchives_join', "", $r);
910
911        $output = '';
912
913        if ( 'monthly' == $type ) {
914                $query = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date) ORDER BY post_date DESC $limit";
915                $key = md5($query);
916                $cache = wp_cache_get( 'wp_get_archives' , 'general');
917                if ( !isset( $cache[ $key ] ) ) {
918                        $arcresults = $wpdb->get_results($query);
919                        $cache[ $key ] = $arcresults;
920                        wp_cache_set( 'wp_get_archives', $cache, 'general' );
921                } else {
922                        $arcresults = $cache[ $key ];
923                }
924                if ( $arcresults ) {
925                        $afterafter = $after;
926                        foreach ( (array) $arcresults as $arcresult ) {
927                                $url = get_month_link( $arcresult->year, $arcresult->month );
928                                /* translators: 1: month name, 2: 4-digit year */
929                                $text = sprintf(__('%1$s %2$d'), $wp_locale->get_month($arcresult->month), $arcresult->year);
930                                if ( $show_post_count )
931                                        $after = '&nbsp;('.$arcresult->posts.')' . $afterafter;
932                                $output .= get_archives_link($url, $text, $format, $before, $after);
933                        }
934                }
935        } elseif ('yearly' == $type) {
936                $query = "SELECT YEAR(post_date) AS `year`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date) ORDER BY post_date DESC $limit";
937                $key = md5($query);
938                $cache = wp_cache_get( 'wp_get_archives' , 'general');
939                if ( !isset( $cache[ $key ] ) ) {
940                        $arcresults = $wpdb->get_results($query);
941                        $cache[ $key ] = $arcresults;
942                        wp_cache_set( 'wp_get_archives', $cache, 'general' );
943                } else {
944                        $arcresults = $cache[ $key ];
945                }
946                if ($arcresults) {
947                        $afterafter = $after;
948                        foreach ( (array) $arcresults as $arcresult) {
949                                $url = get_year_link($arcresult->year);
950                                $text = sprintf('%d', $arcresult->year);
951                                if ($show_post_count)
952                                        $after = '&nbsp;('.$arcresult->posts.')' . $afterafter;
953                                $output .= get_archives_link($url, $text, $format, $before, $after);
954                        }
955                }
956        } elseif ( 'daily' == $type ) {
957                $query = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, DAYOFMONTH(post_date) AS `dayofmonth`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date), DAYOFMONTH(post_date) ORDER BY post_date DESC $limit";
958                $key = md5($query);
959                $cache = wp_cache_get( 'wp_get_archives' , 'general');
960                if ( !isset( $cache[ $key ] ) ) {
961                        $arcresults = $wpdb->get_results($query);
962                        $cache[ $key ] = $arcresults;
963                        wp_cache_set( 'wp_get_archives', $cache, 'general' );
964                } else {
965                        $arcresults = $cache[ $key ];
966                }
967                if ( $arcresults ) {
968                        $afterafter = $after;
969                        foreach ( (array) $arcresults as $arcresult ) {
970                                $url    = get_day_link($arcresult->year, $arcresult->month, $arcresult->dayofmonth);
971                                $date = sprintf('%1$d-%2$02d-%3$02d 00:00:00', $arcresult->year, $arcresult->month, $arcresult->dayofmonth);
972                                $text = mysql2date($archive_day_date_format, $date);
973                                if ($show_post_count)
974                                        $after = '&nbsp;('.$arcresult->posts.')'.$afterafter;
975                                $output .= get_archives_link($url, $text, $format, $before, $after);
976                        }
977                }
978        } elseif ( 'weekly' == $type ) {
979                $week = _wp_mysql_week( '`post_date`' );
980                $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` DESC $limit";
981                $key = md5($query);
982                $cache = wp_cache_get( 'wp_get_archives' , 'general');
983                if ( !isset( $cache[ $key ] ) ) {
984                        $arcresults = $wpdb->get_results($query);
985                        $cache[ $key ] = $arcresults;
986                        wp_cache_set( 'wp_get_archives', $cache, 'general' );
987                } else {
988                        $arcresults = $cache[ $key ];
989                }
990                $arc_w_last = '';
991                $afterafter = $after;
992                if ( $arcresults ) {
993                                foreach ( (array) $arcresults as $arcresult ) {
994                                        if ( $arcresult->week != $arc_w_last ) {
995                                                $arc_year = $arcresult->yr;
996                                                $arc_w_last = $arcresult->week;
997                                                $arc_week = get_weekstartend($arcresult->yyyymmdd, get_option('start_of_week'));
998                                                $arc_week_start = date_i18n($archive_week_start_date_format, $arc_week['start']);
999                                                $arc_week_end = date_i18n($archive_week_end_date_format, $arc_week['end']);
1000                                                $url  = sprintf('%1$s/%2$s%3$sm%4$s%5$s%6$sw%7$s%8$d', home_url(), '', '?', '=', $arc_year, '&amp;', '=', $arcresult->week);
1001                                                $text = $arc_week_start . $archive_week_separator . $arc_week_end;
1002                                                if ($show_post_count)
1003                                                        $after = '&nbsp;('.$arcresult->posts.')'.$afterafter;
1004                                                $output .= get_archives_link($url, $text, $format, $before, $after);
1005                                        }
1006                                }
1007                }
1008        } elseif ( ( 'postbypost' == $type ) || ('alpha' == $type) ) {
1009                $orderby = ('alpha' == $type) ? "post_title ASC " : "post_date DESC ";
1010                $query = "SELECT * FROM $wpdb->posts $join $where ORDER BY $orderby $limit";
1011                $key = md5($query);
1012                $cache = wp_cache_get( 'wp_get_archives' , 'general');
1013                if ( !isset( $cache[ $key ] ) ) {
1014                        $arcresults = $wpdb->get_results($query);
1015                        $cache[ $key ] = $arcresults;
1016                        wp_cache_set( 'wp_get_archives', $cache, 'general' );
1017                } else {
1018                        $arcresults = $cache[ $key ];
1019                }
1020                if ( $arcresults ) {
1021                        foreach ( (array) $arcresults as $arcresult ) {
1022                                if ( $arcresult->post_date != '0000-00-00 00:00:00' ) {
1023                                        $url  = get_permalink($arcresult);
1024                                        $arc_title = $arcresult->post_title;
1025                                        if ( $arc_title )
1026                                                $text = strip_tags(apply_filters('the_title', $arc_title));
1027                                        else
1028                                                $text = $arcresult->ID;
1029                                        $output .= get_archives_link($url, $text, $format, $before, $after);
1030                                }
1031                        }
1032                }
1033        }
1034        if ( $echo )
1035                echo $output;
1036        else
1037                return $output;
1038}
1039
1040/**
1041 * Get number of days since the start of the week.
1042 *
1043 * @since 1.5.0
1044 * @usedby get_calendar()
1045 *
1046 * @param int $num Number of day.
1047 * @return int Days since the start of the week.
1048 */
1049function calendar_week_mod($num) {
1050        $base = 7;
1051        return ($num - $base*floor($num/$base));
1052}
1053
1054/**
1055 * Display calendar with days that have posts as links.
1056 *
1057 * The calendar is cached, which will be retrieved, if it exists. If there are
1058 * no posts for the month, then it will not be displayed.
1059 *
1060 * @since 1.0.0
1061 *
1062 * @param bool $initial Optional, default is true. Use initial calendar names.
1063 * @param bool $echo Optional, default is true. Set to false for return.
1064 */
1065function get_calendar($initial = true, $echo = true) {
1066        global $wpdb, $m, $monthnum, $year, $wp_locale, $posts;
1067
1068        $cache = array();
1069        $key = md5( $m . $monthnum . $year );
1070        if ( $cache = wp_cache_get( 'get_calendar', 'calendar' ) ) {
1071                if ( is_array($cache) && isset( $cache[ $key ] ) ) {
1072                        if ( $echo ) {
1073                                echo apply_filters( 'get_calendar',  $cache[$key] );
1074                                return;
1075                        } else {
1076                                return apply_filters( 'get_calendar',  $cache[$key] );
1077                        }
1078                }
1079        }
1080
1081        if ( !is_array($cache) )
1082                $cache = array();
1083
1084        // Quick check. If we have no posts at all, abort!
1085        if ( !$posts ) {
1086                $gotsome = $wpdb->get_var("SELECT 1 as test FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish' LIMIT 1");
1087                if ( !$gotsome ) {
1088                        $cache[ $key ] = '';
1089                        wp_cache_set( 'get_calendar', $cache, 'calendar' );
1090                        return;
1091                }
1092        }
1093
1094        if ( isset($_GET['w']) )
1095                $w = ''.intval($_GET['w']);
1096
1097        // week_begins = 0 stands for Sunday
1098        $week_begins = intval(get_option('start_of_week'));
1099
1100        // Let's figure out when we are
1101        if ( !empty($monthnum) && !empty($year) ) {
1102                $thismonth = ''.zeroise(intval($monthnum), 2);
1103                $thisyear = ''.intval($year);
1104        } elseif ( !empty($w) ) {
1105                // We need to get the month from MySQL
1106                $thisyear = ''.intval(substr($m, 0, 4));
1107                $d = (($w - 1) * 7) + 6; //it seems MySQL's weeks disagree with PHP's
1108                $thismonth = $wpdb->get_var("SELECT DATE_FORMAT((DATE_ADD('${thisyear}0101', INTERVAL $d DAY) ), '%m')");
1109        } elseif ( !empty($m) ) {
1110                $thisyear = ''.intval(substr($m, 0, 4));
1111                if ( strlen($m) < 6 )
1112                                $thismonth = '01';
1113                else
1114                                $thismonth = ''.zeroise(intval(substr($m, 4, 2)), 2);
1115        } else {
1116                $thisyear = gmdate('Y', current_time('timestamp'));
1117                $thismonth = gmdate('m', current_time('timestamp'));
1118        }
1119
1120        $unixmonth = mktime(0, 0 , 0, $thismonth, 1, $thisyear);
1121
1122        // Get the next and previous month and year with at least one post
1123        $previous = $wpdb->get_row("SELECT DISTINCT MONTH(post_date) AS month, YEAR(post_date) AS year
1124                FROM $wpdb->posts
1125                WHERE post_date < '$thisyear-$thismonth-01'
1126                AND post_type = 'post' AND post_status = 'publish'
1127                        ORDER BY post_date DESC
1128                        LIMIT 1");
1129        $next = $wpdb->get_row("SELECT  DISTINCT MONTH(post_date) AS month, YEAR(post_date) AS year
1130                FROM $wpdb->posts
1131                WHERE post_date >       '$thisyear-$thismonth-01'
1132                AND MONTH( post_date ) != MONTH( '$thisyear-$thismonth-01' )
1133                AND post_type = 'post' AND post_status = 'publish'
1134                        ORDER   BY post_date ASC
1135                        LIMIT 1");
1136
1137        /* translators: Calendar caption: 1: month name, 2: 4-digit year */
1138        $calendar_caption = _x('%1$s %2$s', 'calendar caption');
1139        $calendar_output = '<table id="wp-calendar" summary="' . esc_attr__('Calendar') . '">
1140        <caption>' . sprintf($calendar_caption, $wp_locale->get_month($thismonth), date('Y', $unixmonth)) . '</caption>
1141        <thead>
1142        <tr>';
1143
1144        $myweek = array();
1145
1146        for ( $wdcount=0; $wdcount<=6; $wdcount++ ) {
1147                $myweek[] = $wp_locale->get_weekday(($wdcount+$week_begins)%7);
1148        }
1149
1150        foreach ( $myweek as $wd ) {
1151                $day_name = (true == $initial) ? $wp_locale->get_weekday_initial($wd) : $wp_locale->get_weekday_abbrev($wd);
1152                $wd = esc_attr($wd);
1153                $calendar_output .= "\n\t\t<th scope=\"col\" title=\"$wd\">$day_name</th>";
1154        }
1155
1156        $calendar_output .= '
1157        </tr>
1158        </thead>
1159
1160        <tfoot>
1161        <tr>';
1162
1163        if ( $previous ) {
1164                $calendar_output .= "\n\t\t".'<td colspan="3" id="prev"><a href="' . get_month_link($previous->year, $previous->month) . '" title="' . sprintf(__('View posts for %1$s %2$s'), $wp_locale->get_month($previous->month), date('Y', mktime(0, 0 , 0, $previous->month, 1, $previous->year))) . '">&laquo; ' . $wp_locale->get_month_abbrev($wp_locale->get_month($previous->month)) . '</a></td>';
1165        } else {
1166                $calendar_output .= "\n\t\t".'<td colspan="3" id="prev" class="pad">&nbsp;</td>';
1167        }
1168
1169        $calendar_output .= "\n\t\t".'<td class="pad">&nbsp;</td>';
1170
1171        if ( $next ) {
1172                $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)) . ' &raquo;</a></td>';
1173        } else {
1174                $calendar_output .= "\n\t\t".'<td colspan="3" id="next" class="pad">&nbsp;</td>';
1175        }
1176
1177        $calendar_output .= '
1178        </tr>
1179        </tfoot>
1180
1181        <tbody>
1182        <tr>';
1183
1184        // Get days with posts
1185        $dayswithposts = $wpdb->get_results("SELECT DISTINCT DAYOFMONTH(post_date)
1186                FROM $wpdb->posts WHERE MONTH(post_date) = '$thismonth'
1187                AND YEAR(post_date) = '$thisyear'
1188                AND post_type = 'post' AND post_status = 'publish'
1189                AND post_date < '" . current_time('mysql') . '\'', ARRAY_N);
1190        if ( $dayswithposts ) {
1191                foreach ( (array) $dayswithposts as $daywith ) {
1192                        $daywithpost[] = $daywith[0];
1193                }
1194        } else {
1195                $daywithpost = array();
1196        }
1197
1198        if (strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE') !== false || stripos($_SERVER['HTTP_USER_AGENT'], 'camino') !== false || stripos($_SERVER['HTTP_USER_AGENT'], 'safari') !== false)
1199                $ak_title_separator = "\n";
1200        else
1201                $ak_title_separator = ', ';
1202
1203        $ak_titles_for_day = array();
1204        $ak_post_titles = $wpdb->get_results("SELECT ID, post_title, DAYOFMONTH(post_date) as dom "
1205                ."FROM $wpdb->posts "
1206                ."WHERE YEAR(post_date) = '$thisyear' "
1207                ."AND MONTH(post_date) = '$thismonth' "
1208                ."AND post_date < '".current_time('mysql')."' "
1209                ."AND post_type = 'post' AND post_status = 'publish'"
1210        );
1211        if ( $ak_post_titles ) {
1212                foreach ( (array) $ak_post_titles as $ak_post_title ) {
1213
1214                                $post_title = esc_attr( apply_filters( 'the_title', $ak_post_title->post_title, $ak_post_title->ID ) );
1215
1216                                if ( empty($ak_titles_for_day['day_'.$ak_post_title->dom]) )
1217                                        $ak_titles_for_day['day_'.$ak_post_title->dom] = '';
1218                                if ( empty($ak_titles_for_day["$ak_post_title->dom"]) ) // first one
1219                                        $ak_titles_for_day["$ak_post_title->dom"] = $post_title;
1220                                else
1221                                        $ak_titles_for_day["$ak_post_title->dom"] .= $ak_title_separator . $post_title;
1222                }
1223        }
1224
1225
1226        // See how much we should pad in the beginning
1227        $pad = calendar_week_mod(date('w', $unixmonth)-$week_begins);
1228        if ( 0 != $pad )
1229                $calendar_output .= "\n\t\t".'<td colspan="'. esc_attr($pad) .'" class="pad">&nbsp;</td>';
1230
1231        $daysinmonth = intval(date('t', $unixmonth));
1232        for ( $day = 1; $day <= $daysinmonth; ++$day ) {
1233                if ( isset($newrow) && $newrow )
1234                        $calendar_output .= "\n\t</tr>\n\t<tr>\n\t\t";
1235                $newrow = false;
1236
1237                if ( $day == gmdate('j', current_time('timestamp')) && $thismonth == gmdate('m', current_time('timestamp')) && $thisyear == gmdate('Y', current_time('timestamp')) )
1238                        $calendar_output .= '<td id="today">';
1239                else
1240                        $calendar_output .= '<td>';
1241
1242                if ( in_array($day, $daywithpost) ) // any posts today?
1243                                $calendar_output .= '<a href="' . get_day_link($thisyear, $thismonth, $day) . "\" title=\"" . esc_attr($ak_titles_for_day[$day]) . "\">$day</a>";
1244                else
1245                        $calendar_output .= $day;
1246                $calendar_output .= '</td>';
1247
1248                if ( 6 == calendar_week_mod(date('w', mktime(0, 0 , 0, $thismonth, $day, $thisyear))-$week_begins) )
1249                        $newrow = true;
1250        }
1251
1252        $pad = 7 - calendar_week_mod(date('w', mktime(0, 0 , 0, $thismonth, $day, $thisyear))-$week_begins);
1253        if ( $pad != 0 && $pad != 7 )
1254                $calendar_output .= "\n\t\t".'<td class="pad" colspan="'. esc_attr($pad) .'">&nbsp;</td>';
1255
1256        $calendar_output .= "\n\t</tr>\n\t</tbody>\n\t</table>";
1257
1258        $cache[ $key ] = $calendar_output;
1259        wp_cache_set( 'get_calendar', $cache, 'calendar' );
1260
1261        if ( $echo )
1262                echo apply_filters( 'get_calendar',  $calendar_output );
1263        else
1264                return apply_filters( 'get_calendar',  $calendar_output );
1265
1266}
1267
1268/**
1269 * Purge the cached results of get_calendar.
1270 *
1271 * @see get_calendar
1272 * @since 2.1.0
1273 */
1274function delete_get_calendar_cache() {
1275        wp_cache_delete( 'get_calendar', 'calendar' );
1276}
1277add_action( 'save_post', 'delete_get_calendar_cache' );
1278add_action( 'delete_post', 'delete_get_calendar_cache' );
1279add_action( 'update_option_start_of_week', 'delete_get_calendar_cache' );
1280add_action( 'update_option_gmt_offset', 'delete_get_calendar_cache' );
1281
1282/**
1283 * Display all of the allowed tags in HTML format with attributes.
1284 *
1285 * This is useful for displaying in the comment area, which elements and
1286 * attributes are supported. As well as any plugins which want to display it.
1287 *
1288 * @since 1.0.1
1289 * @uses $allowedtags
1290 *
1291 * @return string HTML allowed tags entity encoded.
1292 */
1293function allowed_tags() {
1294        global $allowedtags;
1295        $allowed = '';
1296        foreach ( (array) $allowedtags as $tag => $attributes ) {
1297                $allowed .= '<'.$tag;
1298                if ( 0 < count($attributes) ) {
1299                        foreach ( $attributes as $attribute => $limits ) {
1300                                $allowed .= ' '.$attribute.'=""';
1301                        }
1302                }
1303                $allowed .= '> ';
1304        }
1305        return htmlentities($allowed);
1306}
1307
1308/***** Date/Time tags *****/
1309
1310/**
1311 * Outputs the date in iso8601 format for xml files.
1312 *
1313 * @since 1.0.0
1314 */
1315function the_date_xml() {
1316        global $post;
1317        echo mysql2date('Y-m-d', $post->post_date, false);
1318}
1319
1320/**
1321 * Display or Retrieve the date the current $post was written (once per date)
1322 *
1323 * Will only output the date if the current post's date is different from the
1324 * previous one output.
1325
1326 * i.e. Only one date listing will show per day worth of posts shown in the loop, even if the
1327 * function is called several times for each post.
1328 *
1329 * HTML output can be filtered with 'the_date'.
1330 * Date string output can be filtered with 'get_the_date'.
1331 *
1332 * @since 0.71
1333 * @uses get_the_date()
1334 * @param string $d Optional. PHP date format defaults to the date_format option if not specified.
1335 * @param string $before Optional. Output before the date.
1336 * @param string $after Optional. Output after the date.
1337 * @param bool $echo Optional, default is display. Whether to echo the date or return it.
1338 * @return string|null Null if displaying, string if retrieving.
1339 */
1340function the_date( $d = '', $before = '', $after = '', $echo = true ) {
1341        global $day, $previousday;
1342        $the_date = '';
1343        if ( $day != $previousday ) {
1344                $the_date .= $before;
1345                $the_date .= get_the_date( $d );
1346                $the_date .= $after;
1347                $previousday = $day;
1348
1349                $the_date = apply_filters('the_date', $the_date, $d, $before, $after);
1350
1351                if ( $echo )
1352                        echo $the_date;
1353                else
1354                        return $the_date;
1355        }
1356
1357        return null;
1358}
1359
1360/**
1361 * Retrieve the date the current $post was written.
1362 *
1363 * Unlike the_date() this function will always return the date.
1364 * Modify output with 'get_the_date' filter.
1365 *
1366 * @since 3.0.0
1367 *
1368 * @param string $d Optional. PHP date format defaults to the date_format option if not specified.
1369 * @return string|null Null if displaying, string if retrieving.
1370 */
1371function get_the_date( $d = '' ) {
1372        global $post;
1373        $the_date = '';
1374
1375        if ( '' == $d )
1376                $the_date .= mysql2date(get_option('date_format'), $post->post_date);
1377        else
1378                $the_date .= mysql2date($d, $post->post_date);
1379
1380        return apply_filters('get_the_date', $the_date, $d);
1381}
1382
1383/**
1384 * Display the date on which the post was last modified.
1385 *
1386 * @since 2.1.0
1387 *
1388 * @param string $d Optional. PHP date format defaults to the date_format option if not specified.
1389 * @param string $before Optional. Output before the date.
1390 * @param string $after Optional. Output after the date.
1391 * @param bool $echo Optional, default is display. Whether to echo the date or return it.
1392 * @return string|null Null if displaying, string if retrieving.
1393 */
1394function the_modified_date($d = '', $before='', $after='', $echo = true) {
1395
1396        $the_modified_date = $before . get_the_modified_date($d) . $after;
1397        $the_modified_date = apply_filters('the_modified_date', $the_modified_date, $d, $before, $after);
1398
1399        if ( $echo )
1400                echo $the_modified_date;
1401        else
1402                return $the_modified_date;
1403
1404}
1405
1406/**
1407 * Retrieve the date on which the post was last modified.
1408 *
1409 * @since 2.1.0
1410 *
1411 * @param string $d Optional. PHP date format. Defaults to the "date_format" option
1412 * @return string
1413 */
1414function get_the_modified_date($d = '') {
1415        if ( '' == $d )
1416                $the_time = get_post_modified_time(get_option('date_format'), null, null, true);
1417        else
1418                $the_time = get_post_modified_time($d, null, null, true);
1419        return apply_filters('get_the_modified_date', $the_time, $d);
1420}
1421
1422/**
1423 * Display the time at which the post was written.
1424 *
1425 * @since 0.71
1426 *
1427 * @param string $d Either 'G', 'U', or php date format.
1428 */
1429function the_time( $d = '' ) {
1430        echo apply_filters('the_time', get_the_time( $d ), $d);
1431}
1432
1433/**
1434 * Retrieve the time at which the post was written.
1435 *
1436 * @since 1.5.0
1437 *
1438 * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
1439 * @param int|object $post Optional post ID or object. Default is global $post object.
1440 * @return string
1441 */
1442function get_the_time( $d = '', $post = null ) {
1443        $post = get_post($post);
1444
1445        if ( '' == $d )
1446                $the_time = get_post_time(get_option('time_format'), false, $post, true);
1447        else
1448                $the_time = get_post_time($d, false, $post, true);
1449        return apply_filters('get_the_time', $the_time, $d, $post);
1450}
1451
1452/**
1453 * Retrieve the time at which the post was written.
1454 *
1455 * @since 2.0.0
1456 *
1457 * @param string $d Optional Either 'G', 'U', or php date format.
1458 * @param bool $gmt Optional, default is false. Whether to return the gmt time.
1459 * @param int|object $post Optional post ID or object. Default is global $post object.
1460 * @param bool $translate Whether to translate the time string
1461 * @return string
1462 */
1463function get_post_time( $d = 'U', $gmt = false, $post = null, $translate = false ) { // returns timestamp
1464        $post = get_post($post);
1465
1466        if ( $gmt )
1467                $time = $post->post_date_gmt;
1468        else
1469                $time = $post->post_date;
1470
1471        $time = mysql2date($d, $time, $translate);
1472        return apply_filters('get_post_time', $time, $d, $gmt);
1473}
1474
1475/**
1476 * Display the time at which the post was last modified.
1477 *
1478 * @since 2.0.0
1479 *
1480 * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
1481 */
1482function the_modified_time($d = '') {
1483        echo apply_filters('the_modified_time', get_the_modified_time($d), $d);
1484}
1485
1486/**
1487 * Retrieve the time at which the post was last modified.
1488 *
1489 * @since 2.0.0
1490 *
1491 * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
1492 * @return string
1493 */
1494function get_the_modified_time($d = '') {
1495        if ( '' == $d )
1496                $the_time = get_post_modified_time(get_option('time_format'), null, null, true);
1497        else
1498                $the_time = get_post_modified_time($d, null, null, true);
1499        return apply_filters('get_the_modified_time', $the_time, $d);
1500}
1501
1502/**
1503 * Retrieve the time at which the post was last modified.
1504 *
1505 * @since 2.0.0
1506 *
1507 * @param string $d Optional, default is 'U'. Either 'G', 'U', or php date format.
1508 * @param bool $gmt Optional, default is false. Whether to return the gmt time.
1509 * @param int|object $post Optional, default is global post object. A post_id or post object
1510 * @param bool $translate Optional, default is false. Whether to translate the result
1511 * @return string Returns timestamp
1512 */
1513function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
1514        $post = get_post($post);
1515
1516        if ( $gmt )
1517                $time = $post->post_modified_gmt;
1518        else
1519                $time = $post->post_modified;
1520        $time = mysql2date($d, $time, $translate);
1521
1522        return apply_filters('get_post_modified_time', $time, $d, $gmt);
1523}
1524
1525/**
1526 * Display the weekday on which the post was written.
1527 *
1528 * @since 0.71
1529 * @uses $wp_locale
1530 * @uses $post
1531 */
1532function the_weekday() {
1533        global $wp_locale, $post;
1534        $the_weekday = $wp_locale->get_weekday(mysql2date('w', $post->post_date, false));
1535        $the_weekday = apply_filters('the_weekday', $the_weekday);
1536        echo $the_weekday;
1537}
1538
1539/**
1540 * Display the weekday on which the post was written.
1541 *
1542 * Will only output the weekday if the current post's weekday is different from
1543 * the previous one output.
1544 *
1545 * @since 0.71
1546 *
1547 * @param string $before Optional Output before the date.
1548 * @param string $after Optional Output after the date.
1549  */
1550function the_weekday_date($before='',$after='') {
1551        global $wp_locale, $post, $day, $previousweekday;
1552        $the_weekday_date = '';
1553        if ( $day != $previousweekday ) {
1554                $the_weekday_date .= $before;
1555                $the_weekday_date .= $wp_locale->get_weekday(mysql2date('w', $post->post_date, false));
1556                $the_weekday_date .= $after;
1557                $previousweekday = $day;
1558        }
1559        $the_weekday_date = apply_filters('the_weekday_date', $the_weekday_date, $before, $after);
1560        echo $the_weekday_date;
1561}
1562
1563/**
1564 * Fire the wp_head action
1565 *
1566 * @since 1.2.0
1567 * @uses do_action() Calls 'wp_head' hook.
1568 */
1569function wp_head() {
1570        do_action('wp_head');
1571}
1572
1573/**
1574 * Fire the wp_footer action
1575 *
1576 * @since 1.5.1
1577 * @uses do_action() Calls 'wp_footer' hook.
1578 */
1579function wp_footer() {
1580        do_action('wp_footer');
1581}
1582
1583/**
1584 * Display the links to the general feeds.
1585 *
1586 * @since 2.8.0
1587 *
1588 * @param array $args Optional arguments.
1589 */
1590function feed_links( $args = array() ) {
1591        if ( !current_theme_supports('automatic-feed-links') )
1592                return;
1593
1594        $defaults = array(
1595                /* translators: Separator between blog name and feed type in feed links */
1596                'separator'     => _x('&raquo;', 'feed link'),
1597                /* translators: 1: blog title, 2: separator (raquo) */
1598                'feedtitle'     => __('%1$s %2$s Feed'),
1599                /* translators: %s: blog title, 2: separator (raquo) */
1600                'comstitle'     => __('%1$s %2$s Comments Feed'),
1601        );
1602
1603        $args = wp_parse_args( $args, $defaults );
1604
1605        echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . esc_attr(sprintf( $args['feedtitle'], get_bloginfo('name'), $args['separator'] )) . '" href="' . get_feed_link() . "\" />\n";
1606        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";
1607}
1608
1609/**
1610 * Display the links to the extra feeds such as category feeds.
1611 *
1612 * @since 2.8.0
1613 *
1614 * @param array $args Optional arguments.
1615 */
1616function feed_links_extra( $args = array() ) {
1617        $defaults = array(
1618                /* translators: Separator between blog name and feed type in feed links */
1619                'separator'   => _x('&raquo;', 'feed link'),
1620                /* translators: 1: blog name, 2: separator(raquo), 3: post title */
1621                'singletitle' => __('%1$s %2$s %3$s Comments Feed'),
1622                /* translators: 1: blog name, 2: separator(raquo), 3: category name */
1623                'cattitle'    => __('%1$s %2$s %3$s Category Feed'),
1624                /* translators: 1: blog name, 2: separator(raquo), 3: tag name */
1625                'tagtitle'    => __('%1$s %2$s %3$s Tag Feed'),
1626                /* translators: 1: blog name, 2: separator(raquo), 3: author name  */
1627                'authortitle' => __('%1$s %2$s Posts by %3$s Feed'),
1628                /* translators: 1: blog name, 2: separator(raquo), 3: search phrase */
1629                'searchtitle' => __('%1$s %2$s Search Results for &#8220;%3$s&#8221; Feed'),
1630        );
1631
1632        $args = wp_parse_args( $args, $defaults );
1633
1634        if ( is_single() || is_page() ) {
1635                $post = &get_post( $id = 0 );
1636
1637                if ( comments_open() || pings_open() || $post->comment_count > 0 ) {
1638                        $title = esc_attr(sprintf( $args['singletitle'], get_bloginfo('name'), $args['separator'], esc_html( get_the_title() ) ));
1639                        $href = get_post_comments_feed_link( $post->ID );
1640                }
1641        } elseif ( is_category() ) {
1642                $cat_id = intval( get_query_var('cat') );
1643
1644                $title = esc_attr(sprintf( $args['cattitle'], get_bloginfo('name'), $args['separator'], get_cat_name( $cat_id ) ));
1645                $href = get_category_feed_link( $cat_id );
1646        } elseif ( is_tag() ) {
1647                $tag_id = intval( get_query_var('tag_id') );
1648                $tag = get_tag( $tag_id );
1649
1650                $title = esc_attr(sprintf( $args['tagtitle'], get_bloginfo('name'), $args['separator'], $tag->name ));
1651                $href = get_tag_feed_link( $tag_id );
1652        } elseif ( is_author() ) {
1653                $author_id = intval( get_query_var('author') );
1654
1655                $title = esc_attr(sprintf( $args['authortitle'], get_bloginfo('name'), $args['separator'], get_the_author_meta( 'display_name', $author_id ) ));
1656                $href = get_author_feed_link( $author_id );
1657        } elseif ( is_search() ) {
1658                $title = esc_attr(sprintf( $args['searchtitle'], get_bloginfo('name'), $args['separator'], get_search_query( false ) ));
1659                $href = get_search_feed_link();
1660        }
1661
1662        if ( isset($title) && isset($href) )
1663                echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . $title . '" href="' . $href . '" />' . "\n";
1664}
1665
1666/**
1667 * Display the link to the Really Simple Discovery service endpoint.
1668 *
1669 * @link http://archipelago.phrasewise.com/rsd
1670 * @since 2.0.0
1671 */
1672function rsd_link() {
1673        echo '<link rel="EditURI" type="application/rsd+xml" title="RSD" href="' . get_bloginfo('wpurl') . "/xmlrpc.php?rsd\" />\n";
1674}
1675
1676/**
1677 * Display the link to the Windows Live Writer manifest file.
1678 *
1679 * @link http://msdn.microsoft.com/en-us/library/bb463265.aspx
1680 * @since 2.3.1
1681 */
1682function wlwmanifest_link() {
1683        echo '<link rel="wlwmanifest" type="application/wlwmanifest+xml" href="'
1684                . get_bloginfo('wpurl') . '/wp-includes/wlwmanifest.xml" /> ' . "\n";
1685}
1686
1687/**
1688 * Display a noindex meta tag if required by the blog configuration.
1689 *
1690 * If a blog is marked as not being public then the noindex meta tag will be
1691 * output to tell web robots not to index the page content.
1692 *
1693 * @since 2.1.0
1694 */
1695function noindex() {
1696        // If the blog is not public, tell robots to go away.
1697        if ( '0' == get_option('blog_public') )
1698                echo "<meta name='robots' content='noindex,nofollow' />\n";
1699}
1700
1701/**
1702 * Determine if TinyMCE is available.
1703 *
1704 * Checks to see if the user has deleted the tinymce files to slim down there WordPress install.
1705 *
1706 * @since 2.1.0
1707 *
1708 * @return bool Whether TinyMCE exists.
1709 */
1710function rich_edit_exists() {
1711        global $wp_rich_edit_exists;
1712        if ( !isset($wp_rich_edit_exists) )
1713                $wp_rich_edit_exists = file_exists(ABSPATH . WPINC . '/js/tinymce/tiny_mce.js');
1714        return $wp_rich_edit_exists;
1715}
1716
1717/**
1718 * Whether the user should have a WYSIWIG editor.
1719 *
1720 * Checks that the user requires a WYSIWIG editor and that the editor is
1721 * supported in the users browser.
1722 *
1723 * @since 2.0.0
1724 *
1725 * @return bool
1726 */
1727function user_can_richedit() {
1728        global $wp_rich_edit, $pagenow, $is_iphone;
1729
1730        if ( !isset( $wp_rich_edit) ) {
1731                if ( get_user_option( 'rich_editing' ) == 'true' &&
1732                        !$is_iphone && // this includes all Safari mobile browsers
1733                        ( ( preg_match( '!AppleWebKit/(\d+)!', $_SERVER['HTTP_USER_AGENT'], $match ) && intval($match[1]) >= 420 ) ||
1734                                !preg_match( '!opera[ /][2-8]|konqueror|safari!i', $_SERVER['HTTP_USER_AGENT'] ) )
1735                                && 'comment.php' != $pagenow ) {
1736                        $wp_rich_edit = true;
1737                } else {
1738                        $wp_rich_edit = false;
1739                }
1740        }
1741
1742        return apply_filters('user_can_richedit', $wp_rich_edit);
1743}
1744
1745/**
1746 * Find out which editor should be displayed by default.
1747 *
1748 * Works out which of the two editors to display as the current editor for a
1749 * user.
1750 *
1751 * @since 2.5.0
1752 *
1753 * @return string Either 'tinymce', or 'html', or 'test'
1754 */
1755function wp_default_editor() {
1756        $r = user_can_richedit() ? 'tinymce' : 'html'; // defaults
1757        if ( $user = wp_get_current_user() ) { // look for cookie
1758                $ed = get_user_setting('editor', 'tinymce');
1759                $r = ( in_array($ed, array('tinymce', 'html', 'test') ) ) ? $ed : $r;
1760        }
1761        return apply_filters( 'wp_default_editor', $r ); // filter
1762}
1763
1764/**
1765 * Display visual editor forms: TinyMCE, or HTML, or both.
1766 *
1767 * The amount of rows the text area will have for the content has to be between
1768 * 3 and 100 or will default at 12. There is only one option used for all users,
1769 * named 'default_post_edit_rows'.
1770 *
1771 * If the user can not use the rich editor (TinyMCE), then the switch button
1772 * will not be displayed.
1773 *
1774 * @since 2.1.0
1775 *
1776 * @param string $content Textarea content.
1777 * @param string $id Optional, default is 'content'. HTML ID attribute value.
1778 * @param string $prev_id Optional, default is 'title'. HTML ID name for switching back and forth between visual editors.
1779 * @param bool $media_buttons Optional, default is true. Whether to display media buttons.
1780 * @param int $tab_index Optional, default is 2. Tabindex for textarea element.
1781 */
1782function the_editor($content, $id = 'content', $prev_id = 'title', $media_buttons = true, $tab_index = 2) {
1783        $rows = get_option('default_post_edit_rows');
1784        if (($rows < 3) || ($rows > 100))
1785                $rows = 12;
1786
1787        if ( !current_user_can( 'upload_files' ) )
1788                $media_buttons = false;
1789
1790        $richedit =  user_can_richedit();
1791        $class = '';
1792
1793        if ( $richedit || $media_buttons ) { ?>
1794        <div id="editor-toolbar">
1795<?php
1796        if ( $richedit ) {
1797                $wp_default_editor = wp_default_editor(); ?>
1798                <div class="zerosize"><input accesskey="e" type="button" onclick="switchEditors.go('<?php echo $id; ?>')" /></div>
1799<?php   if ( 'html' == $wp_default_editor ) {
1800                        add_filter('the_editor_content', 'wp_htmledit_pre'); ?>
1801                        <a id="edButtonHTML" class="active hide-if-no-js" onclick="switchEditors.go('<?php echo $id; ?>', 'html');"><?php _e('HTML'); ?></a>
1802                        <a id="edButtonPreview" class="hide-if-no-js" onclick="switchEditors.go('<?php echo $id; ?>', 'tinymce');"><?php _e('Visual'); ?></a>
1803<?php   } else {
1804                        $class = " class='theEditor'";
1805                        add_filter('the_editor_content', 'wp_richedit_pre'); ?>
1806                        <a id="edButtonHTML" class="hide-if-no-js" onclick="switchEditors.go('<?php echo $id; ?>', 'html');"><?php _e('HTML'); ?></a>
1807                        <a id="edButtonPreview" class="active hide-if-no-js" onclick="switchEditors.go('<?php echo $id; ?>', 'tinymce');"><?php _e('Visual'); ?></a>
1808<?php   }
1809        }
1810
1811        if ( $media_buttons ) { ?>
1812                <div id="media-buttons" class="hide-if-no-js">
1813<?php   do_action( 'media_buttons' ); ?>
1814                </div>
1815<?php
1816        } ?>
1817        </div>
1818<?php
1819        }
1820?>
1821        <div id="quicktags"><?php
1822        wp_print_scripts( 'quicktags' ); ?>
1823        <script type="text/javascript">edToolbar()</script>
1824        </div>
1825
1826<?php
1827        $the_editor = apply_filters('the_editor', "<div id='editorcontainer'><textarea rows='$rows'$class cols='40' name='$id' tabindex='$tab_index' id='$id'>%s</textarea></div>\n");
1828        $the_editor_content = apply_filters('the_editor_content', $content);
1829
1830        printf($the_editor, $the_editor_content);
1831
1832?>
1833        <script type="text/javascript">
1834        edCanvas = document.getElementById('<?php echo $id; ?>');
1835        </script>
1836<?php
1837}
1838
1839/**
1840 * Retrieve the contents of the search WordPress query variable.
1841 *
1842 * The search query string is passed through {@link esc_attr()}
1843 * to ensure that it is safe for placing in an html attribute.
1844 *
1845 * @since 2.3.0
1846 * @uses esc_attr()
1847 *
1848 * @param bool $escaped Whether the result is escaped. Default true.
1849 *      Only use when you are later escaping it. Do not use unescaped.
1850 * @return string
1851 */
1852function get_search_query( $escaped = true ) {
1853        $query = apply_filters( 'get_search_query', get_query_var( 's' ) );
1854        if ( $escaped )
1855                $query = esc_attr( $query );
1856        return $query;
1857}
1858
1859/**
1860 * Display the contents of the search query variable.
1861 *
1862 * The search query string is passed through {@link esc_attr()}
1863 * to ensure that it is safe for placing in an html attribute.
1864 *
1865 * @uses esc_attr()
1866 * @since 2.1.0
1867 */
1868function the_search_query() {
1869        echo esc_attr( apply_filters( 'the_search_query', get_search_query( false ) ) );
1870}
1871
1872/**
1873 * Display the language attributes for the html tag.
1874 *
1875 * Builds up a set of html attributes containing the text direction and language
1876 * information for the page.
1877 *
1878 * @since 2.1.0
1879 *
1880 * @param string $doctype The type of html document (xhtml|html).
1881 */
1882function language_attributes($doctype = 'html') {
1883        $attributes = array();
1884        $output = '';
1885
1886        if ( function_exists( 'is_rtl' ) )
1887                $attributes[] = 'dir="' . ( is_rtl() ? 'rtl' : 'ltr' ) . '"';
1888
1889        if ( $lang = get_bloginfo('language') ) {
1890                if ( get_option('html_type') == 'text/html' || $doctype == 'html' )
1891                        $attributes[] = "lang=\"$lang\"";
1892
1893                if ( get_option('html_type') != 'text/html' || $doctype == 'xhtml' )
1894                        $attributes[] = "xml:lang=\"$lang\"";
1895        }
1896
1897        $output = implode(' ', $attributes);
1898        $output = apply_filters('language_attributes', $output);
1899        echo $output;
1900}
1901
1902/**
1903 * Retrieve paginated link for archive post pages.
1904 *
1905 * Technically, the function can be used to create paginated link list for any
1906 * area. The 'base' argument is used to reference the url, which will be used to
1907 * create the paginated links. The 'format' argument is then used for replacing
1908 * the page number. It is however, most likely and by default, to be used on the
1909 * archive post pages.
1910 *
1911 * The 'type' argument controls format of the returned value. The default is
1912 * 'plain', which is just a string with the links separated by a newline
1913 * character. The other possible values are either 'array' or 'list'. The
1914 * 'array' value will return an array of the paginated link list to offer full
1915 * control of display. The 'list' value will place all of the paginated links in
1916 * an unordered HTML list.
1917 *
1918 * The 'total' argument is the total amount of pages and is an integer. The
1919 * 'current' argument is the current page number and is also an integer.
1920 *
1921 * An example of the 'base' argument is "http://example.com/all_posts.php%_%"
1922 * and the '%_%' is required. The '%_%' will be replaced by the contents of in
1923 * the 'format' argument. An example for the 'format' argument is "?page=%#%"
1924 * and the '%#%' is also required. The '%#%' will be replaced with the page
1925 * number.
1926 *
1927 * You can include the previous and next links in the list by setting the
1928 * 'prev_next' argument to true, which it is by default. You can set the
1929 * previous text, by using the 'prev_text' argument. You can set the next text
1930 * by setting the 'next_text' argument.
1931 *
1932 * If the 'show_all' argument is set to true, then it will show all of the pages
1933 * instead of a short list of the pages near the current page. By default, the
1934 * 'show_all' is set to false and controlled by the 'end_size' and 'mid_size'
1935 * arguments. The 'end_size' argument is how many numbers on either the start
1936 * and the end list edges, by default is 1. The 'mid_size' argument is how many
1937 * numbers to either side of current page, but not including current page.
1938 *
1939 * It is possible to add query vars to the link by using the 'add_args' argument
1940 * and see {@link add_query_arg()} for more information.
1941 *
1942 * @since 2.1.0
1943 *
1944 * @param string|array $args Optional. Override defaults.
1945 * @return array|string String of page links or array of page links.
1946 */
1947function paginate_links( $args = '' ) {
1948        $defaults = array(
1949                'base' => '%_%', // http://example.com/all_posts.php%_% : %_% is replaced by format (below)
1950                'format' => '?page=%#%', // ?page=%#% : %#% is replaced by the page number
1951                'total' => 1,
1952                'current' => 0,
1953                'show_all' => false,
1954                'prev_next' => true,
1955                'prev_text' => __('&laquo; Previous'),
1956                'next_text' => __('Next &raquo;'),
1957                'end_size' => 1,
1958                'mid_size' => 2,
1959                'type' => 'plain',
1960                'add_args' => false, // array of query args to add
1961                'add_fragment' => ''
1962        );
1963
1964        $args = wp_parse_args( $args, $defaults );
1965        extract($args, EXTR_SKIP);
1966
1967        // Who knows what else people pass in $args
1968        $total = (int) $total;
1969        if ( $total < 2 )
1970                return;
1971        $current  = (int) $current;
1972        $end_size = 0  < (int) $end_size ? (int) $end_size : 1; // Out of bounds?  Make it the default.
1973        $mid_size = 0 <= (int) $mid_size ? (int) $mid_size : 2;
1974        $add_args = is_array($add_args) ? $add_args : false;
1975        $r = '';
1976        $page_links = array();
1977        $n = 0;
1978        $dots = false;
1979
1980        if ( $prev_next && $current && 1 < $current ) :
1981                $link = str_replace('%_%', 2 == $current ? '' : $format, $base);
1982                $link = str_replace('%#%', $current - 1, $link);
1983                if ( $add_args )
1984                        $link = add_query_arg( $add_args, $link );
1985                $link .= $add_fragment;
1986                $page_links[] = "<a class='prev page-numbers' href='" . esc_url( apply_filters( 'paginate_links', $link ) ) . "'>$prev_text</a>";
1987        endif;
1988        for ( $n = 1; $n <= $total; $n++ ) :
1989                $n_display = number_format_i18n($n);
1990                if ( $n == $current ) :
1991                        $page_links[] = "<span class='page-numbers current'>$n_display</span>";
1992                        $dots = true;
1993                else :
1994                        if ( $show_all || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :
1995                                $link = str_replace('%_%', 1 == $n ? '' : $format, $base);
1996                                $link = str_replace('%#%', $n, $link);
1997                                if ( $add_args )
1998                                        $link = add_query_arg( $add_args, $link );
1999                                $link .= $add_fragment;
2000                                $page_links[] = "<a class='page-numbers' href='" . esc_url( apply_filters( 'paginate_links', $link ) ) . "'>$n_display</a>";
2001                                $dots = true;
2002                        elseif ( $dots && !$show_all ) :
2003                                $page_links[] = "<span class='page-numbers dots'>...</span>";
2004                                $dots = false;
2005                        endif;
2006                endif;
2007        endfor;
2008        if ( $prev_next && $current && ( $current < $total || -1 == $total ) ) :
2009                $link = str_replace('%_%', $format, $base);
2010                $link = str_replace('%#%', $current + 1, $link);
2011                if ( $add_args )
2012                        $link = add_query_arg( $add_args, $link );
2013                $link .= $add_fragment;
2014                $page_links[] = "<a class='next page-numbers' href='" . esc_url( apply_filters( 'paginate_links', $link ) ) . "'>$next_text</a>";
2015        endif;
2016        switch ( $type ) :
2017                case 'array' :
2018                        return $page_links;
2019                        break;
2020                case 'list' :
2021                        $r .= "<ul class='page-numbers'>\n\t<li>";
2022                        $r .= join("</li>\n\t<li>", $page_links);
2023                        $r .= "</li>\n</ul>\n";
2024                        break;
2025                default :
2026                        $r = join("\n", $page_links);
2027                        break;
2028        endswitch;
2029        return $r;
2030}
2031
2032/**
2033 * Registers an admin colour scheme css file.
2034 *
2035 * Allows a plugin to register a new admin colour scheme. For example:
2036 * <code>
2037 * wp_admin_css_color('classic', __('Classic'), admin_url("css/colors-classic.css"),
2038 * array('#07273E', '#14568A', '#D54E21', '#2683AE'));
2039 * </code>
2040 *
2041 * @since 2.5.0
2042 *
2043 * @param string $key The unique key for this theme.
2044 * @param string $name The name of the theme.
2045 * @param string $url The url of the css file containing the colour scheme.
2046 * @param array @colors Optional An array of CSS color definitions which are used to give the user a feel for the theme.
2047 */
2048function wp_admin_css_color($key, $name, $url, $colors = array()) {
2049        global $_wp_admin_css_colors;
2050
2051        if ( !isset($_wp_admin_css_colors) )
2052                $_wp_admin_css_colors = array();
2053
2054        $_wp_admin_css_colors[$key] = (object) array('name' => $name, 'url' => $url, 'colors' => $colors);
2055}
2056
2057/**
2058 * Registers the default Admin color schemes
2059 *
2060 * @since 3.0.0
2061 */
2062function register_admin_color_schemes() {
2063        wp_admin_css_color('classic', __('Blue'), admin_url("css/colors-classic.css"), array('#073447', '#21759B', '#EAF3FA', '#BBD8E7'));
2064        wp_admin_css_color('fresh', __('Gray'), admin_url("css/colors-fresh.css"), array('#464646', '#6D6D6D', '#F1F1F1', '#DFDFDF'));}
2065
2066/**
2067 * Display the URL of a WordPress admin CSS file.
2068 *
2069 * @see WP_Styles::_css_href and its style_loader_src filter.
2070 *
2071 * @since 2.3.0
2072 *
2073 * @param string $file file relative to wp-admin/ without its ".css" extension.
2074 */
2075function wp_admin_css_uri( $file = 'wp-admin' ) {
2076        if ( defined('WP_INSTALLING') ) {
2077                $_file = "./$file.css";
2078        } else {
2079                $_file = admin_url("$file.css");
2080        }
2081        $_file = add_query_arg( 'version', get_bloginfo( 'version' ),  $_file );
2082
2083        return apply_filters( 'wp_admin_css_uri', $_file, $file );
2084}
2085
2086/**
2087 * Enqueues or directly prints a stylesheet link to the specified CSS file.
2088 *
2089 * "Intelligently" decides to enqueue or to print the CSS file. If the
2090 * 'wp_print_styles' action has *not* yet been called, the CSS file will be
2091 * enqueued. If the wp_print_styles action *has* been called, the CSS link will
2092 * be printed. Printing may be forced by passing TRUE as the $force_echo
2093 * (second) parameter.
2094 *
2095 * For backward compatibility with WordPress 2.3 calling method: If the $file
2096 * (first) parameter does not correspond to a registered CSS file, we assume
2097 * $file is a file relative to wp-admin/ without its ".css" extension. A
2098 * stylesheet link to that generated URL is printed.
2099 *
2100 * @package WordPress
2101 * @since 2.3.0
2102 * @uses $wp_styles WordPress Styles Object
2103 *
2104 * @param string $file Style handle name or file name (without ".css" extension) relative to wp-admin/
2105 * @param bool $force_echo Optional.  Force the stylesheet link to be printed rather than enqueued.
2106 */
2107function wp_admin_css( $file = 'wp-admin', $force_echo = false ) {
2108        global $wp_styles;
2109        if ( !is_a($wp_styles, 'WP_Styles') )
2110                $wp_styles = new WP_Styles();
2111
2112        // For backward compatibility
2113        $handle = 0 === strpos( $file, 'css/' ) ? substr( $file, 4 ) : $file;
2114
2115        if ( $wp_styles->query( $handle ) ) {
2116                if ( $force_echo || did_action( 'wp_print_styles' ) ) // we already printed the style queue.  Print this one immediately
2117                        wp_print_styles( $handle );
2118                else // Add to style queue
2119                        wp_enqueue_style( $handle );
2120                return;
2121        }
2122
2123        echo apply_filters( 'wp_admin_css', "<link rel='stylesheet' href='" . esc_url( wp_admin_css_uri( $file ) ) . "' type='text/css' />\n", $file );
2124        if ( is_rtl() )
2125                echo apply_filters( 'wp_admin_css', "<link rel='stylesheet' href='" . esc_url( wp_admin_css_uri( "$file-rtl" ) ) . "' type='text/css' />\n", "$file-rtl" );
2126}
2127
2128/**
2129 * Enqueues the default ThickBox js and css.
2130 *
2131 * If any of the settings need to be changed, this can be done with another js
2132 * file similar to media-upload.js and theme-preview.js. That file should
2133 * require array('thickbox') to ensure it is loaded after.
2134 *
2135 * @since 2.5.0
2136 */
2137function add_thickbox() {
2138        wp_enqueue_script( 'thickbox' );
2139        wp_enqueue_style( 'thickbox' );
2140}
2141
2142/**
2143 * Display the XHTML generator that is generated on the wp_head hook.
2144 *
2145 * @since 2.5.0
2146 */
2147function wp_generator() {
2148        the_generator( apply_filters( 'wp_generator_type', 'xhtml' ) );
2149}
2150
2151/**
2152 * Display the generator XML or Comment for RSS, ATOM, etc.
2153 *
2154 * Returns the correct generator type for the requested output format. Allows
2155 * for a plugin to filter generators overall the the_generator filter.
2156 *
2157 * @since 2.5.0
2158 * @uses apply_filters() Calls 'the_generator' hook.
2159 *
2160 * @param string $type The type of generator to output - (html|xhtml|atom|rss2|rdf|comment|export).
2161 */
2162function the_generator( $type ) {
2163        echo apply_filters('the_generator', get_the_generator($type), $type) . "\n";
2164}
2165
2166/**
2167 * Creates the generator XML or Comment for RSS, ATOM, etc.
2168 *
2169 * Returns the correct generator type for the requested output format. Allows
2170 * for a plugin to filter generators on an individual basis using the
2171 * 'get_the_generator_{$type}' filter.
2172 *
2173 * @since 2.5.0
2174 * @uses apply_filters() Calls 'get_the_generator_$type' hook.
2175 *
2176 * @param string $type The type of generator to return - (html|xhtml|atom|rss2|rdf|comment|export).
2177 * @return string The HTML content for the generator.
2178 */
2179function get_the_generator( $type = '' ) {
2180        if ( empty( $type ) ) {
2181
2182                $current_filter = current_filter();
2183                if ( empty( $current_filter ) )
2184                        return;
2185
2186                switch ( $current_filter ) {
2187                        case 'rss2_head' :
2188                        case 'commentsrss2_head' :
2189                                $type = 'rss2';
2190                                break;
2191                        case 'rss_head' :
2192                        case 'opml_head' :
2193                                $type = 'comment';
2194                                break;
2195                        case 'rdf_header' :
2196                                $type = 'rdf';
2197                                break;
2198                        case 'atom_head' :
2199                        case 'comments_atom_head' :
2200                        case 'app_head' :
2201                                $type = 'atom';
2202                                break;
2203                }
2204        }
2205
2206        switch ( $type ) {
2207                case 'html':
2208                        $gen = '<meta name="generator" content="WordPress ' . get_bloginfo( 'version' ) . '">';
2209                        break;
2210                case 'xhtml':
2211                        $gen = '<meta name="generator" content="WordPress ' . get_bloginfo( 'version' ) . '" />';
2212                        break;
2213                case 'atom':
2214                        $gen = '<generator uri="http://wordpress.org/" version="' . get_bloginfo_rss( 'version' ) . '">WordPress</generator>';
2215                        break;
2216                case 'rss2':
2217                        $gen = '<generator>http://wordpress.org/?v=' . get_bloginfo_rss( 'version' ) . '</generator>';
2218                        break;
2219                case 'rdf':
2220                        $gen = '<admin:generatorAgent rdf:resource="http://wordpress.org/?v=' . get_bloginfo_rss( 'version' ) . '" />';
2221                        break;
2222                case 'comment':
2223                        $gen = '<!-- generator="WordPress/' . get_bloginfo( 'version' ) . '" -->';
2224                        break;
2225                case 'export':
2226                        $gen = '<!-- generator="WordPress/' . get_bloginfo_rss('version') . '" created="'. date('Y-m-d H:i') . '"-->';
2227                        break;
2228        }
2229        return apply_filters( "get_the_generator_{$type}", $gen, $type );
2230}
2231
2232/**
2233 * Outputs the html checked attribute.
2234 *
2235 * Compares the first two arguments and if identical marks as checked
2236 *
2237 * @since 1.0
2238 *
2239 * @param mixed $checked One of the values to compare
2240 * @param mixed $current (true) The other value to compare if not just true
2241 * @param bool $echo Whether to echo or just return the string
2242 * @return string html attribute or empty string
2243 */
2244function checked( $checked, $current = true, $echo = true ) {
2245        return __checked_selected_helper( $checked, $current, $echo, 'checked' );
2246}
2247
2248/**
2249 * Outputs the html selected attribute.
2250 *
2251 * Compares the first two arguments and if identical marks as selected
2252 *
2253 * @since 1.0
2254 *
2255 * @param mixed selected One of the values to compare
2256 * @param mixed $current (true) The other value to compare if not just true
2257 * @param bool $echo Whether to echo or just return the string
2258 * @return string html attribute or empty string
2259 */
2260function selected( $selected, $current = true, $echo = true ) {
2261        return __checked_selected_helper( $selected, $current, $echo, 'selected' );
2262}
2263
2264/**
2265 * Outputs the html disabled attribute.
2266 *
2267 * Compares the first two arguments and if identical marks as disabled
2268 *
2269 * @since 3.0.0
2270 *
2271 * @param mixed $disabled One of the values to compare
2272 * @param mixed $current (true) The other value to compare if not just true
2273 * @param bool $echo Whether to echo or just return the string
2274 * @return string html attribute or empty string
2275 */
2276function disabled( $disabled, $current = true, $echo = true ) {
2277        return __checked_selected_helper( $disabled, $current, $echo, 'disabled' );
2278}
2279
2280/**
2281 * Private helper function for checked, selected, and disabled.
2282 *
2283 * Compares the first two arguments and if identical marks as $type
2284 *
2285 * @since 2.8
2286 * @access private
2287 *
2288 * @param any $helper One of the values to compare
2289 * @param any $current (true) The other value to compare if not just true
2290 * @param bool $echo Whether to echo or just return the string
2291 * @param string $type The type of checked|selected|disabled we are doing
2292 * @return string html attribute or empty string
2293 */
2294function __checked_selected_helper( $helper, $current, $echo, $type ) {
2295        if ( (string) $helper === (string) $current )
2296                $result = " $type='$type'";
2297        else
2298                $result = '';
2299
2300        if ( $echo )
2301                echo $result;
2302
2303        return $result;
2304}
2305
2306?>