WordPress.org

Make WordPress Core

Ticket #18480: general-template.php

File general-template.php, 77.0 KB (added by gxxaxx, 4 years ago)

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