Wordpress 3.5
[autoinstalls/wordpress.git] / wp-includes / general-template.php
index 19726961e7b6f6a7cdfb1e02f20e7fc4a38ebcc1..af3d572e5916d9867a6b52b16fd04634145caa11 100644 (file)
@@ -147,6 +147,7 @@ function get_template_part( $slug, $name = null ) {
  *
  * @since 2.7.0
  * @param boolean $echo Default to echo and not return the form.
+ * @return string|null String when retrieving, null when displaying or if searchform.php exists.
  */
 function get_search_form($echo = true) {
        do_action( 'get_search_form' );
@@ -181,6 +182,7 @@ function get_search_form($echo = true) {
  *
  * @param string $redirect Optional path to redirect to on login/logout.
  * @param boolean $echo Default to echo and not return the link.
+ * @return string|null String when retrieving, null when displaying.
  */
 function wp_loginout($redirect = '', $echo = true) {
        if ( ! is_user_logged_in() )
@@ -205,6 +207,7 @@ function wp_loginout($redirect = '', $echo = true) {
  * @uses apply_filters() calls 'logout_url' hook on final logout url
  *
  * @param string $redirect Path to redirect to on logout.
+ * @return string A log out URL.
  */
 function wp_logout_url($redirect = '') {
        $args = array( 'action' => 'logout' );
@@ -229,7 +232,7 @@ function wp_logout_url($redirect = '') {
  *
  * @param string $redirect Path to redirect to on login.
  * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false.
- * @return string A log in url
+ * @return string A log in URL.
  */
 function wp_login_url($redirect = '', $force_reauth = false) {
        $login_url = site_url('wp-login.php', 'login');
@@ -248,8 +251,8 @@ function wp_login_url($redirect = '', $force_reauth = false) {
  * the HTML immediately. Pass array('echo'=>false) to return the string instead.
  *
  * @since 3.0.0
- * @param array $args Configuration options to modify the form output
- * @return Void, or string containing the form
+ * @param array $args Configuration options to modify the form output.
+ * @return string|null String when retrieving, null when displaying.
  */
 function wp_login_form( $args = array() ) {
        $defaults = array( 'echo' => true,
@@ -274,16 +277,16 @@ function wp_login_form( $args = array() ) {
                        ' . apply_filters( 'login_form_top', '', $args ) . '
                        <p class="login-username">
                                <label for="' . esc_attr( $args['id_username'] ) . '">' . esc_html( $args['label_username'] ) . '</label>
-                               <input type="text" name="log" id="' . esc_attr( $args['id_username'] ) . '" class="input" value="' . esc_attr( $args['value_username'] ) . '" size="20" tabindex="10" />
+                               <input type="text" name="log" id="' . esc_attr( $args['id_username'] ) . '" class="input" value="' . esc_attr( $args['value_username'] ) . '" size="20" />
                        </p>
                        <p class="login-password">
                                <label for="' . esc_attr( $args['id_password'] ) . '">' . esc_html( $args['label_password'] ) . '</label>
-                               <input type="password" name="pwd" id="' . esc_attr( $args['id_password'] ) . '" class="input" value="" size="20" tabindex="20" />
+                               <input type="password" name="pwd" id="' . esc_attr( $args['id_password'] ) . '" class="input" value="" size="20" />
                        </p>
                        ' . apply_filters( 'login_form_middle', '', $args ) . '
-                       ' . ( $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>' : '' ) . '
+                       ' . ( $args['remember'] ? '<p class="login-remember"><label><input name="rememberme" type="checkbox" id="' . esc_attr( $args['id_remember'] ) . '" value="forever"' . ( $args['value_remember'] ? ' checked="checked"' : '' ) . ' /> ' . esc_html( $args['label_remember'] ) . '</label></p>' : '' ) . '
                        <p class="login-submit">
-                               <input type="submit" name="wp-submit" id="' . esc_attr( $args['id_submit'] ) . '" class="button-primary" value="' . esc_attr( $args['label_log_in'] ) . '" tabindex="100" />
+                               <input type="submit" name="wp-submit" id="' . esc_attr( $args['id_submit'] ) . '" class="button-primary" value="' . esc_attr( $args['label_log_in'] ) . '" />
                                <input type="hidden" name="redirect_to" value="' . esc_url( $args['redirect'] ) . '" />
                        </p>
                        ' . apply_filters( 'login_form_bottom', '', $args ) . '
@@ -305,6 +308,7 @@ function wp_login_form( $args = array() ) {
  * @uses apply_filters() calls 'lostpassword_url' hook on the lostpassword url
  *
  * @param string $redirect Path to redirect to on login.
+ * @return string Lost password URL.
  */
 function wp_lostpassword_url( $redirect = '' ) {
        $args = array( 'action' => 'lostpassword' );
@@ -328,6 +332,7 @@ function wp_lostpassword_url( $redirect = '' ) {
  * @param string $before Text to output before the link (defaults to <li>).
  * @param string $after Text to output after the link (defaults to </li>).
  * @param boolean $echo Default to echo and not return the link.
+ * @return string|null String when retrieving, null when displaying.
  */
 function wp_register( $before = '<li>', $after = '</li>', $echo = true ) {
 
@@ -491,18 +496,6 @@ function get_bloginfo( $show = '', $filter = 'raw' ) {
        return $output;
 }
 
-/**
- * Retrieve the current blog id
- *
- * @since 3.1.0
- *
- * @return int Blog id
- */
-function get_current_blog_id() {
-       global $blog_id;
-       return absint($blog_id);
-}
-
 /**
  * Display or retrieve page title for all areas of blog.
  *
@@ -873,6 +866,7 @@ function get_archives_link($url, $text, $format = 'html', $before = '', $after =
  * @since 1.2.0
  *
  * @param string|array $args Optional. Override defaults.
+ * @return string|null String when retrieving, null when displaying.
  */
 function wp_get_archives($args = '') {
        global $wpdb, $wp_locale;
@@ -881,7 +875,7 @@ function wp_get_archives($args = '') {
                'type' => 'monthly', 'limit' => '',
                'format' => 'html', 'before' => '',
                'after' => '', 'show_post_count' => false,
-               'echo' => 1
+               'echo' => 1, 'order' => 'DESC',
        );
 
        $r = wp_parse_args( $args, $defaults );
@@ -895,6 +889,10 @@ function wp_get_archives($args = '') {
                $limit = ' LIMIT '.$limit;
        }
 
+       $order = strtoupper( $order );
+       if ( $order !== 'ASC' )
+               $order = 'DESC';
+
        // this is what will separate dates on weekly archive links
        $archive_week_separator = '&#8211;';
 
@@ -921,7 +919,7 @@ function wp_get_archives($args = '') {
        $output = '';
 
        if ( 'monthly' == $type ) {
-               $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";
+               $query = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date) ORDER BY post_date $order $limit";
                $key = md5($query);
                $cache = wp_cache_get( 'wp_get_archives' , 'general');
                if ( !isset( $cache[ $key ] ) ) {
@@ -943,7 +941,7 @@ function wp_get_archives($args = '') {
                        }
                }
        } elseif ('yearly' == $type) {
-               $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";
+               $query = "SELECT YEAR(post_date) AS `year`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date) ORDER BY post_date $order $limit";
                $key = md5($query);
                $cache = wp_cache_get( 'wp_get_archives' , 'general');
                if ( !isset( $cache[ $key ] ) ) {
@@ -964,7 +962,7 @@ function wp_get_archives($args = '') {
                        }
                }
        } elseif ( 'daily' == $type ) {
-               $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";
+               $query = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, DAYOFMONTH(post_date) AS `dayofmonth`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date), DAYOFMONTH(post_date) ORDER BY post_date $order $limit";
                $key = md5($query);
                $cache = wp_cache_get( 'wp_get_archives' , 'general');
                if ( !isset( $cache[ $key ] ) ) {
@@ -987,7 +985,7 @@ function wp_get_archives($args = '') {
                }
        } elseif ( 'weekly' == $type ) {
                $week = _wp_mysql_week( '`post_date`' );
-               $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";
+               $query = "SELECT DISTINCT $week AS `week`, YEAR( `post_date` ) AS `yr`, DATE_FORMAT( `post_date`, '%Y-%m-%d' ) AS `yyyymmdd`, count( `ID` ) AS `posts` FROM `$wpdb->posts` $join $where GROUP BY $week, YEAR( `post_date` ) ORDER BY `post_date` $order $limit";
                $key = md5($query);
                $cache = wp_cache_get( 'wp_get_archives' , 'general');
                if ( !isset( $cache[ $key ] ) ) {
@@ -1050,7 +1048,6 @@ function wp_get_archives($args = '') {
  * 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.
@@ -1067,9 +1064,11 @@ function calendar_week_mod($num) {
  * no posts for the month, then it will not be displayed.
  *
  * @since 1.0.0
+ * @uses calendar_week_mod()
  *
  * @param bool $initial Optional, default is true. Use initial calendar names.
  * @param bool $echo Optional, default is true. Set to false for return.
+ * @return string|null String when retrieving, null when displaying.
  */
 function get_calendar($initial = true, $echo = true) {
        global $wpdb, $m, $monthnum, $year, $wp_locale, $posts;
@@ -1319,8 +1318,7 @@ function allowed_tags() {
  * @since 1.0.0
  */
 function the_date_xml() {
-       global $post;
-       echo mysql2date('Y-m-d', $post->post_date, false);
+       echo mysql2date( 'Y-m-d', get_post()->post_date, false );
 }
 
 /**
@@ -1375,7 +1373,7 @@ function the_date( $d = '', $before = '', $after = '', $echo = true ) {
  * @return string|null Null if displaying, string if retrieving.
  */
 function get_the_date( $d = '' ) {
-       global $post;
+       $post = get_post();
        $the_date = '';
 
        if ( '' == $d )
@@ -1536,8 +1534,8 @@ function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translat
  * @uses $post
  */
 function the_weekday() {
-       global $wp_locale, $post;
-       $the_weekday = $wp_locale->get_weekday(mysql2date('w', $post->post_date, false));
+       global $wp_locale;
+       $the_weekday = $wp_locale->get_weekday( mysql2date( 'w', get_post()->post_date, false ) );
        $the_weekday = apply_filters('the_weekday', $the_weekday);
        echo $the_weekday;
 }
@@ -1554,11 +1552,11 @@ function the_weekday() {
  * @param string $after Optional Output after the date.
  */
 function the_weekday_date($before='',$after='') {
-       global $wp_locale, $post, $day, $previousweekday;
+       global $wp_locale, $day, $previousweekday;
        $the_weekday_date = '';
        if ( $currentday != $previousweekday ) {
                $the_weekday_date .= $before;
-               $the_weekday_date .= $wp_locale->get_weekday(mysql2date('w', $post->post_date, false));
+               $the_weekday_date .= $wp_locale->get_weekday( mysql2date( 'w', get_post()->post_date, false ) );
                $the_weekday_date .= $after;
                $previousweekday = $currentday;
        }
@@ -1633,13 +1631,15 @@ function feed_links_extra( $args = array() ) {
                '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'),
+               /* translators: 1: blog name, 2: separator(raquo), 3: post type name */
+               'posttypetitle' => __('%1$s %2$s %3$s Feed'),
        );
 
        $args = wp_parse_args( $args, $defaults );
 
        if ( is_single() || is_page() ) {
                $id = 0;
-               $post = &get_post( $id );
+               $post = get_post( $id );
 
                if ( comments_open() || pings_open() || $post->comment_count > 0 ) {
                        $title = sprintf( $args['singletitle'], get_bloginfo('name'), $args['separator'], esc_html( get_the_title() ) );
@@ -1663,6 +1663,9 @@ function feed_links_extra( $args = array() ) {
        } elseif ( is_search() ) {
                $title = sprintf( $args['searchtitle'], get_bloginfo('name'), $args['separator'], get_search_query( false ) );
                $href = get_search_feed_link();
+       } elseif ( is_post_type_archive() ) {
+               $title = sprintf( $args['posttypetitle'], get_bloginfo('name'), $args['separator'], post_type_archive_title( '', false ) );
+               $href = get_post_type_archive_feed_link( get_queried_object()->name );
        }
 
        if ( isset($title) && isset($href) )
@@ -1754,7 +1757,7 @@ function user_can_richedit() {
                if ( get_user_option( 'rich_editing' ) == 'true' || ! is_user_logged_in() ) { // default to 'true' for logged out users
                        if ( $is_safari ) {
                                $wp_rich_edit = ! wp_is_mobile() || ( preg_match( '!AppleWebKit/(\d+)!', $_SERVER['HTTP_USER_AGENT'], $match ) && intval( $match[1] ) >= 534 );
-                       } elseif ( $is_gecko || $is_opera || $is_chrome || $is_IE ) {
+                       } elseif ( $is_gecko || $is_chrome || $is_IE || ( $is_opera && !wp_is_mobile() ) ) {
                                $wp_rich_edit = true;
                        }
                }
@@ -1767,7 +1770,7 @@ function user_can_richedit() {
  * 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.
+ * user. The 'html' setting is for the "Text" editor tab.
  *
  * @since 2.5.0
  *
@@ -1855,8 +1858,8 @@ function language_attributes($doctype = 'html') {
        $attributes = array();
        $output = '';
 
-       if ( function_exists( 'is_rtl' ) )
-               $attributes[] = 'dir="' . ( is_rtl() ? 'rtl' : 'ltr' ) . '"';
+       if ( function_exists( 'is_rtl' ) && is_rtl() )
+               $attributes[] = 'dir="rtl"';
 
        if ( $lang = get_bloginfo('language') ) {
                if ( get_option('html_type') == 'text/html' || $doctype == 'html' )
@@ -2032,9 +2035,9 @@ function wp_admin_css_color($key, $name, $url, $colors = array()) {
  * @since 3.0.0
  */
 function register_admin_color_schemes() {
-       wp_admin_css_color( 'classic', _x( 'Blue', 'admin color scheme' ), admin_url( 'css/colors-classic.css' ),
+       wp_admin_css_color( 'classic', _x( 'Blue', 'admin color scheme' ), admin_url( 'css/colors-classic.min.css' ),
                array( '#5589aa', '#cfdfe9', '#d1e5ee', '#eff8ff' ) );
-       wp_admin_css_color( 'fresh', _x( 'Gray', 'admin color scheme' ), admin_url( 'css/colors-fresh.css' ),
+       wp_admin_css_color( 'fresh', _x( 'Gray', 'admin color scheme' ), admin_url( 'css/colors-fresh.min.css' ),
                array( '#555', '#a0a0a0', '#ccc', '#f1f1f1' ) );
 }
 
@@ -2264,8 +2267,8 @@ function disabled( $disabled, $current = true, $echo = true ) {
  * @since 2.8.0
  * @access private
  *
- * @param any $helper One of the values to compare
- * @param any $current (true) The other value to compare if not just true
+ * @param mixed $helper One of the values to compare
+ * @param mixed $current (true) The other value to compare if not just true
  * @param bool $echo Whether to echo or just return the string
  * @param string $type The type of checked|selected|disabled we are doing
  * @return string html attribute or empty string