Wordpress 3.3.1-scripts
[autoinstalls/wordpress.git] / wp-includes / general-template.php
index 19194f2f1c131d254560d42fe575a5adcb682277..d855ef52b9f55e90864197a0f31eac8127ff9bb8 100644 (file)
@@ -28,7 +28,7 @@ function get_header( $name = null ) {
        if ( isset($name) )
                $templates[] = "header-{$name}.php";
 
-       $templates[] = "header.php";
+       $templates[] = 'header.php';
 
        // Backward compat code will be removed in a future release
        if ('' == locate_template($templates, true))
@@ -57,7 +57,7 @@ function get_footer( $name = null ) {
        if ( isset($name) )
                $templates[] = "footer-{$name}.php";
 
-       $templates[] = "footer.php";
+       $templates[] = 'footer.php';
 
        // Backward compat code will be removed in a future release
        if ('' == locate_template($templates, true))
@@ -86,7 +86,7 @@ function get_sidebar( $name = null ) {
        if ( isset($name) )
                $templates[] = "sidebar-{$name}.php";
 
-       $templates[] = "sidebar.php";
+       $templates[] = 'sidebar.php';
 
        // Backward compat code will be removed in a future release
        if ('' == locate_template($templates, true))
@@ -106,12 +106,12 @@ function get_sidebar( $name = null ) {
  * The template is included using require, not require_once, so you may include the
  * same template part multiple times.
  *
- * For the parameter, if the file is called "{slug}-special.php" then specify
+ * For the $name parameter, if the file is called "{slug}-special.php" then specify
  * "special".
  *
  * @uses locate_template()
  * @since 3.0.0
- * @uses do_action() Calls 'get_template_part{$slug}' action.
+ * @uses do_action() Calls 'get_template_part_{$slug}' action.
  *
  * @param string $slug The slug name for the generic template.
  * @param string $name The name of the specialised template.
@@ -157,7 +157,7 @@ function get_search_form($echo = true) {
                return;
        }
 
-       $form = '<form role="search" method="get" id="searchform" action="' . home_url( '/' ) . '" >
+       $form = '<form role="search" method="get" id="searchform" action="' . esc_url( home_url( '/' ) ) . '" >
        <div><label class="screen-reader-text" for="s">' . __('Search for:') . '</label>
        <input type="text" value="' . get_search_query() . '" name="s" id="s" />
        <input type="submit" id="searchsubmit" value="'. esc_attr__('Search') .'" />
@@ -253,7 +253,7 @@ function wp_login_url($redirect = '', $force_reauth = false) {
  */
 function wp_login_form( $args = array() ) {
        $defaults = array( 'echo' => true,
-                                               'redirect' => site_url( $_SERVER['REQUEST_URI'] ), // Default redirect is back to the current page
+                                               'redirect' => ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], // Default redirect is back to the current page
                                                'form_id' => 'loginform',
                                                'label_username' => __( 'Username' ),
                                                'label_password' => __( 'Password' ),
@@ -270,7 +270,7 @@ function wp_login_form( $args = array() ) {
        $args = wp_parse_args( $args, apply_filters( 'login_form_defaults', $defaults ) );
 
        $form = '
-               <form name="' . $args['form_id'] . '" id="' . $args['form_id'] . '" action="' . site_url( 'wp-login.php', 'login' ) . '" method="post">
+               <form name="' . $args['form_id'] . '" id="' . $args['form_id'] . '" action="' . esc_url( site_url( 'wp-login.php', 'login_post' ) ) . '" method="post">
                        ' . apply_filters( 'login_form_top', '', $args ) . '
                        <p class="login-username">
                                <label for="' . esc_attr( $args['id_username'] ) . '">' . esc_html( $args['label_username'] ) . '</label>
@@ -284,7 +284,7 @@ function wp_login_form( $args = array() ) {
                        ' . ( $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>' : '' ) . '
                        <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="hidden" name="redirect_to" value="' . esc_attr( $args['redirect'] ) . '" />
+                               <input type="hidden" name="redirect_to" value="' . esc_url( $args['redirect'] ) . '" />
                        </p>
                        ' . apply_filters( 'login_form_bottom', '', $args ) . '
                </form>';
@@ -306,14 +306,14 @@ function wp_login_form( $args = array() ) {
  *
  * @param string $redirect Path to redirect to on login.
  */
-function wp_lostpassword_url($redirect = '') {
+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);
+       $lostpassword_url = add_query_arg( $args, network_site_url('wp-login.php', 'login') );
+       return apply_filters( 'lostpassword_url', $lostpassword_url, $redirect );
 }
 
 /**
@@ -569,7 +569,7 @@ 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 ? $t_sep . $my_month : "") . ($my_day ? $t_sep . $my_day : "");
+               $title = $my_year . ( $my_month ? $t_sep . $my_month : '' ) . ( $my_day ? $t_sep . $my_day : '' );
        }
 
        // If there's a year
@@ -843,7 +843,7 @@ function get_archives_link($url, $text, $format = 'html', $before = '', $after =
        else // custom
                $link_html = "\t$before<a href='$url' title='$title_text'>$text</a>$after\n";
 
-       $link_html = apply_filters( "get_archives_link", $link_html );
+       $link_html = apply_filters( 'get_archives_link', $link_html );
 
        return $link_html;
 }
@@ -915,8 +915,8 @@ function wp_get_archives($args = '') {
        }
 
        //filters
-       $where = apply_filters('getarchives_where', "WHERE post_type = 'post' AND post_status = 'publish'", $r );
-       $join = apply_filters('getarchives_join', "", $r);
+       $where = apply_filters( 'getarchives_where', "WHERE post_type = 'post' AND post_status = 'publish'", $r );
+       $join = apply_filters( 'getarchives_join', '', $r );
 
        $output = '';
 
@@ -1016,7 +1016,7 @@ function wp_get_archives($args = '') {
                                }
                }
        } elseif ( ( 'postbypost' == $type ) || ('alpha' == $type) ) {
-               $orderby = ('alpha' == $type) ? "post_title ASC " : "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');
@@ -1030,10 +1030,9 @@ function wp_get_archives($args = '') {
                if ( $arcresults ) {
                        foreach ( (array) $arcresults as $arcresult ) {
                                if ( $arcresult->post_date != '0000-00-00 00:00:00' ) {
-                                       $url  = get_permalink($arcresult);
-                                       $arc_title = $arcresult->post_title;
-                                       if ( $arc_title )
-                                               $text = strip_tags(apply_filters('the_title', $arc_title));
+                                       $url  = get_permalink( $arcresult );
+                                       if ( $arcresult->post_title )
+                                               $text = strip_tags( apply_filters( 'the_title', $arcresult->post_title, $arcresult->ID ) );
                                        else
                                                $text = $arcresult->ID;
                                        $output .= get_archives_link($url, $text, $format, $before, $after);
@@ -1146,7 +1145,7 @@ function get_calendar($initial = true, $echo = true) {
 
        /* translators: Calendar caption: 1: month name, 2: 4-digit year */
        $calendar_caption = _x('%1$s %2$s', 'calendar caption');
-       $calendar_output = '<table id="wp-calendar" summary="' . esc_attr__('Calendar') . '">
+       $calendar_output = '<table id="wp-calendar">
        <caption>' . sprintf($calendar_caption, $wp_locale->get_month($thismonth), date('Y', $unixmonth)) . '</caption>
        <thead>
        <tr>';
@@ -1248,7 +1247,7 @@ function get_calendar($initial = true, $echo = true) {
                        $calendar_output .= '<td>';
 
                if ( in_array($day, $daywithpost) ) // any posts today?
-                               $calendar_output .= '<a href="' . get_day_link($thisyear, $thismonth, $day) . "\" title=\"" . esc_attr($ak_titles_for_day[$day]) . "\">$day</a>";
+                               $calendar_output .= '<a href="' . get_day_link( $thisyear, $thismonth, $day ) . '" title="' . esc_attr( $ak_titles_for_day[ $day ] ) . "\">$day</a>";
                else
                        $calendar_output .= $day;
                $calendar_output .= '</td>';
@@ -1640,34 +1639,35 @@ function feed_links_extra( $args = array() ) {
        $args = wp_parse_args( $args, $defaults );
 
        if ( is_single() || is_page() ) {
-               $post = &get_post( $id = 0 );
+               $id = 0;
+               $post = &get_post( $id );
 
                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() ) ));
+                       $title = sprintf( $args['singletitle'], get_bloginfo('name'), $args['separator'], esc_html( get_the_title() ) );
                        $href = get_post_comments_feed_link( $post->ID );
                }
        } elseif ( is_category() ) {
                $term = get_queried_object();
 
-               $title = esc_attr(sprintf( $args['cattitle'], get_bloginfo('name'), $args['separator'], $term->name ));
+               $title = sprintf( $args['cattitle'], get_bloginfo('name'), $args['separator'], $term->name );
                $href = get_category_feed_link( $term->term_id );
        } elseif ( is_tag() ) {
                $term = get_queried_object();
 
-               $title = esc_attr(sprintf( $args['tagtitle'], get_bloginfo('name'), $args['separator'], $term->name ));
+               $title = sprintf( $args['tagtitle'], get_bloginfo('name'), $args['separator'], $term->name );
                $href = get_tag_feed_link( $term->term_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 ) ));
+               $title = 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( false ) ));
+               $title = sprintf( $args['searchtitle'], get_bloginfo('name'), $args['separator'], get_search_query( false ) );
                $href = get_search_feed_link();
        }
 
        if ( isset($title) && isset($href) )
-               echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . $title . '" href="' . $href . '" />' . "\n";
+               echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . esc_attr( $title ) . '" href="' . esc_url( $href ) . '" />' . "\n";
 }
 
 /**
@@ -1695,14 +1695,29 @@ function wlwmanifest_link() {
  * 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.
+ * output to tell web robots not to index the page content. Add this to the wp_head action.
+ * Typical usage is as a wp_head callback. add_action( 'wp_head', 'noindex' );
+ *
+ * @see wp_no_robots
  *
  * @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";
+               wp_no_robots();
+}
+
+/**
+ * Display a noindex meta tag.
+ *
+ * Outputs a noindex meta tag that tells web robots not to index the page content.
+ * Typical usage is as a wp_head callback. add_action( 'wp_head', 'wp_no_robots' );
+ *
+ * @since 3.3.0
+ */
+function wp_no_robots() {
+       echo "<meta name='robots' content='noindex,nofollow' />\n";
 }
 
 /**
@@ -1732,17 +1747,18 @@ function rich_edit_exists() {
  * @return bool
  */
 function user_can_richedit() {
-       global $wp_rich_edit, $pagenow, $is_iphone;
-
-       if ( !isset( $wp_rich_edit) ) {
-               if ( get_user_option( 'rich_editing' ) == 'true' &&
-                       !$is_iphone && // this includes all Safari mobile browsers
-                       ( ( preg_match( '!AppleWebKit/(\d+)!', $_SERVER['HTTP_USER_AGENT'], $match ) && intval($match[1]) >= 420 ) ||
-                               !preg_match( '!opera[ /][2-8]|konqueror|safari!i', $_SERVER['HTTP_USER_AGENT'] ) )
-                               && 'comment.php' != $pagenow ) {
-                       $wp_rich_edit = true;
-               } else {
-                       $wp_rich_edit = false;
+       global $wp_rich_edit, $is_gecko, $is_opera, $is_safari, $is_chrome, $is_iphone, $is_IE;
+
+       if ( !isset($wp_rich_edit) ) {
+               $wp_rich_edit = false;
+
+               if ( get_user_option( 'rich_editing' ) == 'true' || !is_user_logged_in() ) { // default to 'true' for logged out users
+                       if ( $is_safari ) {
+                               if ( !$is_iphone || ( preg_match( '!AppleWebKit/(\d+)!', $_SERVER['HTTP_USER_AGENT'], $match ) && intval($match[1]) >= 534 ) )
+                                       $wp_rich_edit = true;
+                       } elseif ( $is_gecko || $is_opera || $is_chrome || $is_IE ) {
+                               $wp_rich_edit = true;
+                       }
                }
        }
 
@@ -1769,78 +1785,29 @@ function wp_default_editor() {
 }
 
 /**
- * Display visual editor forms: TinyMCE, or HTML, or both.
+ * Renders an editor.
  *
- * 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'.
+ * Using this function is the proper way to output all needed components for both TinyMCE and Quicktags.
+ * _WP_Editors should not be used directly. See http://core.trac.wordpress.org/ticket/17144.
  *
- * If the user can not use the rich editor (TinyMCE), then the switch button
- * will not be displayed.
+ * NOTE: Once initialized the TinyMCE editor cannot be safely moved in the DOM. For that reason
+ * running wp_editor() inside of a metabox is not a good idea unless only Quicktags is used.
+ * On the post edit screen several actions can be used to include additional editors
+ * containing TinyMCE: 'edit_page_form', 'edit_form_advanced' and 'dbx_post_sidebar'.
+ * See http://core.trac.wordpress.org/ticket/19173 for more information.
  *
- * @since 2.1.0
+ * @see wp-includes/class-wp-editor.php
+ * @since 3.3
  *
- * @param string $content Textarea content.
- * @param string $id Optional, default is 'content'. HTML ID attribute value.
- * @param string $prev_id Optional, default is 'title'. 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.
+ * @param string $content Initial content for the editor.
+ * @param string $editor_id HTML ID attribute value for the textarea and TinyMCE. Can only be /[a-z]+/.
+ * @param array $settings See _WP_Editors::editor().
  */
-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;
+function wp_editor( $content, $editor_id, $settings = array() ) {
+       if ( ! class_exists( '_WP_Editors' ) )
+               require( ABSPATH . WPINC . '/class-wp-editor.php' );
 
-       if ( !current_user_can( 'upload_files' ) )
-               $media_buttons = false;
-
-       $richedit =  user_can_richedit();
-       $class = '';
-
-       if ( $richedit || $media_buttons ) { ?>
-       <div id="editor-toolbar">
-<?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 ( 'html' == $wp_default_editor ) {
-                       add_filter('the_editor_content', 'wp_htmledit_pre'); ?>
-                       <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' ); ?>
-               </div>
-<?php
-       } ?>
-       </div>
-<?php
-       }
-?>
-       <div id="quicktags"><?php
-       wp_print_scripts( 'quicktags' ); ?>
-       <script type="text/javascript">edToolbar()</script>
-       </div>
-
-<?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">
-       edCanvas = document.getElementById('<?php echo $id; ?>');
-       </script>
-<?php
+       _WP_Editors::editor($content, $editor_id, $settings);
 }
 
 /**
@@ -1990,7 +1957,7 @@ function paginate_links( $args = '' ) {
                if ( $add_args )
                        $link = add_query_arg( $add_args, $link );
                $link .= $add_fragment;
-               $page_links[] = "<a class='prev page-numbers' href='" . esc_url( apply_filters( 'paginate_links', $link ) ) . "'>$prev_text</a>";
+               $page_links[] = '<a class="prev page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $prev_text . '</a>';
        endif;
        for ( $n = 1; $n <= $total; $n++ ) :
                $n_display = number_format_i18n($n);
@@ -2007,7 +1974,7 @@ function paginate_links( $args = '' ) {
                                $page_links[] = "<a class='page-numbers' href='" . esc_url( apply_filters( 'paginate_links', $link ) ) . "'>$n_display</a>";
                                $dots = true;
                        elseif ( $dots && !$show_all ) :
-                               $page_links[] = "<span class='page-numbers dots'>...</span>";
+                               $page_links[] = '<span class="page-numbers dots">' . __( '&hellip;' ) . '</span>';
                                $dots = false;
                        endif;
                endif;
@@ -2018,7 +1985,7 @@ function paginate_links( $args = '' ) {
                if ( $add_args )
                        $link = add_query_arg( $add_args, $link );
                $link .= $add_fragment;
-               $page_links[] = "<a class='next page-numbers' href='" . esc_url( apply_filters( 'paginate_links', $link ) ) . "'>$next_text</a>";
+               $page_links[] = '<a class="next page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $next_text . '</a>';
        endif;
        switch ( $type ) :
                case 'array' :
@@ -2067,9 +2034,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', __( 'Blue' ), admin_url( 'css/colors-classic.css' ),
+       wp_admin_css_color( 'classic', _x( 'Blue', 'admin color scheme' ), admin_url( 'css/colors-classic.css' ),
                array( '#5589aa', '#cfdfe9', '#d1e5ee', '#eff8ff' ) );
-       wp_admin_css_color( 'fresh', __( 'Gray' ), admin_url( 'css/colors-fresh.css' ),
+       wp_admin_css_color( 'fresh', _x( 'Gray', 'admin color scheme' ), admin_url( 'css/colors-fresh.css' ),
                array( '#7c7976', '#c6c6c6', '#e0e0e0', '#f1f1f1' ) );
 }