]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/general-template.php
Wordpress 2.8.4-scripts
[autoinstalls/wordpress.git] / wp-includes / general-template.php
index 1b1baf3092f0411eb34298b7f8b2b7405259dcb7..68c73cedaaf2bb70b6f0dce82c8370efbc3ca1d3 100644 (file)
 <?php
+/**
+ * General template tags that can go anywhere in a template.
+ *
+ * @package WordPress
+ * @subpackage Template
+ */
 
-/* Note: these tags go anywhere in the template */
+/**
+ * Load header template.
+ *
+ * Includes the header template for a theme or if a name is specified then a
+ * specialised header will be included. If the theme contains no header.php file
+ * then the header from the default theme will be included.
+ *
+ * For the parameter, if the file is called "header-special.php" then specify
+ * "special".
+ *
+ * @uses locate_template()
+ * @since 1.5.0
+ * @uses do_action() Calls 'get_header' action.
+ *
+ * @param string $name The name of the specialised header.
+ */
+function get_header( $name = null ) {
+       do_action( 'get_header', $name );
 
-function get_header() {
-       do_action( 'get_header' );
-       if ( file_exists( TEMPLATEPATH . '/header.php') )
-               load_template( TEMPLATEPATH . '/header.php');
-       else
-               load_template( ABSPATH . 'wp-content/themes/default/header.php');
-}
+       $templates = array();
+       if ( isset($name) )
+               $templates[] = "header-{$name}.php";
 
+       $templates[] = "header.php";
 
-function get_footer() {
-       do_action( 'get_footer' );
-       if ( file_exists( TEMPLATEPATH . '/footer.php') )
-               load_template( TEMPLATEPATH . '/footer.php');
-       else
-               load_template( ABSPATH . 'wp-content/themes/default/footer.php');
+       if ('' == locate_template($templates, true))
+               load_template( get_theme_root() . '/default/header.php');
 }
 
+/**
+ * Load footer template.
+ *
+ * Includes the footer template for a theme or if a name is specified then a
+ * specialised footer will be included. If the theme contains no footer.php file
+ * then the footer from the default theme will be included.
+ *
+ * For the parameter, if the file is called "footer-special.php" then specify
+ * "special".
+ *
+ * @uses locate_template()
+ * @since 1.5.0
+ * @uses do_action() Calls 'get_footer' action.
+ *
+ * @param string $name The name of the specialised footer.
+ */
+function get_footer( $name = null ) {
+       do_action( 'get_footer', $name );
+
+       $templates = array();
+       if ( isset($name) )
+               $templates[] = "footer-{$name}.php";
 
+       $templates[] = "footer.php";
+
+       if ('' == locate_template($templates, true))
+               load_template( get_theme_root() . '/default/footer.php');
+}
+
+/**
+ * Load sidebar template.
+ *
+ * Includes the sidebar template for a theme or if a name is specified then a
+ * specialised sidebar will be included. If the theme contains no sidebar.php
+ * file then the sidebar from the default theme will be included.
+ *
+ * For the parameter, if the file is called "sidebar-special.php" then specify
+ * "special".
+ *
+ * @uses locate_template()
+ * @since 1.5.0
+ * @uses do_action() Calls 'get_sidebar' action.
+ *
+ * @param string $name The name of the specialised sidebar.
+ */
 function get_sidebar( $name = null ) {
-       do_action( 'get_sidebar' );
-       if ( isset($name) && file_exists( TEMPLATEPATH . "/sidebar-{$name}.php") )
-               load_template( TEMPLATEPATH . "/sidebar-{$name}.php");
-       elseif ( file_exists( TEMPLATEPATH . '/sidebar.php') )
-               load_template( TEMPLATEPATH . '/sidebar.php');
-       else
-               load_template( ABSPATH . 'wp-content/themes/default/sidebar.php');
+       do_action( 'get_sidebar', $name );
+
+       $templates = array();
+       if ( isset($name) )
+               $templates[] = "sidebar-{$name}.php";
+
+       $templates[] = "sidebar.php";
+
+       if ('' == locate_template($templates, true))
+               load_template( get_theme_root() . '/default/sidebar.php');
 }
 
+/**
+ * Display search form.
+ *
+ * Will first attempt to locate the searchform.php file in either the child or
+ * the parent, then load it. If it doesn't exist, then the default search form
+ * will be displayed. The default search form is HTML, which will be displayed.
+ * There is a filter applied to the search form HTML in order to edit or replace
+ * it. The filter is 'get_search_form'.
+ *
+ * This function is primarily used by themes which want to hardcode the search
+ * form into the sidebar and also by the search widget in WordPress.
+ *
+ * There is also an action that is called whenever the function is run called,
+ * 'get_search_form'. This can be useful for outputting JavaScript that the
+ * search relies on or various formatting that applies to the beginning of the
+ * search. To give a few examples of what it can be used for.
+ *
+ * @since 2.7.0
+ */
+function get_search_form() {
+       do_action( 'get_search_form' );
 
-function wp_loginout() {
+       $search_form_template = locate_template(array('searchform.php'));
+       if ( '' != $search_form_template ) {
+               require($search_form_template);
+               return;
+       }
+
+       $form = '<form role="search" method="get" id="searchform" action="' . get_option('home') . '/" >
+       <div><label class="screen-reader-text" for="s">' . __('Search for:') . '</label>
+       <input type="text" value="' . esc_attr(apply_filters('the_search_query', get_search_query())) . '" name="s" id="s" />
+       <input type="submit" id="searchsubmit" value="'. esc_attr__('Search') .'" />
+       </div>
+       </form>';
+
+       echo apply_filters('get_search_form', $form);
+}
+
+/**
+ * Display the Log In/Out link.
+ *
+ * Displays a link, which allows the user to navigate to the Log In page to log in
+ * or log out depending on whether or not they are currently logged in.
+ *
+ * @since 1.5.0
+ * @uses apply_filters() Calls 'loginout' hook on HTML link content.
+ *
+ * @param string $redirect Optional path to redirect to on login/logout.
+ */
+function wp_loginout($redirect = '') {
        if ( ! is_user_logged_in() )
-               $link = '<a href="' . get_option('siteurl') . '/wp-login.php">' . __('Log in') . '</a>';
+               $link = '<a href="' . esc_url( wp_login_url($redirect) ) . '">' . __('Log in') . '</a>';
        else
-               $link = '<a href="' . get_option('siteurl') . '/wp-login.php?action=logout">' . __('Log out') . '</a>';
+               $link = '<a href="' . esc_url( wp_logout_url($redirect) ) . '">' . __('Log out') . '</a>';
 
        echo apply_filters('loginout', $link);
 }
 
+/**
+ * Returns the Log Out URL.
+ *
+ * Returns the URL that allows the user to log out of the site
+ *
+ * @since 2.7
+ * @uses wp_nonce_url() To protect against CSRF
+ * @uses site_url() To generate the log in URL
+ * @uses apply_filters() calls 'logout_url' hook on final logout url
+ *
+ * @param string $redirect Path to redirect to on logout.
+ */
+function wp_logout_url($redirect = '') {
+       $args = array( 'action' => 'logout' );
+       if ( !empty($redirect) ) {
+               $args['redirect_to'] = $redirect;
+       }
+
+       $logout_url = add_query_arg($args, site_url('wp-login.php', 'login'));
+       $logout_url = wp_nonce_url( $logout_url, 'log-out' );
 
+       return apply_filters('logout_url', $logout_url, $redirect);
+}
+
+/**
+ * Returns the Log In URL.
+ *
+ * Returns the URL that allows the user to log in to the site
+ *
+ * @since 2.7
+ * @uses site_url() To generate the log in URL
+ * @uses apply_filters() calls 'login_url' hook on final login url
+ *
+ * @param string $redirect Path to redirect to on login.
+ */
+function wp_login_url($redirect = '') {
+       $login_url = site_url('wp-login.php', 'login');
+
+       if ( !empty($redirect) ) {
+               $login_url = add_query_arg('redirect_to', urlencode($redirect), $login_url);
+       }
+
+       return apply_filters('login_url', $login_url, $redirect);
+}
+
+/**
+ * Returns the Lost Password URL.
+ *
+ * Returns the URL that allows the user to retrieve the lost password
+ *
+ * @since 2.8.0
+ * @uses site_url() To generate the lost password URL
+ * @uses apply_filters() calls 'lostpassword_url' hook on the lostpassword url
+ *
+ * @param string $redirect Path to redirect to on login.
+ */
+function wp_lostpassword_url($redirect = '') {
+       $args = array( 'action' => 'lostpassword' );
+       if ( !empty($redirect) ) {
+               $args['redirect_to'] = $redirect;
+       }
+
+       $lostpassword_url = add_query_arg($args, site_url('wp-login.php', 'login'));
+       return apply_filters('lostpassword_url', $lostpassword_url, $redirect);
+}
+
+/**
+ * Display the Registration or Admin link.
+ *
+ * Display a link which allows the user to navigate to the registration page if
+ * not logged in and registration is enabled or to the dashboard if logged in.
+ *
+ * @since 1.5.0
+ * @uses apply_filters() Calls 'register' hook on register / admin link content.
+ *
+ * @param string $before Text to output before the link (defaults to <li>).
+ * @param string $after Text to output after the link (defaults to </li>).
+ */
 function wp_register( $before = '<li>', $after = '</li>' ) {
 
        if ( ! is_user_logged_in() ) {
                if ( get_option('users_can_register') )
-                       $link = $before . '<a href="' . get_option('siteurl') . '/wp-login.php?action=register">' . __('Register') . '</a>' . $after;
+                       $link = $before . '<a href="' . site_url('wp-login.php?action=register', 'login') . '">' . __('Register') . '</a>' . $after;
                else
                        $link = '';
        } else {
-               $link = $before . '<a href="' . get_option('siteurl') . '/wp-admin/">' . __('Site Admin') . '</a>' . $after;
+               $link = $before . '<a href="' . admin_url() . '">' . __('Site Admin') . '</a>' . $after;
        }
 
        echo apply_filters('register', $link);
 }
 
-
+/**
+ * Theme container function for the 'wp_meta' action.
+ *
+ * The 'wp_meta' action can have several purposes, depending on how you use it,
+ * but one purpose might have been to allow for theme switching.
+ *
+ * @since 1.5.0
+ * @link http://trac.wordpress.org/ticket/1458 Explanation of 'wp_meta' action.
+ * @uses do_action() Calls 'wp_meta' hook.
+ */
 function wp_meta() {
        do_action('wp_meta');
 }
 
-
+/**
+ * Display information about the blog.
+ *
+ * @see get_bloginfo() For possible values for the parameter.
+ * @since 0.71
+ *
+ * @param string $show What to display.
+ */
 function bloginfo($show='') {
        echo get_bloginfo($show, 'display');
 }
 
 /**
- * Note: some of these values are DEPRECATED. Meaning they could be
- * taken out at any time and shouldn't be relied upon. Options
- * without "// DEPRECATED" are the preferred and recommended ways
- * to get the information.
+ * Retrieve information about the blog.
+ *
+ * Some show parameter values are deprecated and will be removed in future
+ * versions. Care should be taken to check the function contents and know what
+ * the deprecated blog info options are. Options without "// DEPRECATED" are
+ * the preferred and recommended ways to get the information.
+ *
+ * The possible values for the 'show' parameter are listed below.
+ * <ol>
+ * <li><strong>url<strong> - Blog URI to homepage.</li>
+ * <li><strong>wpurl</strong> - Blog URI path to WordPress.</li>
+ * <li><strong>description</strong> - Secondary title</li>
+ * </ol>
+ *
+ * The feed URL options can be retrieved from 'rdf_url' (RSS 0.91),
+ * 'rss_url' (RSS 1.0), 'rss2_url' (RSS 2.0), or 'atom_url' (Atom feed). The
+ * comment feeds can be retrieved from the 'comments_atom_url' (Atom comment
+ * feed) or 'comments_rss2_url' (RSS 2.0 comment feed).
+ *
+ * There are many other options and you should check the function contents:
+ * {@source 32 37}
+ *
+ * @since 0.71
+ *
+ * @param string $show Blog info to retrieve.
+ * @param string $filter How to filter what is retrieved.
+ * @return string Mostly string values, might be empty.
  */
 function get_bloginfo($show = '', $filter = 'raw') {
 
@@ -160,7 +387,28 @@ function get_bloginfo($show = '', $filter = 'raw') {
        return $output;
 }
 
-
+/**
+ * Display or retrieve page title for all areas of blog.
+ *
+ * By default, the page title will display the separator before the page title,
+ * so that the blog title will be before the page title. This is not good for
+ * title display, since the blog title shows up on most tabs and not what is
+ * important, which is the page that the user is looking at.
+ *
+ * There are also SEO benefits to having the blog title after or to the 'right'
+ * or the page title. However, it is mostly common sense to have the blog title
+ * to the right with most browsers supporting tabs. You can achieve this by
+ * using the seplocation parameter and setting the value to 'right'. This change
+ * was introduced around 2.5.0, in case backwards compatibility of themes is
+ * important.
+ *
+ * @since 1.0.0
+ *
+ * @param string $sep Optional, default is '&raquo;'. How to separate the various items within the page title.
+ * @param bool $display Optional, default is true. Whether to display or retrieve title.
+ * @param string $seplocation Optional. Direction to display title, 'right'.
+ * @return string|null String on retrieve, null when displaying.
+ */
 function wp_title($sep = '&raquo;', $display = true, $seplocation = '') {
        global $wpdb, $wp_locale, $wp_query;
 
@@ -173,8 +421,11 @@ function wp_title($sep = '&raquo;', $display = true, $seplocation = '') {
        $year = get_query_var('year');
        $monthnum = get_query_var('monthnum');
        $day = get_query_var('day');
+       $search = get_query_var('s');
        $title = '';
 
+       $t_sep = '%WP_TITILE_SEP%'; // Temporary separator, for accurate flipping, if necessary
+
        // If there's a category
        if ( !empty($cat) ) {
                        // category exclusion
@@ -216,34 +467,58 @@ function wp_title($sep = '&raquo;', $display = true, $seplocation = '') {
                $my_year = substr($m, 0, 4);
                $my_month = $wp_locale->get_month(substr($m, 4, 2));
                $my_day = intval(substr($m, 6, 2));
-               $title = "$my_year" . ($my_month ? "$sep $my_month" : "") . ($my_day ? "$sep $my_day" : "");
+               $title = "$my_year" . ($my_month ? "$t_sep$my_month" : "") . ($my_day ? "$t_sep$my_day" : "");
        }
 
        if ( !empty($year) ) {
                $title = $year;
                if ( !empty($monthnum) )
-                       $title .= " $sep " . $wp_locale->get_month($monthnum);
+                       $title .= "$t_sep" . $wp_locale->get_month($monthnum);
                if ( !empty($day) )
-                       $title .= " $sep " . zeroise($day, 2);
+                       $title .= "$t_sep" . zeroise($day, 2);
        }
 
        // If there is a post
-       if ( is_single() || is_page() ) {
+       if ( is_single() || ( is_home() && !is_front_page() ) || ( is_page() && !is_front_page() ) ) {
                $post = $wp_query->get_queried_object();
                $title = strip_tags( apply_filters( 'single_post_title', $post->post_title ) );
        }
 
+       // If there's a taxonomy
+       if ( is_tax() ) {
+               $taxonomy = get_query_var( 'taxonomy' );
+               $tax = get_taxonomy( $taxonomy );
+               $tax = $tax->label;
+               $term = $wp_query->get_queried_object();
+               $term = $term->name;
+               $title = "$tax$t_sep$term";
+       }
+
+       //If it's a search
+       if ( is_search() ) {
+               /* translators: 1: separator, 2: search phrase */
+               $title = sprintf(__('Search Results %1$s %2$s'), $t_sep, strip_tags($search));
+       }
+
+       if ( is_404() ) {
+               $title = __('Page not found');
+       }
+
        $prefix = '';
        if ( !empty($title) )
                $prefix = " $sep ";
 
-       // Determines position of the separator
-       if ( 'right' == $seplocation )
-               $title = $title . $prefix;
-       else
-               $title = $prefix . $title;
+       // Determines position of the separator and direction of the breadcrumb
+       if ( 'right' == $seplocation ) { // sep on right, so reverse the order
+               $title_array = explode( $t_sep, $title );
+               $title_array = array_reverse( $title_array );
+               $title = implode( " $sep ", $title_array ) . $prefix;
+       } else {
+               $title_array = explode( $t_sep, $title );
+               $title = $prefix . implode( " $sep ", $title_array );
+       }
 
-       $title = apply_filters('wp_title', $title, $sep);
+       $title = apply_filters('wp_title', $title, $sep, $seplocation);
 
        // Send it out
        if ( $display )
@@ -253,7 +528,24 @@ function wp_title($sep = '&raquo;', $display = true, $seplocation = '') {
 
 }
 
-
+/**
+ * Display or retrieve page title for post.
+ *
+ * This is optimized for single.php template file for displaying the post title.
+ * Only useful for posts, does not support pages for example.
+ *
+ * It does not support placing the separator after the title, but by leaving the
+ * prefix parameter empty, you can set the title separator manually. The prefix
+ * does not automatically place a space between the prefix, so if there should
+ * be a space, the parameter value will need to have it at the end.
+ *
+ * @since 0.71
+ * @uses $wpdb
+ *
+ * @param string $prefix Optional. What to display before the title.
+ * @param bool $display Optional, default is true. Whether to display or retrieve title.
+ * @return string|null Title when retrieving, null when displaying or failure.
+ */
 function single_post_title($prefix = '', $display = true) {
        global $wpdb;
        $p = get_query_var('p');
@@ -272,7 +564,23 @@ function single_post_title($prefix = '', $display = true) {
        }
 }
 
-
+/**
+ * Display or retrieve page title for category archive.
+ *
+ * This is useful for category template file or files, because it is optimized
+ * for category page title and with less overhead than {@link wp_title()}.
+ *
+ * It does not support placing the separator after the title, but by leaving the
+ * prefix parameter empty, you can set the title separator manually. The prefix
+ * does not automatically place a space between the prefix, so if there should
+ * be a space, the parameter value will need to have it at the end.
+ *
+ * @since 0.71
+ *
+ * @param string $prefix Optional. What to display before the title.
+ * @param bool $display Optional, default is true. Whether to display or retrieve title.
+ * @return string|null Title when retrieving, null when displaying or failure.
+ */
 function single_cat_title($prefix = '', $display = true ) {
        $cat = intval( get_query_var('cat') );
        if ( !empty($cat) && !(strtoupper($cat) == 'ALL') ) {
@@ -288,7 +596,23 @@ function single_cat_title($prefix = '', $display = true ) {
        }
 }
 
-
+/**
+ * Display or retrieve page title for tag post archive.
+ *
+ * Useful for tag template files for displaying the tag page title. It has less
+ * overhead than {@link wp_title()}, because of its limited implementation.
+ *
+ * It does not support placing the separator after the title, but by leaving the
+ * prefix parameter empty, you can set the title separator manually. The prefix
+ * does not automatically place a space between the prefix, so if there should
+ * be a space, the parameter value will need to have it at the end.
+ *
+ * @since 2.3.0
+ *
+ * @param string $prefix Optional. What to display before the title.
+ * @param bool $display Optional, default is true. Whether to display or retrieve title.
+ * @return string|null Title when retrieving, null when displaying or failure.
+ */
 function single_tag_title($prefix = '', $display = true ) {
        if ( !is_tag() )
                return;
@@ -309,7 +633,24 @@ function single_tag_title($prefix = '', $display = true ) {
        }
 }
 
-
+/**
+ * Display or retrieve page title for post archive based on date.
+ *
+ * Useful for when the template only needs to display the month and year, if
+ * either are available. Optimized for just this purpose, so if it is all that
+ * is needed, should be better than {@link wp_title()}.
+ *
+ * It does not support placing the separator after the title, but by leaving the
+ * prefix parameter empty, you can set the title separator manually. The prefix
+ * does not automatically place a space between the prefix, so if there should
+ * be a space, the parameter value will need to have it at the end.
+ *
+ * @since 0.71
+ *
+ * @param string $prefix Optional. What to display before the title.
+ * @param bool $display Optional, default is true. Whether to display or retrieve title.
+ * @return string|null Title when retrieving, null when displaying or failure.
+ */
 function single_month_title($prefix = '', $display = true ) {
        global $wp_locale;
 
@@ -335,31 +676,94 @@ function single_month_title($prefix = '', $display = true ) {
        echo $result;
 }
 
-
-/* link navigation hack by Orien http://icecode.com/ */
+/**
+ * Retrieve archive link content based on predefined or custom code.
+ *
+ * The format can be one of four styles. The 'link' for head element, 'option'
+ * for use in the select element, 'html' for use in list (either ol or ul HTML
+ * elements). Custom content is also supported using the before and after
+ * parameters.
+ *
+ * The 'link' format uses the link HTML element with the <em>archives</em>
+ * relationship. The before and after parameters are not used. The text
+ * parameter is used to describe the link.
+ *
+ * The 'option' format uses the option HTML element for use in select element.
+ * The value is the url parameter and the before and after parameters are used
+ * between the text description.
+ *
+ * The 'html' format, which is the default, uses the li HTML element for use in
+ * the list HTML elements. The before parameter is before the link and the after
+ * parameter is after the closing link.
+ *
+ * The custom format uses the before parameter before the link ('a' HTML
+ * element) and the after parameter after the closing link tag. If the above
+ * three values for the format are not used, then custom format is assumed.
+ *
+ * @since 1.0.0
+ * @author Orien
+ * @link http://icecode.com/ link navigation hack by Orien
+ *
+ * @param string $url URL to archive.
+ * @param string $text Archive text description.
+ * @param string $format Optional, default is 'html'. Can be 'link', 'option', 'html', or custom.
+ * @param string $before Optional.
+ * @param string $after Optional.
+ * @return string HTML link content for archive.
+ */
 function get_archives_link($url, $text, $format = 'html', $before = '', $after = '') {
        $text = wptexturize($text);
-       $title_text = attribute_escape($text);
-       $url = clean_url($url);
+       $title_text = esc_attr($text);
+       $url = esc_url($url);
 
        if ('link' == $format)
-               return "\t<link rel='archives' title='$title_text' href='$url' />\n";
+               $link_html = "\t<link rel='archives' title='$title_text' href='$url' />\n";
        elseif ('option' == $format)
-               return "\t<option value='$url'>$before $text $after</option>\n";
+               $link_html = "\t<option value='$url'>$before $text $after</option>\n";
        elseif ('html' == $format)
-               return "\t<li>$before<a href='$url' title='$title_text'>$text</a>$after</li>\n";
+               $link_html = "\t<li>$before<a href='$url' title='$title_text'>$text</a>$after</li>\n";
        else // custom
-               return "\t$before<a href='$url' title='$title_text'>$text</a>$after\n";
-}
+               $link_html = "\t$before<a href='$url' title='$title_text'>$text</a>$after\n";
+
+       $link_html = apply_filters( "get_archives_link", $link_html );
 
+       return $link_html;
+}
 
+/**
+ * Display archive links based on type and format.
+ *
+ * The 'type' argument offers a few choices and by default will display monthly
+ * archive links. The other options for values are 'daily', 'weekly', 'monthly',
+ * 'yearly', 'postbypost' or 'alpha'. Both 'postbypost' and 'alpha' display the
+ * same archive link list, the difference between the two is that 'alpha'
+ * will order by post title and 'postbypost' will order by post date.
+ *
+ * The date archives will logically display dates with links to the archive post
+ * page. The 'postbypost' and 'alpha' values for 'type' argument will display
+ * the post titles.
+ *
+ * The 'limit' argument will only display a limited amount of links, specified
+ * by the 'limit' integer value. By default, there is no limit. The
+ * 'show_post_count' argument will show how many posts are within the archive.
+ * By default, the 'show_post_count' argument is set to false.
+ *
+ * For the 'format', 'before', and 'after' arguments, see {@link
+ * get_archives_link()}. The values of these arguments have to do with that
+ * function.
+ *
+ * @since 1.2.0
+ *
+ * @param string|array $args Optional. Override defaults.
+ */
 function wp_get_archives($args = '') {
        global $wpdb, $wp_locale;
 
        $defaults = array(
                'type' => 'monthly', 'limit' => '',
                'format' => 'html', 'before' => '',
-               'after' => '', 'show_post_count' => false
+               'after' => '', 'show_post_count' => false,
+               'echo' => 1
        );
 
        $r = wp_parse_args( $args, $defaults );
@@ -396,8 +800,10 @@ function wp_get_archives($args = '') {
        $where = apply_filters('getarchives_where', "WHERE post_type = 'post' AND post_status = 'publish'", $r );
        $join = apply_filters('getarchives_join', "", $r);
 
+       $output = '';
+
        if ( 'monthly' == $type ) {
-               $query = "SELECT DISTINCT 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";
+               $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";
                $key = md5($query);
                $cache = wp_cache_get( 'wp_get_archives' , 'general');
                if ( !isset( $cache[ $key ] ) ) {
@@ -409,16 +815,16 @@ function wp_get_archives($args = '') {
                }
                if ( $arcresults ) {
                        $afterafter = $after;
-                       foreach ( $arcresults as $arcresult ) {
-                               $url    = get_month_link($arcresult->year,      $arcresult->month);
+                       foreach ( (array) $arcresults as $arcresult ) {
+                               $url = get_month_link( $arcresult->year, $arcresult->month );
                                $text = sprintf(__('%1$s %2$d'), $wp_locale->get_month($arcresult->month), $arcresult->year);
                                if ( $show_post_count )
                                        $after = '&nbsp;('.$arcresult->posts.')' . $afterafter;
-                               echo get_archives_link($url, $text, $format, $before, $after);
+                               $output .= get_archives_link($url, $text, $format, $before, $after);
                        }
                }
        } elseif ('yearly' == $type) {
-               $query = "SELECT DISTINCT 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";
+               $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";
                $key = md5($query);
                $cache = wp_cache_get( 'wp_get_archives' , 'general');
                if ( !isset( $cache[ $key ] ) ) {
@@ -430,16 +836,16 @@ function wp_get_archives($args = '') {
                }
                if ($arcresults) {
                        $afterafter = $after;
-                       foreach ($arcresults as $arcresult) {
+                       foreach ( (array) $arcresults as $arcresult) {
                                $url = get_year_link($arcresult->year);
                                $text = sprintf('%d', $arcresult->year);
                                if ($show_post_count)
                                        $after = '&nbsp;('.$arcresult->posts.')' . $afterafter;
-                               echo get_archives_link($url, $text, $format, $before, $after);
+                               $output .= get_archives_link($url, $text, $format, $before, $after);
                        }
                }
        } elseif ( 'daily' == $type ) {
-               $query = "SELECT DISTINCT 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";
+               $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";
                $key = md5($query);
                $cache = wp_cache_get( 'wp_get_archives' , 'general');
                if ( !isset( $cache[ $key ] ) ) {
@@ -451,13 +857,13 @@ function wp_get_archives($args = '') {
                }
                if ( $arcresults ) {
                        $afterafter = $after;
-                       foreach ( $arcresults as $arcresult ) {
+                       foreach ( (array) $arcresults as $arcresult ) {
                                $url    = get_day_link($arcresult->year, $arcresult->month, $arcresult->dayofmonth);
                                $date = sprintf('%1$d-%2$02d-%3$02d 00:00:00', $arcresult->year, $arcresult->month, $arcresult->dayofmonth);
                                $text = mysql2date($archive_day_date_format, $date);
                                if ($show_post_count)
                                        $after = '&nbsp;('.$arcresult->posts.')'.$afterafter;
-                               echo get_archives_link($url, $text, $format, $before, $after);
+                               $output .= get_archives_link($url, $text, $format, $before, $after);
                        }
                }
        } elseif ( 'weekly' == $type ) {
@@ -475,7 +881,7 @@ function wp_get_archives($args = '') {
                $arc_w_last = '';
                $afterafter = $after;
                if ( $arcresults ) {
-                               foreach ( $arcresults as $arcresult ) {
+                               foreach ( (array) $arcresults as $arcresult ) {
                                        if ( $arcresult->week != $arc_w_last ) {
                                                $arc_year = $arcresult->yr;
                                                $arc_w_last = $arcresult->week;
@@ -486,12 +892,12 @@ function wp_get_archives($args = '') {
                                                $text = $arc_week_start . $archive_week_separator . $arc_week_end;
                                                if ($show_post_count)
                                                        $after = '&nbsp;('.$arcresult->posts.')'.$afterafter;
-                                               echo get_archives_link($url, $text, $format, $before, $after);
+                                               $output .= get_archives_link($url, $text, $format, $before, $after);
                                        }
                                }
                }
        } elseif ( ( 'postbypost' == $type ) || ('alpha' == $type) ) {
-               ('alpha' == $type) ? $orderby = "post_title ASC " : $orderby = "post_date DESC ";
+               $orderby = ('alpha' == $type) ? "post_title ASC " : "post_date DESC ";
                $query = "SELECT * FROM $wpdb->posts $join $where ORDER BY $orderby $limit";
                $key = md5($query);
                $cache = wp_cache_get( 'wp_get_archives' , 'general');
@@ -503,7 +909,7 @@ function wp_get_archives($args = '') {
                        $arcresults = $cache[ $key ];
                }
                if ( $arcresults ) {
-                       foreach ( $arcresults as $arcresult ) {
+                       foreach ( (array) $arcresults as $arcresult ) {
                                if ( $arcresult->post_date != '0000-00-00 00:00:00' ) {
                                        $url  = get_permalink($arcresult);
                                        $arc_title = $arcresult->post_title;
@@ -511,40 +917,67 @@ function wp_get_archives($args = '') {
                                                $text = strip_tags(apply_filters('the_title', $arc_title));
                                        else
                                                $text = $arcresult->ID;
-                                       echo get_archives_link($url, $text, $format, $before, $after);
+                                       $output .= get_archives_link($url, $text, $format, $before, $after);
                                }
                        }
                }
        }
+       if ( $echo )
+               echo $output;
+       else
+               return $output;
 }
 
-
-// Used in get_calendar
+/**
+ * Get number of days since the start of the week.
+ *
+ * @since 1.5.0
+ * @usedby get_calendar()
+ *
+ * @param int $num Number of day.
+ * @return int Days since the start of the week.
+ */
 function calendar_week_mod($num) {
        $base = 7;
        return ($num - $base*floor($num/$base));
 }
 
-
+/**
+ * Display calendar with days that have posts as links.
+ *
+ * The calendar is cached, which will be retrieved, if it exists. If there are
+ * no posts for the month, then it will not be displayed.
+ *
+ * @since 1.0.0
+ *
+ * @param bool $initial Optional, default is true. Use initial calendar names.
+ */
 function get_calendar($initial = true) {
        global $wpdb, $m, $monthnum, $year, $wp_locale, $posts;
 
+       $cache = array();
        $key = md5( $m . $monthnum . $year );
        if ( $cache = wp_cache_get( 'get_calendar', 'calendar' ) ) {
-               if ( isset( $cache[ $key ] ) ) {
+               if ( is_array($cache) && isset( $cache[ $key ] ) ) {
                        echo $cache[ $key ];
                        return;
                }
        }
 
-       ob_start();
+       if ( !is_array($cache) )
+               $cache = array();
+
        // Quick check. If we have no posts at all, abort!
        if ( !$posts ) {
-               $gotsome = $wpdb->get_var("SELECT ID from $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish' ORDER BY post_date DESC LIMIT 1");
-               if ( !$gotsome )
+               $gotsome = $wpdb->get_var("SELECT 1 as test FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish' LIMIT 1");
+               if ( !$gotsome ) {
+                       $cache[ $key ] = '';
+                       wp_cache_set( 'get_calendar', $cache, 'calendar' );
                        return;
+               }
        }
 
+       ob_start();
        if ( isset($_GET['w']) )
                $w = ''.intval($_GET['w']);
 
@@ -588,8 +1021,10 @@ function get_calendar($initial = true) {
                        ORDER   BY post_date ASC
                        LIMIT 1");
 
+       /* translators: Calendar caption: 1: month name, 2: 4-digit year */
+       $calendar_caption = _x('%1$s %2$s', 'calendar caption');
        echo '<table id="wp-calendar" summary="' . __('Calendar') . '">
-       <caption>' . sprintf(_c('%1$s %2$s|Used as a calendar caption'), $wp_locale->get_month($thismonth), date('Y', $unixmonth)) . '</caption>
+       <caption>' . sprintf($calendar_caption, $wp_locale->get_month($thismonth), date('Y', $unixmonth)) . '</caption>
        <thead>
        <tr>';
 
@@ -643,7 +1078,7 @@ function get_calendar($initial = true) {
                AND post_type = 'post' AND post_status = 'publish'
                AND post_date < '" . current_time('mysql') . '\'', ARRAY_N);
        if ( $dayswithposts ) {
-               foreach ( $dayswithposts as $daywith ) {
+               foreach ( (array) $dayswithposts as $daywith ) {
                        $daywithpost[] = $daywith[0];
                }
        } else {
@@ -664,10 +1099,9 @@ function get_calendar($initial = true) {
                ."AND post_type = 'post' AND post_status = 'publish'"
        );
        if ( $ak_post_titles ) {
-               foreach ( $ak_post_titles as $ak_post_title ) {
+               foreach ( (array) $ak_post_titles as $ak_post_title ) {
 
-                               $post_title = apply_filters( "the_title", $ak_post_title->post_title );
-                               $post_title = str_replace('"', '&quot;', wptexturize( $post_title ));
+                               $post_title = esc_attr( apply_filters( 'the_title', $ak_post_title->post_title ) );
 
                                if ( empty($ak_titles_for_day['day_'.$ak_post_title->dom]) )
                                        $ak_titles_for_day['day_'.$ak_post_title->dom] = '';
@@ -718,6 +1152,12 @@ function get_calendar($initial = true) {
        wp_cache_set( 'get_calendar', $cache, 'calendar' );
 }
 
+/**
+ * Purge the cached results of get_calendar.
+ *
+ * @see get_calendar
+ * @since 2.1.0
+ */
 function delete_get_calendar_cache() {
        wp_cache_delete( 'get_calendar', 'calendar' );
 }
@@ -727,11 +1167,21 @@ add_action( 'update_option_start_of_week', 'delete_get_calendar_cache' );
 add_action( 'update_option_gmt_offset', 'delete_get_calendar_cache' );
 add_action( 'update_option_start_of_week', 'delete_get_calendar_cache' );
 
-
+/**
+ * Display all of the allowed tags in HTML format with attributes.
+ *
+ * This is useful for displaying in the comment area, which elements and
+ * attributes are supported. As well as any plugins which want to display it.
+ *
+ * @since 1.0.1
+ * @uses $allowedtags
+ *
+ * @return string HTML allowed tags entity encoded.
+ */
 function allowed_tags() {
        global $allowedtags;
        $allowed = '';
-       foreach ( $allowedtags as $tag => $attributes ) {
+       foreach ( (array) $allowedtags as $tag => $attributes ) {
                $allowed .= '<'.$tag;
                if ( 0 < count($attributes) ) {
                        foreach ( $attributes as $attribute => $limits ) {
@@ -743,17 +1193,32 @@ function allowed_tags() {
        return htmlentities($allowed);
 }
 
-
 /***** Date/Time tags *****/
 
-
+/**
+ * Outputs the date in iso8601 format for xml files.
+ *
+ * @since 1.0.0
+ */
 function the_date_xml() {
        global $post;
-       echo mysql2date('Y-m-d', $post->post_date);
-       //echo ""+$post->post_date;
+       echo mysql2date('Y-m-d', $post->post_date, false);
 }
 
-
+/**
+ * Display or Retrieve the date the post was written.
+ *
+ * Will only output the date if the current post's date is different from the
+ * previous one output.
+ *
+ * @since 0.71
+ *
+ * @param string $d Optional. PHP date format defaults to the date_format option if not specified.
+ * @param string $before Optional. Output before the date.
+ * @param string $after Optional. Output after the date.
+ * @param bool $echo Optional, default is display. Whether to echo the date or return it.
+ * @return string|null Null if displaying, string if retrieving.
+ */
 function the_date($d='', $before='', $after='', $echo = true) {
        global $post, $day, $previousday;
        $the_date = '';
@@ -765,96 +1230,177 @@ function the_date($d='', $before='', $after='', $echo = true) {
                        $the_date .= mysql2date($d, $post->post_date);
                $the_date .= $after;
                $previousday = $day;
-       }
+
        $the_date = apply_filters('the_date', $the_date, $d, $before, $after);
        if ( $echo )
                echo $the_date;
        else
                return $the_date;
+       }
 }
 
-
+/**
+ * Display the date on which the post was last modified.
+ *
+ * @since 2.1.0
+ *
+ * @param string $d Optional. PHP date format.
+ * @return string
+ */
 function the_modified_date($d = '') {
        echo apply_filters('the_modified_date', get_the_modified_date($d), $d);
 }
 
-
+/**
+ * Retrieve the date on which the post was last modified.
+ *
+ * @since 2.1.0
+ *
+ * @param string $d Optional. PHP date format. Defaults to the "date_format" option
+ * @return string
+ */
 function get_the_modified_date($d = '') {
        if ( '' == $d )
-               $the_time = get_post_modified_time(get_option('date_format'));
+               $the_time = get_post_modified_time(get_option('date_format'), null, null, true);
        else
-               $the_time = get_post_modified_time($d);
+               $the_time = get_post_modified_time($d, null, null, true);
        return apply_filters('get_the_modified_date', $the_time, $d);
 }
 
-
+/**
+ * Display the time at which the post was written.
+ *
+ * @since 0.71
+ *
+ * @param string $d Either 'G', 'U', or php date format.
+ */
 function the_time( $d = '' ) {
        echo apply_filters('the_time', get_the_time( $d ), $d);
 }
 
+/**
+ * Retrieve the time at which the post was written.
+ *
+ * @since 1.5.0
+ *
+ * @param string $d Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
+ * @param int|object $post Optional post ID or object. Default is global $post object.
+ * @return string
+ */
+function get_the_time( $d = '', $post = null ) {
+       $post = get_post($post);
 
-function get_the_time( $d = '' ) {
        if ( '' == $d )
-               $the_time = get_post_time(get_option('time_format'));
+               $the_time = get_post_time(get_option('time_format'), false, $post, true);
        else
-               $the_time = get_post_time($d);
-       return apply_filters('get_the_time', $the_time, $d);
+               $the_time = get_post_time($d, false, $post, true);
+       return apply_filters('get_the_time', $the_time, $d, $post);
 }
 
+/**
+ * Retrieve the time at which the post was written.
+ *
+ * @since 2.0.0
+ *
+ * @param string $d Either 'G', 'U', or php date format.
+ * @param bool $gmt Whether of not to return the gmt time.
+ * @param int|object $post Optional post ID or object. Default is global $post object.
+ * @param bool $translate Whether to translate the time string or not
+ * @return string
+ */
+function get_post_time( $d = 'U', $gmt = false, $post = null, $translate = false ) { // returns timestamp
+       $post = get_post($post);
 
-function get_post_time( $d = 'U', $gmt = false ) { // returns timestamp
-       global $post;
        if ( $gmt )
                $time = $post->post_date_gmt;
        else
                $time = $post->post_date;
 
-       $time = mysql2date($d, $time);
-       return apply_filters('get_the_time', $time, $d, $gmt);
+       $time = mysql2date($d, $time, $translate);
+       return apply_filters('get_post_time', $time, $d, $gmt);
 }
 
-
+/**
+ * Display the time at which the post was last modified.
+ *
+ * @since 2.0.0
+ *
+ * @param string $d Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
+ */
 function the_modified_time($d = '') {
        echo apply_filters('the_modified_time', get_the_modified_time($d), $d);
 }
 
-
+/**
+ * Retrieve the time at which the post was last modified.
+ *
+ * @since 2.0.0
+ *
+ * @param string $d Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
+ * @return string
+ */
 function get_the_modified_time($d = '') {
        if ( '' == $d )
-               $the_time = get_post_modified_time(get_option('time_format'));
+               $the_time = get_post_modified_time(get_option('time_format'), null, null, true);
        else
-               $the_time = get_post_modified_time($d);
+               $the_time = get_post_modified_time($d, null, null, true);
        return apply_filters('get_the_modified_time', $the_time, $d);
 }
 
-
-function get_post_modified_time( $d = 'U', $gmt = false ) { // returns timestamp
-       global $post;
+/**
+ * Retrieve the time at which the post was last modified.
+ *
+ * @since 2.0.0
+ *
+ * @param string $d Either 'G', 'U', or php date format.
+ * @param bool $gmt Whether of not to return the gmt time.
+ * @param int|object $post A post_id or post object
+ * @param bool translate Whether to translate the result or not
+ * @return string Returns timestamp
+ */
+function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
+       $post = get_post($post);
 
        if ( $gmt )
                $time = $post->post_modified_gmt;
        else
                $time = $post->post_modified;
-       $time = mysql2date($d, $time);
+       $time = mysql2date($d, $time, $translate);
 
-       return apply_filters('get_the_modified_time', $time, $d, $gmt);
+       return apply_filters('get_post_modified_time', $time, $d, $gmt);
 }
 
-
+/**
+ * Display the weekday on which the post was written.
+ *
+ * @since 0.71
+ * @uses $wp_locale
+ * @uses $post
+ */
 function the_weekday() {
        global $wp_locale, $post;
-       $the_weekday = $wp_locale->get_weekday(mysql2date('w', $post->post_date));
+       $the_weekday = $wp_locale->get_weekday(mysql2date('w', $post->post_date, false));
        $the_weekday = apply_filters('the_weekday', $the_weekday);
        echo $the_weekday;
 }
 
-
+/**
+ * Display the weekday on which the post was written.
+ *
+ * Will only output the weekday if the current post's weekday is different from
+ * the previous one output.
+ *
+ * @since 0.71
+ *
+ * @param string $before output before the date.
+ * @param string $after output after the date.
+  */
 function the_weekday_date($before='',$after='') {
        global $wp_locale, $post, $day, $previousweekday;
        $the_weekday_date = '';
        if ( $day != $previousweekday ) {
                $the_weekday_date .= $before;
-               $the_weekday_date .= $wp_locale->get_weekday(mysql2date('w', $post->post_date));
+               $the_weekday_date .= $wp_locale->get_weekday(mysql2date('w', $post->post_date, false));
                $the_weekday_date .= $after;
                $previousweekday = $day;
        }
@@ -862,29 +1408,166 @@ function the_weekday_date($before='',$after='') {
        echo $the_weekday_date;
 }
 
+/**
+ * Fire the wp_head action
+ *
+ * @since 1.2.0
+ * @uses do_action() Calls 'wp_head' hook.
+ */
 function wp_head() {
        do_action('wp_head');
 }
 
+/**
+ * Fire the wp_footer action
+ *
+ * @since 1.5.1
+ * @uses do_action() Calls 'wp_footer' hook.
+ */
 function wp_footer() {
        do_action('wp_footer');
 }
 
+/**
+ * Enable/disable automatic general feed link outputting.
+ *
+ * @since 2.8.0
+ *
+ * @param boolean $add Add or remove links. Defaults to true.
+ */
+function automatic_feed_links( $add = true ) {
+       if ( $add )
+               add_action( 'wp_head', 'feed_links', 2 );
+       else {
+               remove_action( 'wp_head', 'feed_links', 2 );
+               remove_action( 'wp_head', 'feed_links_extra', 3 );
+       }
+}
+
+/**
+ * Display the links to the general feeds.
+ *
+ * @since 2.8.0
+ *
+ * @param array $args Optional arguments.
+ */
+function feed_links( $args ) {
+       $defaults = array(
+               /* translators: Separator between blog name and feed type in feed links */
+               'separator'     => _x('&raquo;', 'feed link'),
+               /* translators: 1: blog title, 2: separator (raquo) */
+               'feedtitle'     => __('%1$s %2$s Feed'),
+               /* translators: %s: blog title, 2: separator (raquo) */
+               'comstitle'     => __('%1$s %2$s Comments Feed'),
+       );
+
+       $args = wp_parse_args( $args, $defaults );
+
+       echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . esc_attr(sprintf( $args['feedtitle'], get_bloginfo('name'), $args['separator'] )) . '" href="' . get_feed_link() . "\" />\n";
+       echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . esc_attr(sprintf( $args['comstitle'], get_bloginfo('name'), $args['separator'] )) . '" href="' . get_feed_link( 'comments_' . get_default_feed() ) . "\" />\n";
+}
+
+/**
+ * Display the links to the extra feeds such as category feeds.
+ *
+ * @since 2.8.0
+ *
+ * @param array $args Optional arguments.
+ */
+function feed_links_extra( $args ) {
+       $defaults = array(
+               /* translators: Separator between blog name and feed type in feed links */
+               'separator'   => _x('&raquo;', 'feed link'),
+               /* translators: 1: blog name, 2: separator(raquo), 3: post title */
+               'singletitle' => __('%1$s %2$s %3$s Comments Feed'),
+               /* translators: 1: blog name, 2: separator(raquo), 3: category name */
+               'cattitle'    => __('%1$s %2$s %3$s Category Feed'),
+               /* translators: 1: blog name, 2: separator(raquo), 3: tag name */
+               'tagtitle'    => __('%1$s %2$s %3$s Tag Feed'),
+               /* translators: 1: blog name, 2: separator(raquo), 3: author name  */
+               'authortitle' => __('%1$s %2$s Posts by %3$s Feed'),
+               /* translators: 1: blog name, 2: separator(raquo), 3: search phrase */
+               'searchtitle' => __('%1$s %2$s Search Results for &#8220;%3$s&#8221; Feed'),
+       );
+
+       $args = wp_parse_args( $args, $defaults );
+
+       if ( is_single() || is_page() ) {
+               $post = &get_post( $id = 0 );
+
+               if ( comments_open() || pings_open() || $post->comment_count > 0 ) {
+                       $title = esc_attr(sprintf( $args['singletitle'], get_bloginfo('name'), $args['separator'], esc_html( get_the_title() ) ));
+                       $href = get_post_comments_feed_link( $post->ID );
+               }
+       } elseif ( is_category() ) {
+               $cat_id = intval( get_query_var('cat') );
+
+               $title = esc_attr(sprintf( $args['cattitle'], get_bloginfo('name'), $args['separator'], get_cat_name( $cat_id ) ));
+               $href = get_category_feed_link( $cat_id );
+       } elseif ( is_tag() ) {
+               $tag_id = intval( get_query_var('tag_id') );
+               $tag = get_tag( $tag_id );
+
+               $title = esc_attr(sprintf( $args['tagtitle'], get_bloginfo('name'), $args['separator'], $tag->name ));
+               $href = get_tag_feed_link( $tag_id );
+       } elseif ( is_author() ) {
+               $author_id = intval( get_query_var('author') );
+
+               $title = esc_attr(sprintf( $args['authortitle'], get_bloginfo('name'), $args['separator'], get_the_author_meta( 'display_name', $author_id ) ));
+               $href = get_author_feed_link( $author_id );
+       } elseif ( is_search() ) {
+               $title = esc_attr(sprintf( $args['searchtitle'], get_bloginfo('name'), $args['separator'], get_search_query() ));
+               $href = get_search_feed_link();
+       }
+
+       if ( isset($title) && isset($href) )
+               echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . $title . '" href="' . $href . '" />' . "\n";
+}
+
+/**
+ * Display the link to the Really Simple Discovery service endpoint.
+ *
+ * @link http://archipelago.phrasewise.com/rsd
+ * @since 2.0.0
+ */
 function rsd_link() {
        echo '<link rel="EditURI" type="application/rsd+xml" title="RSD" href="' . get_bloginfo('wpurl') . "/xmlrpc.php?rsd\" />\n";
 }
 
+/**
+ * Display the link to the Windows Live Writer manifest file.
+ *
+ * @link http://msdn.microsoft.com/en-us/library/bb463265.aspx
+ * @since 2.3.1
+ */
 function wlwmanifest_link() {
        echo '<link rel="wlwmanifest" type="application/wlwmanifest+xml" href="'
                . get_bloginfo('wpurl') . '/wp-includes/wlwmanifest.xml" /> ' . "\n";
 }
 
+/**
+ * Display a noindex meta tag if required by the blog configuration.
+ *
+ * If a blog is marked as not being public then the noindex meta tag will be
+ * output to tell web robots not to index the page content.
+ *
+ * @since 2.1.0
+ */
 function noindex() {
        // If the blog is not public, tell robots to go away.
        if ( '0' == get_option('blog_public') )
                echo "<meta name='robots' content='noindex,nofollow' />\n";
 }
 
+/**
+ * Determine if TinyMCE is available.
+ *
+ * Checks to see if the user has deleted the tinymce files to slim down there WordPress install.
+ *
+ * @since 2.1.0
+ *
+ * @return bool Whether of not TinyMCE exists.
+ */
 function rich_edit_exists() {
        global $wp_rich_edit_exists;
        if ( !isset($wp_rich_edit_exists) )
@@ -892,6 +1575,16 @@ function rich_edit_exists() {
        return $wp_rich_edit_exists;
 }
 
+/**
+ * Whether or not the user should have a WYSIWIG editor.
+ *
+ * Checks that the user requires a WYSIWIG editor and that the editor is
+ * supported in the users browser.
+ *
+ * @since 2.0.0
+ *
+ * @return bool
+ */
 function user_can_richedit() {
        global $wp_rich_edit, $pagenow;
 
@@ -909,98 +1602,134 @@ function user_can_richedit() {
        return apply_filters('user_can_richedit', $wp_rich_edit);
 }
 
+/**
+ * Find out which editor should be displayed by default.
+ *
+ * Works out which of the two editors to display as the current editor for a
+ * user.
+ *
+ * @since 2.5.0
+ *
+ * @return string Either 'tinymce', or 'html', or 'test'
+ */
 function wp_default_editor() {
        $r = user_can_richedit() ? 'tinymce' : 'html'; // defaults
        if ( $user = wp_get_current_user() ) { // look for cookie
-               if ( isset($_COOKIE['wordpress_editor_' . $user->ID]) && in_array($_COOKIE['wordpress_editor_' . $user->ID], array('tinymce', 'html', 'test') ) )
-                       $r = $_COOKIE['wordpress_editor_' . $user->ID];
+               $ed = get_user_setting('editor', 'tinymce');
+               $r = ( in_array($ed, array('tinymce', 'html', 'test') ) ) ? $ed : $r;
        }
        return apply_filters( 'wp_default_editor', $r ); // filter
 }
 
+/**
+ * Display visual editor forms: TinyMCE, or HTML, or both.
+ *
+ * The amount of rows the text area will have for the content has to be between
+ * 3 and 100 or will default at 12. There is only one option used for all users,
+ * named 'default_post_edit_rows'.
+ *
+ * If the user can not use the rich editor (TinyMCE), then the switch button
+ * will not be displayed.
+ *
+ * @since 2.1.0
+ *
+ * @param string $content Textarea content.
+ * @param string $id HTML ID attribute value.
+ * @param string $prev_id HTML ID name for switching back and forth between visual editors.
+ * @param bool $media_buttons Optional, default is true. Whether to display media buttons.
+ * @param int $tab_index Optional, default is 2. Tabindex for textarea element.
+ */
 function the_editor($content, $id = 'content', $prev_id = 'title', $media_buttons = true, $tab_index = 2) {
        $rows = get_option('default_post_edit_rows');
        if (($rows < 3) || ($rows > 100))
                $rows = 12;
 
-       $rows = "rows='$rows'"; ?>
+       if ( !current_user_can( 'upload_files' ) )
+               $media_buttons = false;
+
+       $richedit =  user_can_richedit();
+       $class = '';
+
+       if ( $richedit || $media_buttons ) { ?>
        <div id="editor-toolbar">
-       <?php if ( user_can_richedit() ) {
+<?php
+       if ( $richedit ) {
                $wp_default_editor = wp_default_editor(); ?>
                <div class="zerosize"><input accesskey="e" type="button" onclick="switchEditors.go('<?php echo $id; ?>')" /></div>
-               <?php if ( 'tinymce' == $wp_default_editor ) {
-                       add_filter('the_editor_content', 'wp_richedit_pre'); ?>
-                       <a id="edButtonHTML" onclick="switchEditors.go('<?php echo $id; ?>');"><?php _e('HTML'); ?></a>
-                       <a id="edButtonPreview" class="active"><?php _e('Visual'); ?></a>
-               <?php } elseif ( 'html' == $wp_default_editor ) {
+<?php  if ( 'html' == $wp_default_editor ) {
                        add_filter('the_editor_content', 'wp_htmledit_pre'); ?>
-                       <a id="edButtonHTML" class="active"><?php _e('HTML'); ?></a>
-                       <a id="edButtonPreview" onclick="switchEditors.go('<?php echo $id; ?>');"><?php _e('Visual'); ?></a>
-               <?php }
+                       <a id="edButtonHTML" class="active hide-if-no-js" onclick="switchEditors.go('<?php echo $id; ?>', 'html');"><?php _e('HTML'); ?></a>
+                       <a id="edButtonPreview" class="hide-if-no-js" onclick="switchEditors.go('<?php echo $id; ?>', 'tinymce');"><?php _e('Visual'); ?></a>
+<?php  } else {
+                       $class = " class='theEditor'";
+                       add_filter('the_editor_content', 'wp_richedit_pre'); ?>
+                       <a id="edButtonHTML" class="hide-if-no-js" onclick="switchEditors.go('<?php echo $id; ?>', 'html');"><?php _e('HTML'); ?></a>
+                       <a id="edButtonPreview" class="active hide-if-no-js" onclick="switchEditors.go('<?php echo $id; ?>', 'tinymce');"><?php _e('Visual'); ?></a>
+<?php  }
        }
 
        if ( $media_buttons ) { ?>
                <div id="media-buttons" class="hide-if-no-js">
-               <?php do_action( 'media_buttons' ); ?>
+<?php  do_action( 'media_buttons' ); ?>
                </div>
-       <?php } ?>
+<?php
+       } ?>
        </div>
-
-       <div id="quicktags">
-       <?php wp_print_scripts( 'quicktags' ); ?>
+<?php
+       }
+?>
+       <div id="quicktags"><?php
+       wp_print_scripts( 'quicktags' ); ?>
        <script type="text/javascript">edToolbar()</script>
        </div>
 
-    <?php if ( 'html' != $wp_default_editor ) : ?>
-    <script type="text/javascript">
-    // <![CDATA[
-        if ( typeof tinyMCE != "undefined" )
-            document.getElementById("quicktags").style.display="none";
-    // ]]>
-    </script>
-    <?php endif; // 'html' != $wp_default_editor
-
-       $the_editor = apply_filters('the_editor', "<div id='editorcontainer'><textarea class='' $rows cols='40' name='$id' tabindex='$tab_index' id='$id'>%s</textarea></div>\n");
+<?php
+       $the_editor = apply_filters('the_editor', "<div id='editorcontainer'><textarea rows='$rows'$class cols='40' name='$id' tabindex='$tab_index' id='$id'>%s</textarea></div>\n");
        $the_editor_content = apply_filters('the_editor_content', $content);
 
        printf($the_editor, $the_editor_content);
 
-       ?>
-    <script type="text/javascript">
-    // <![CDATA[
-    edCanvas = document.getElementById('<?php echo $id; ?>');
-    <?php if ( $prev_id && user_can_richedit() ) : ?>
-    // If tinyMCE is defined.
-    if ( typeof tinyMCE != 'undefined' ) {
-    // This code is meant to allow tabbing from Title to Post (TinyMCE).
-        document.getElementById('<?php echo $prev_id; ?>').onkeydown = function (e) {
-            e = e || window.event;
-            if (e.keyCode == 9 && !e.shiftKey && !e.controlKey && !e.altKey) {
-                if ( tinyMCE.activeEditor ) {
-                    if ( (jQuery("#post_ID").val() < 1) && (jQuery("#title").val().length > 0) ) { autosave(); }
-                    e = null;
-                    if ( tinyMCE.activeEditor.isHidden() ) return true;
-                    tinyMCE.activeEditor.focus();
-                    return false;
-                }
-                return true;
-            }
-        }
-    }
-    <?php endif; ?>
-    // ]]>
-    </script>
-    <?php
+?>
+       <script type="text/javascript">
+       edCanvas = document.getElementById('<?php echo $id; ?>');
+       </script>
+<?php
 }
 
+/**
+ * Retrieve the contents of the search WordPress query variable.
+ *
+ * @since 2.3.0
+ *
+ * @return string
+ */
 function get_search_query() {
        return apply_filters( 'get_search_query', stripslashes( get_query_var( 's' ) ) );
 }
 
+/**
+ * Display the contents of the search query variable.
+ *
+ * The search query string is passed through {@link esc_attr()}
+ * to ensure that it is safe for placing in an html attribute.
+ *
+ * @uses attr
+ * @since 2.1.0
+ */
 function the_search_query() {
-       echo attribute_escape( apply_filters( 'the_search_query', get_search_query() ) );
+       echo esc_attr( apply_filters( 'the_search_query', get_search_query() ) );
 }
 
+/**
+ * Display the language attributes for the html tag.
+ *
+ * Builds up a set of html attributes containing the text direction and language
+ * information for the page.
+ *
+ * @since 2.1.0
+ *
+ * @param string $doctype The type of html document (xhtml|html).
+ */
 function language_attributes($doctype = 'html') {
        $attributes = array();
        $output = '';
@@ -1009,7 +1738,7 @@ function language_attributes($doctype = 'html') {
                $attributes[] = "dir=\"$dir\"";
 
        if ( $lang = get_bloginfo('language') ) {
-               if ( get_option('html_type') == 'text/html' || $doctype == 'xhtml' )
+               if ( get_option('html_type') == 'text/html' || $doctype == 'html' )
                        $attributes[] = "lang=\"$lang\"";
 
                if ( get_option('html_type') != 'text/html' || $doctype == 'xhtml' )
@@ -1021,6 +1750,51 @@ function language_attributes($doctype = 'html') {
        echo $output;
 }
 
+/**
+ * Retrieve paginated link for archive post pages.
+ *
+ * Technically, the function can be used to create paginated link list for any
+ * area. The 'base' argument is used to reference the url, which will be used to
+ * create the paginated links. The 'format' argument is then used for replacing
+ * the page number. It is however, most likely and by default, to be used on the
+ * archive post pages.
+ *
+ * The 'type' argument controls format of the returned value. The default is
+ * 'plain', which is just a string with the links separated by a newline
+ * character. The other possible values are either 'array' or 'list'. The
+ * 'array' value will return an array of the paginated link list to offer full
+ * control of display. The 'list' value will place all of the paginated links in
+ * an unordered HTML list.
+ *
+ * The 'total' argument is the total amount of pages and is an integer. The
+ * 'current' argument is the current page number and is also an integer.
+ *
+ * An example of the 'base' argument is "http://example.com/all_posts.php%_%"
+ * and the '%_%' is required. The '%_%' will be replaced by the contents of in
+ * the 'format' argument. An example for the 'format' argument is "?page=%#%"
+ * and the '%#%' is also required. The '%#%' will be replaced with the page
+ * number.
+ *
+ * You can include the previous and next links in the list by setting the
+ * 'prev_next' argument to true, which it is by default. You can set the
+ * previous text, by using the 'prev_text' argument. You can set the next text
+ * by setting the 'next_text' argument.
+ *
+ * If the 'show_all' argument is set to true, then it will show all of the pages
+ * instead of a short list of the pages near the current page. By default, the
+ * 'show_all' is set to false and controlled by the 'end_size' and 'mid_size'
+ * arguments. The 'end_size' argument is how many numbers on either the start
+ * and the end list edges, by default is 1. The 'mid_size' argument is how many
+ * numbers to either side of current page, but not including current page.
+ *
+ * It is possible to add query vars to the link by using the 'add_args' argument
+ * and see {@link add_query_arg()} for more information.
+ *
+ * @since 2.1.0
+ *
+ * @param string|array $args Optional. Override defaults.
+ * @return array|string String of page links or array of page links.
+ */
 function paginate_links( $args = '' ) {
        $defaults = array(
                'base' => '%_%', // http://example.com/all_posts.php%_% : %_% is replaced by format (below)
@@ -1031,17 +1805,18 @@ function paginate_links( $args = '' ) {
                'prev_next' => true,
                'prev_text' => __('&laquo; Previous'),
                'next_text' => __('Next &raquo;'),
-               'end_size' => 1, // How many numbers on either end including the end
-               'mid_size' => 2, // How many numbers to either side of current not including current
+               'end_size' => 1,
+               'mid_size' => 2,
                'type' => 'plain',
-               'add_args' => false // array of query args to aadd
+               'add_args' => false, // array of query args to add
+               'add_fragment' => ''
        );
 
        $args = wp_parse_args( $args, $defaults );
        extract($args, EXTR_SKIP);
 
        // Who knows what else people pass in $args
-       $total    = (int) $total;
+       $total = (int) $total;
        if ( $total < 2 )
                return;
        $current  = (int) $current;
@@ -1058,11 +1833,13 @@ function paginate_links( $args = '' ) {
                $link = str_replace('%#%', $current - 1, $link);
                if ( $add_args )
                        $link = add_query_arg( $add_args, $link );
-               $page_links[] = "<a class='prev page-numbers' href='" . clean_url($link) . "'>$prev_text</a>";
+               $link .= $add_fragment;
+               $page_links[] = "<a class='prev page-numbers' href='" . esc_url($link) . "'>$prev_text</a>";
        endif;
        for ( $n = 1; $n <= $total; $n++ ) :
+               $n_display = number_format_i18n($n);
                if ( $n == $current ) :
-                       $page_links[] = "<span class='page-numbers current'>$n</span>";
+                       $page_links[] = "<span class='page-numbers current'>$n_display</span>";
                        $dots = true;
                else :
                        if ( $show_all || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :
@@ -1070,7 +1847,8 @@ function paginate_links( $args = '' ) {
                                $link = str_replace('%#%', $n, $link);
                                if ( $add_args )
                                        $link = add_query_arg( $add_args, $link );
-                               $page_links[] = "<a class='page-numbers' href='" . clean_url($link) . "'>$n</a>";
+                               $link .= $add_fragment;
+                               $page_links[] = "<a class='page-numbers' href='" . esc_url($link) . "'>$n_display</a>";
                                $dots = true;
                        elseif ( $dots && !$show_all ) :
                                $page_links[] = "<span class='page-numbers dots'>...</span>";
@@ -1083,7 +1861,8 @@ function paginate_links( $args = '' ) {
                $link = str_replace('%#%', $current + 1, $link);
                if ( $add_args )
                        $link = add_query_arg( $add_args, $link );
-               $page_links[] = "<a class='next page-numbers' href='" . clean_url($link) . "'>$next_text</a>";
+               $link .= $add_fragment;
+               $page_links[] = "<a class='next page-numbers' href='" . esc_url($link) . "'>$next_text</a>";
        endif;
        switch ( $type ) :
                case 'array' :
@@ -1101,6 +1880,22 @@ function paginate_links( $args = '' ) {
        return $r;
 }
 
+/**
+ * Registers an admin colour scheme css file.
+ *
+ * Allows a plugin to register a new admin colour scheme. For example:
+ * <code>
+ * wp_admin_css_color('classic', __('Classic'), admin_url("css/colors-classic.css"),
+ * array('#07273E', '#14568A', '#D54E21', '#2683AE'));
+ * </code>
+ *
+ * @since 2.5.0
+ *
+ * @param string $key The unique key for this theme.
+ * @param string $name The name of the theme.
+ * @param string $url The url of the css file containing the colour scheme.
+ * @param array @colors An array of CSS color definitions which are used to give the user a feel for the theme.
+ */
 function wp_admin_css_color($key, $name, $url, $colors = array()) {
        global $_wp_admin_css_colors;
 
@@ -1110,63 +1905,126 @@ function wp_admin_css_color($key, $name, $url, $colors = array()) {
        $_wp_admin_css_colors[$key] = (object) array('name' => $name, 'url' => $url, 'colors' => $colors);
 }
 
+/**
+ * Display the URL of a WordPress admin CSS file.
+ *
+ * @see WP_Styles::_css_href and its style_loader_src filter.
+ *
+ * @since 2.3.0
+ *
+ * @param string $file file relative to wp-admin/ without its ".css" extension.
+ */
 function wp_admin_css_uri( $file = 'wp-admin' ) {
        if ( defined('WP_INSTALLING') ) {
                $_file = "./$file.css";
        } else {
-               if ( 'css/colors' == $file || 'css/colors-rtl' == $file ) {
-                       global $_wp_admin_css_colors;
-                       $color = get_user_option('admin_color');
-                       if ( empty($color) || !isset($_wp_admin_css_colors[$color]) )
-                               $color = 'fresh';
-                       $color = $_wp_admin_css_colors[$color];
-                       $_file = $color->url;
-                       $_file = ('css/colors-rtl' == $file) ? str_replace('.css','-rtl.css',$_file) : $_file;
-               } else {
-                       $_file = get_option( 'siteurl' ) . "/wp-admin/$file.css";
-               }
+               $_file = admin_url("$file.css");
        }
        $_file = add_query_arg( 'version', get_bloginfo( 'version' ),  $_file );
 
        return apply_filters( 'wp_admin_css_uri', $_file, $file );
 }
 
-function wp_admin_css( $file = 'wp-admin' ) {
-
-       echo apply_filters( 'wp_admin_css', "<link rel='stylesheet' href='" . wp_admin_css_uri( $file ) . "' type='text/css' />\n", $file );
-       if ( 'rtl' == get_bloginfo( 'text_direction' ) ) {
-               $rtl = ( 'wp-admin' == $file ) ? 'rtl' : "$file-rtl";
-               echo apply_filters( 'wp_admin_css', "<link rel='stylesheet' href='" . wp_admin_css_uri( $rtl ) . "' type='text/css' />\n", $rtl );
+/**
+ * Enqueues or directly prints a stylesheet link to the specified CSS file.
+ *
+ * "Intelligently" decides to enqueue or to print the CSS file. If the
+ * 'wp_print_styles' action has *not* yet been called, the CSS file will be
+ * enqueued. If the wp_print_styles action *has* been called, the CSS link will
+ * be printed. Printing may be forced by passing TRUE as the $force_echo
+ * (second) parameter.
+ *
+ * For backward compatibility with WordPress 2.3 calling method: If the $file
+ * (first) parameter does not correspond to a registered CSS file, we assume
+ * $file is a file relative to wp-admin/ without its ".css" extension. A
+ * stylesheet link to that generated URL is printed.
+ *
+ * @package WordPress
+ * @since 2.3.0
+ * @uses $wp_styles WordPress Styles Object
+ *
+ * @param string $file Style handle name or file name (without ".css" extension) relative to wp-admin/
+ * @param bool $force_echo Optional.  Force the stylesheet link to be printed rather than enqueued.
+ */
+function wp_admin_css( $file = 'wp-admin', $force_echo = false ) {
+       global $wp_styles;
+       if ( !is_a($wp_styles, 'WP_Styles') )
+               $wp_styles = new WP_Styles();
+
+       // For backward compatibility
+       $handle = 0 === strpos( $file, 'css/' ) ? substr( $file, 4 ) : $file;
+
+       if ( $wp_styles->query( $handle ) ) {
+               if ( $force_echo || did_action( 'wp_print_styles' ) ) // we already printed the style queue.  Print this one immediately
+                       wp_print_styles( $handle );
+               else // Add to style queue
+                       wp_enqueue_style( $handle );
+               return;
        }
+
+       echo apply_filters( 'wp_admin_css', "<link rel='stylesheet' href='" . esc_url( wp_admin_css_uri( $file ) ) . "' type='text/css' />\n", $file );
+       if ( 'rtl' == get_bloginfo( 'text_direction' ) )
+               echo apply_filters( 'wp_admin_css', "<link rel='stylesheet' href='" . esc_url( wp_admin_css_uri( "$file-rtl" ) ) . "' type='text/css' />\n", "$file-rtl" );
 }
 
 /**
- * Outputs the XHTML generator that is generated on the wp_head hook.
+ * Enqueues the default ThickBox js and css.
+ *
+ * If any of the settings need to be changed, this can be done with another js
+ * file similar to media-upload.js and theme-preview.js. That file should
+ * require array('thickbox') to ensure it is loaded after.
+ *
+ * @since 2.5.0
  */
-function wp_generator()
-{
+function add_thickbox() {
+       wp_enqueue_script( 'thickbox' );
+       wp_enqueue_style( 'thickbox' );
+}
+
+/**
+ * Display the XHTML generator that is generated on the wp_head hook.
+ *
+ * @since 2.5.0
+ */
+function wp_generator() {
        the_generator( apply_filters( 'wp_generator_type', 'xhtml' ) );
 }
 
 /**
- * Outputs the generator XML or Comment for RSS, ATOM, etc.
- * @param {String} $type The type of generator to return.
+ * Display the generator XML or Comment for RSS, ATOM, etc.
+ *
+ * Returns the correct generator type for the requested output format. Allows
+ * for a plugin to filter generators overall the the_generator filter.
+ *
+ * @since 2.5.0
+ * @uses apply_filters() Calls 'the_generator' hook.
+ *
+ * @param string $type The type of generator to output - (html|xhtml|atom|rss2|rdf|comment|export).
  */
-function the_generator ( $type ) {
-       echo apply_filters('the_generator',get_the_generator($type),$type) . "\n";
+function the_generator( $type ) {
+       echo apply_filters('the_generator', get_the_generator($type), $type) . "\n";
 }
 
 /**
  * Creates the generator XML or Comment for RSS, ATOM, etc.
- * @param {String} $type The type of generator to return.
+ *
+ * Returns the correct generator type for the requested output format. Allows
+ * for a plugin to filter generators on an individual basis using the
+ * 'get_the_generator_{$type}' filter.
+ *
+ * @since 2.5.0
+ * @uses apply_filters() Calls 'get_the_generator_$type' hook.
+ *
+ * @param string $type The type of generator to return - (html|xhtml|atom|rss2|rdf|comment|export).
+ * @return string The HTML content for the generator.
  */
-function get_the_generator ( $type ) {
+function get_the_generator( $type ) {
        switch ($type) {
                case 'html':
-                       $gen = '<meta name="generator" content="WordPress ' . get_bloginfo( 'version' ) . '">' . "\n";
+                       $gen = '<meta name="generator" content="WordPress ' . get_bloginfo( 'version' ) . '">';
                        break;
                case 'xhtml':
-                       $gen = '<meta name="generator" content="WordPress ' . get_bloginfo( 'version' ) . '" />' . "\n";
+                       $gen = '<meta name="generator" content="WordPress ' . get_bloginfo( 'version' ) . '" />';
                        break;
                case 'atom':
                        $gen = '<generator uri="http://wordpress.org/" version="' . get_bloginfo_rss( 'version' ) . '">WordPress</generator>';
@@ -1186,4 +2044,5 @@ function get_the_generator ( $type ) {
        }
        return apply_filters( "get_the_generator_{$type}", $gen, $type );
 }
+
 ?>