WordPress 3.4
[autoinstalls/wordpress.git] / wp-admin / includes / template.php
index 3d0c1162cd5e63b2dcc557258ca0cd0a2c4ba541..383487458a9bd63b0f10fe323967f87fb50546fd 100644 (file)
@@ -8,31 +8,33 @@
  * @subpackage Administration
  */
 
-
 //
 // Category Checklists
 //
 
 /**
- * {@internal Missing Short Description}}
+ * Walker to output an unordered list of category checkbox <input> elements.
  *
+ * @see Walker
+ * @see wp_category_checklist()
+ * @see wp_terms_checklist()
  * @since 2.5.1
  */
 class Walker_Category_Checklist extends Walker {
        var $tree_type = 'category';
        var $db_fields = array ('parent' => 'parent', 'id' => 'term_id'); //TODO: decouple this
 
-       function start_lvl(&$output, $depth, $args) {
+       function start_lvl( &$output, $depth = 0, $args = array() ) {
                $indent = str_repeat("\t", $depth);
                $output .= "$indent<ul class='children'>\n";
        }
 
-       function end_lvl(&$output, $depth, $args) {
+       function end_lvl( &$output, $depth = 0, $args = array() ) {
                $indent = str_repeat("\t", $depth);
                $output .= "$indent</ul>\n";
        }
 
-       function start_el(&$output, $category, $depth, $args) {
+       function start_el( &$output, $category, $depth, $args, $id = 0 ) {
                extract($args);
                if ( empty($taxonomy) )
                        $taxonomy = 'category';
@@ -46,35 +48,39 @@ class Walker_Category_Checklist extends Walker {
                $output .= "\n<li id='{$taxonomy}-{$category->term_id}'$class>" . '<label class="selectit"><input value="' . $category->term_id . '" type="checkbox" name="'.$name.'[]" id="in-'.$taxonomy.'-' . $category->term_id . '"' . checked( in_array( $category->term_id, $selected_cats ), true, false ) . disabled( empty( $args['disabled'] ), false, false ) . ' /> ' . esc_html( apply_filters('the_category', $category->name )) . '</label>';
        }
 
-       function end_el(&$output, $category, $depth, $args) {
+       function end_el( &$output, $category, $depth = 0, $args = array() ) {
                $output .= "</li>\n";
        }
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Output an unordered list of checkbox <input> elements labelled
+ * with category names.
  *
+ * @see wp_terms_checklist()
  * @since 2.5.1
  *
- * @param unknown_type $post_id
- * @param unknown_type $descendants_and_self
- * @param unknown_type $selected_cats
- * @param unknown_type $popular_cats
+ * @param int $post_id Mark categories associated with this post as checked. $selected_cats must not be an array.
+ * @param int $descendants_and_self ID of the category to output along with its descendents.
+ * @param bool|array $selected_cats List of categories to mark as checked.
+ * @param bool|array $popular_cats Override the list of categories that receive the "popular-category" class.
+ * @param object $walker Walker object to use to build the output.
+ * @param bool $checked_ontop Move checked items out of the hierarchy and to the top of the list.
  */
 function wp_category_checklist( $post_id = 0, $descendants_and_self = 0, $selected_cats = false, $popular_cats = false, $walker = null, $checked_ontop = true ) {
-       wp_terms_checklist($post_id,
-               array(
-                       'taxonomy' => 'category',
-                       'descendants_and_self' => $descendants_and_self,
-                       'selected_cats' => $selected_cats,
-                       'popular_cats' => $popular_cats,
-                       'walker' => $walker,
-                       'checked_ontop' => $checked_ontop
-  ));
+       wp_terms_checklist( $post_id, array(
+               'taxonomy' => 'category',
+               'descendants_and_self' => $descendants_and_self,
+               'selected_cats' => $selected_cats,
+               'popular_cats' => $popular_cats,
+               'walker' => $walker,
+               'checked_ontop' => $checked_ontop
+       ) );
 }
 
 /**
- * Taxonomy independent version of wp_category_checklist
+ * Output an unordered list of checkbox <input> elements labelled
+ * with term names. Taxonomy independent version of wp_category_checklist().
  *
  * @since 3.0.0
  *
@@ -90,6 +96,8 @@ function wp_terms_checklist($post_id = 0, $args = array()) {
                'taxonomy' => 'category',
                'checked_ontop' => true
        );
+       $args = apply_filters( 'wp_terms_checklist_args', $args, $post_id );
+
        extract( wp_parse_args($args, $defaults), EXTR_SKIP );
 
        if ( empty($walker) || !is_a($walker, 'Walker') )
@@ -142,15 +150,20 @@ function wp_terms_checklist($post_id = 0, $args = array()) {
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Retrieve a list of the most popular terms from the specified taxonomy.
+ *
+ * If the $echo argument is true then the elements for a list of checkbox
+ * <input> elements labelled with the names of the selected terms is output.
+ * If the $post_ID global isn't empty then the terms associated with that
+ * post will be marked as checked.
  *
  * @since 2.5.0
  *
- * @param unknown_type $taxonomy
- * @param unknown_type $default
- * @param unknown_type $number
- * @param unknown_type $echo
- * @return unknown
+ * @param string $taxonomy Taxonomy to retrieve terms from.
+ * @param int $default Unused.
+ * @param int $number Number of terms to retrieve. Defaults to 10.
+ * @param bool $echo Optionally output the list as well. Defaults to true.
+ * @return array List of popular term IDs.
  */
 function wp_popular_terms_checklist( $taxonomy, $default = 0, $number = 10, $echo = true ) {
        global $post_ID;
@@ -258,17 +271,20 @@ function get_inline_data($post) {
        if ( $post->post_type == 'page' )
                echo '<div class="page_template">' . esc_html( get_post_meta( $post->ID, '_wp_page_template', true ) ) . '</div>';
 
-       if ( $post_type_object->hierarchical )
+       if ( post_type_supports( $post->post_type, 'page-attributes' ) )
                echo '<div class="menu_order">' . $post->menu_order . '</div>';
 
        $taxonomy_names = get_object_taxonomies( $post->post_type );
        foreach ( $taxonomy_names as $taxonomy_name) {
                $taxonomy = get_taxonomy( $taxonomy_name );
 
-               if ( $taxonomy->hierarchical && $taxonomy->show_ui )
-                               echo '<div class="post_category" id="'.$taxonomy_name.'_'.$post->ID.'">' . implode( ',', wp_get_object_terms( $post->ID, $taxonomy_name, array('fields'=>'ids')) ) . '</div>';
-               elseif ( $taxonomy->show_ui )
-                       echo '<div class="tags_input" id="'.$taxonomy_name.'_'.$post->ID.'">' . esc_html( str_replace( ',', ', ', get_terms_to_edit($post->ID, $taxonomy_name) ) ) . '</div>';
+               if ( $taxonomy->hierarchical && $taxonomy->show_ui ) {
+                               echo '<div class="post_category" id="' . $taxonomy_name . '_' . $post->ID . '">'
+                                       . implode( ',', wp_get_object_terms( $post->ID, $taxonomy_name, array( 'fields' => 'ids' ) ) ) . '</div>';
+               } elseif ( $taxonomy->show_ui ) {
+                       echo '<div class="tags_input" id="'.$taxonomy_name.'_'.$post->ID.'">'
+                               . esc_html( str_replace( ',', ', ', get_terms_to_edit( $post->ID, $taxonomy_name ) ) ) . '</div>';
+               }
        }
 
        if ( !$post_type_object->hierarchical )
@@ -312,7 +328,7 @@ function wp_comment_reply($position = '1', $checkbox = false, $mode = 'single',
 <div id="com-reply" style="display:none;"><div id="replyrow" style="display:none;">
 <?php endif; ?>
        <div id="replyhead" style="display:none;"><h5><?php _e( 'Reply to Comment' ); ?></h5></div>
-
+       <div id="addhead" style="display:none;"><h5><?php _e('Add new Comment'); ?></h5></div>
        <div id="edithead" style="display:none;">
                <div class="inside">
                <label for="author"><?php _e('Name') ?></label>
@@ -341,6 +357,7 @@ function wp_comment_reply($position = '1', $checkbox = false, $mode = 'single',
        <p id="replysubmit" class="submit">
        <a href="#comments-form" class="cancel button-secondary alignleft" tabindex="106"><?php _e('Cancel'); ?></a>
        <a href="#comments-form" class="save button-primary alignright" tabindex="104">
+       <span id="addbtn" style="display:none;"><?php _e('Add Comment'); ?></span>
        <span id="savebtn" style="display:none;"><?php _e('Update Comment'); ?></span>
        <span id="replybtn" style="display:none;"><?php _e('Submit Reply'); ?></span></a>
        <img class="waiting" style="display:none;" src="<?php echo esc_url( admin_url( 'images/wpspin_light.gif' ) ); ?>" alt="" />
@@ -590,7 +607,8 @@ function touch_time( $edit = 1, $for_post = 1, $tab_index = 0, $multi = 0 ) {
                $month .= "\t\t\t" . '<option value="' . $monthnum . '"';
                if ( $i == $mm )
                        $month .= ' selected="selected"';
-               $month .= '>' . $monthnum . '-' . $wp_locale->get_month_abbrev( $wp_locale->get_month( $i ) ) . "</option>\n";
+               /* translators: 1: month number (01, 02, etc.), 2: month abbreviation */
+               $month .= '>' . sprintf( __( '%1$s-%2$s' ), $monthnum, $wp_locale->get_month_abbrev( $wp_locale->get_month( $i ) ) ) . "</option>\n";
        }
        $month .= '</select>';
 
@@ -728,7 +746,6 @@ function the_attachment_links( $id = false ) {
 <?php
 }
 
-
 /**
  * Print out <option> html elements for role selectors
  *
@@ -1200,7 +1217,7 @@ function add_settings_error( $setting, $code, $message, $type = 'error' ) {
  * @param boolean $sanitize Whether to re-sanitize the setting value before returning errors.
  * @return array Array of settings errors
  */
-function get_settings_errors( $setting = '', $sanitize = FALSE ) {
+function get_settings_errors( $setting = '', $sanitize = false ) {
        global $wp_settings_errors;
 
        // If $sanitize is true, manually re-run the sanitizisation for this option
@@ -1252,13 +1269,15 @@ function get_settings_errors( $setting = '', $sanitize = FALSE ) {
  * @param boolean $sanitize Whether to re-sanitize the setting value before returning errors.
  * @param boolean $hide_on_update If set to true errors will not be shown if the settings page has already been submitted.
  */
-function settings_errors( $setting = '', $sanitize = FALSE, $hide_on_update = FALSE ) {
+function settings_errors( $setting = '', $sanitize = false, $hide_on_update = false ) {
 
-       if ($hide_on_update AND $_GET['settings-updated']) return;
+       if ( $hide_on_update && ! empty( $_GET['settings-updated'] ) )
+               return;
 
        $settings_errors = get_settings_errors( $setting, $sanitize );
 
-       if ( !is_array($settings_errors) ) return;
+       if ( ! is_array( $settings_errors ) )
+               return;
 
        $output = '';
        foreach ( $settings_errors as $key => $details ) {
@@ -1300,7 +1319,7 @@ function find_posts_div($found_action = '') {
                                        if ( 'attachment' == $post->name )
                                                continue;
                                ?>
-                               <input type="radio" name="find-posts-what" id="find-posts-<?php echo esc_attr($post->name); ?>" value="<?php echo esc_attr($post->name); ?>" <?php checked($post->name,  'post'); ?> />
+                               <input type="radio" name="find-posts-what" id="find-posts-<?php echo esc_attr($post->name); ?>" value="<?php echo esc_attr($post->name); ?>" <?php checked($post->name, 'post'); ?> />
                                <label for="find-posts-<?php echo esc_attr($post->name); ?>"><?php echo $post->label; ?></label>
                                <?php
                                } ?>
@@ -1390,7 +1409,7 @@ var userSettings = {
                'uid': '<?php if ( ! isset($current_user) ) $current_user = wp_get_current_user(); echo $current_user->ID; ?>',
                'time':'<?php echo time() ?>'
        },
-       ajaxurl = '<?php echo admin_url('admin-ajax.php'); ?>',
+       ajaxurl = '<?php echo admin_url( 'admin-ajax.php', 'relative' ); ?>',
        pagenow = '<?php echo $current_screen->id; ?>',
        typenow = '<?php echo $current_screen->post_type; ?>',
        adminpage = '<?php echo $admin_body_class; ?>',
@@ -1407,9 +1426,11 @@ do_action("admin_print_scripts-$hook_suffix");
 do_action('admin_print_scripts');
 do_action("admin_head-$hook_suffix");
 do_action('admin_head');
+
+$admin_body_class .= ' locale-' . sanitize_html_class( strtolower( str_replace( '_', '-', get_locale() ) ) );
 ?>
 </head>
-<body<?php if ( isset($GLOBALS['body_id']) ) echo ' id="' . $GLOBALS['body_id'] . '"'; ?>  class="wp-admin no-js iframe <?php echo apply_filters( 'admin_body_class', '' ) . ' ' . $admin_body_class; ?>">
+<body<?php if ( isset($GLOBALS['body_id']) ) echo ' id="' . $GLOBALS['body_id'] . '"'; ?> class="wp-admin no-js iframe <?php echo apply_filters( 'admin_body_class', '' ) . ' ' . $admin_body_class; ?>">
 <script type="text/javascript">
 //<![CDATA[
 (function(){
@@ -1589,7 +1610,7 @@ function compression_test() {
  *                     Defaults to no other attributes. Other attributes can also be provided as a
  *                     string such as 'tabindex="1"', though the array format is typically cleaner.
  */
-function submit_button( $text = NULL, $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = NULL ) {
+function submit_button( $text = null, $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = null ) {
        echo get_submit_button( $text, $type, $name, $wrap, $other_attributes );
 }
 
@@ -1610,7 +1631,7 @@ function submit_button( $text = NULL, $type = 'primary', $name = 'submit', $wrap
  *                     Defaults to no other attributes. Other attributes can also be provided as a
  *                     string such as 'tabindex="1"', though the array format is typically cleaner.
  */
-function get_submit_button( $text = NULL, $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = NULL ) {
+function get_submit_button( $text = null, $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = null ) {
        switch ( $type ) :
                case 'primary' :
                case 'secondary' :
@@ -1622,7 +1643,7 @@ function get_submit_button( $text = NULL, $type = 'primary', $name = 'submit', $
                default :
                        $class = $type; // Custom cases can just pass in the classes they want to be used
        endswitch;
-       $text = ( NULL == $text ) ? __( 'Save Changes' ) : $text;
+       $text = ( null == $text ) ? __( 'Save Changes' ) : $text;
 
        // Default the id attribute to $name unless an id was specifically provided in $other_attributes
        $id = $name;
@@ -1651,13 +1672,14 @@ function get_submit_button( $text = NULL, $type = 'primary', $name = 'submit', $
 }
 
 function _wp_admin_html_begin() {
+       $admin_html_class = ( is_admin_bar_showing() ) ? 'wp-toolbar' : '';
 ?>
 <!DOCTYPE html>
 <!--[if IE 8]>
-<html xmlns="http://www.w3.org/1999/xhtml" class="ie8" <?php do_action('admin_xml_ns'); ?> <?php language_attributes(); ?>>
+<html xmlns="http://www.w3.org/1999/xhtml" class="ie8 <?php echo $admin_html_class; ?>" <?php do_action('admin_xml_ns'); ?> <?php language_attributes(); ?>>
 <![endif]-->
 <!--[if !(IE 8) ]><!-->
-<html xmlns="http://www.w3.org/1999/xhtml" <?php do_action('admin_xml_ns'); ?> <?php language_attributes(); ?>>
+<html xmlns="http://www.w3.org/1999/xhtml" class="<?php echo $admin_html_class; ?>" <?php do_action('admin_xml_ns'); ?> <?php language_attributes(); ?>>
 <!--<![endif]-->
 <head>
 <meta http-equiv="Content-Type" content="<?php bloginfo('html_type'); ?>; charset=<?php echo get_option('blog_charset'); ?>" />
@@ -1686,36 +1708,43 @@ final class WP_Internal_Pointers {
                        'index.php'    => 'wp330_toolbar',
                        'post-new.php' => 'wp330_media_uploader',
                        'post.php'     => 'wp330_media_uploader',
-                       'themes.php'   => 'wp330_saving_widgets',
+                       'themes.php'   => array( 'wp330_saving_widgets', 'wp340_customize_current_theme_link' ),
+                       'appearance_page_custom-header' => 'wp340_choose_image_from_library',
+                       'appearance_page_custom-background' => 'wp340_choose_image_from_library',
                );
 
                // Check if screen related pointer is registered
                if ( empty( $registered_pointers[ $hook_suffix ] ) )
                        return;
 
-               $pointer = $registered_pointers[ $hook_suffix ];
+               $pointers = (array) $registered_pointers[ $hook_suffix ];
 
                $caps_required = array(
                        'wp330_media_uploader' => array( 'upload_files' ),
                        'wp330_saving_widgets' => array( 'edit_theme_options', 'switch_themes' ),
+                       'wp340_customize_current_theme_link' => array( 'edit_theme_options' ),
+                       'wp340_choose_image_from_library' => array( 'edit_theme_options' ),
                );
 
-               if ( isset( $caps_required[ $pointer ] ) ) {
-                       foreach ( $caps_required[ $pointer ] as $cap ) {
-                               if ( ! current_user_can( $cap ) )
-                                       return;
-                       }
-               }
-
                // Get dismissed pointers
                $dismissed = explode( ',', (string) get_user_meta( get_current_user_id(), 'dismissed_wp_pointers', true ) );
 
-               // Pointer has been dismissed
-               if ( in_array( $pointer, $dismissed ) )
-                       return;
+               $got_pointers = false;
+               foreach ( array_diff( $pointers, $dismissed ) as $pointer ) {
+                       if ( isset( $caps_required[ $pointer ] ) ) {
+                               foreach ( $caps_required[ $pointer ] as $cap ) {
+                                       if ( ! current_user_can( $cap ) )
+                                               continue 2;
+                               }
+                       }
 
-               // Bind pointer print function
-               add_action( 'admin_print_footer_scripts', array( 'WP_Internal_Pointers', 'pointer_' . $pointer ) );
+                       // Bind pointer print function
+                       add_action( 'admin_print_footer_scripts', array( 'WP_Internal_Pointers', 'pointer_' . $pointer ) );
+                       $got_pointers = true;
+               }
+
+               if ( ! $got_pointers )
+                       return;
 
                // Add pointers script and style to queue
                wp_enqueue_style( 'wp-pointer' );
@@ -1738,8 +1767,8 @@ final class WP_Internal_Pointers {
                ?>
                <script type="text/javascript">
                //<![CDATA[
-               jQuery(document).ready( function($) {
-                       var options = <?php echo json_encode( $args ); ?>;
+               (function($){
+                       var options = <?php echo json_encode( $args ); ?>, setup;
 
                        if ( ! options )
                                return;
@@ -1753,8 +1782,16 @@ final class WP_Internal_Pointers {
                                }
                        });
 
-                       $('<?php echo $selector; ?>').pointer( options ).pointer('open');
-               });
+                       setup = function() {
+                               $('<?php echo $selector; ?>').pointer( options ).pointer('open');
+                       };
+
+                       if ( options.position && options.position.defer_loading )
+                               $(window).bind( 'load.wp-pointers', setup );
+                       else
+                               $(document).ready( setup );
+
+               })( jQuery );
                //]]>
                </script>
                <?php
@@ -1795,7 +1832,7 @@ final class WP_Internal_Pointers {
         */
        public static function pointer_wp330_saving_widgets() {
                $content  = '<h3>' . __( 'New Feature: Saving Widgets' ) . '</h3>';
-               $content .= '<p>' . __( 'If you change your mind and revert to your previous theme, we&#8217;ll put the widgets back the way you had them.' ). '</p>';
+               $content .= '<p>' . __( 'If you change your mind and revert to your previous theme, we&#8217;ll put the widgets back the way you had them.' ) . '</p>';
 
                WP_Internal_Pointers::print_js( 'wp330_saving_widgets', '#message2', array(
                        'content'  => $content,
@@ -1803,13 +1840,44 @@ final class WP_Internal_Pointers {
                ) );
        }
 
+       /**
+        * Print 'New Feature: Current Theme Customize Link' for 3.4.0.
+        *
+        * @since 3.4.0
+        */
+       public static function pointer_wp340_customize_current_theme_link() {
+               $content  = '<h3>' . __( 'New Feature: Customizer' ) . '</h3>';
+               $content .= '<p>' . __( 'Click Customize to change the header, background, title and menus of the current theme, all in one place.' ) . '</p>';
+               $content .= '<p>' . __( 'Click the Live Preview links in the Available Themes list below to customize and preview another theme before activating it.' ) . '</p>';
+
+               WP_Internal_Pointers::print_js( 'wp340_customize_current_theme_link', '#customize-current-theme-link', array(
+                       'content'  => $content,
+                       'position' => array( 'edge' => 'top', 'align' => is_rtl() ? 'right' : 'left', 'offset' => is_rtl() ? '32 0' : '-32 0' ),
+               ) );
+       }
+
+       /**
+        * Print 'New Feature: Choose Image from Library' for 3.4.0.
+        *
+        * @since 3.4.0
+        */
+       public static function pointer_wp340_choose_image_from_library() {
+               $content  = '<h3>' . __( 'New Feature: Choose Image from Library' ) . '</h3>';
+               $content .= '<p>' . __( 'Want to use an image you uploaded earlier? Select it from your media library instead of uploading it again.' ) . '</p>';
+
+               WP_Internal_Pointers::print_js( 'wp340_choose_image_from_library', '#choose-from-library-link', array(
+                       'content'  => $content,
+                       'position' => array( 'edge' => 'top', 'align' => is_rtl() ? 'right' : 'left', 'defer_loading' => true ),
+               ) );
+       }
+
        /**
         * Prevents new users from seeing existing 'new feature' pointers.
         *
         * @since 3.3.0
         */
        public static function dismiss_pointers_for_new_users( $user_id ) {
-               add_user_meta( $user_id, 'dismissed_wp_pointers', 'wp330_toolbar,wp330_media_uploader,wp330_saving_widgets' );
+               add_user_meta( $user_id, 'dismissed_wp_pointers', 'wp330_toolbar,wp330_media_uploader,wp330_saving_widgets,wp340_choose_image_from_library,wp340_customize_current_theme_link' );
        }
 }
 
@@ -1831,4 +1899,4 @@ function convert_to_screen( $hook_name ) {
        }
 
        return WP_Screen::get( $hook_name );
-}
\ No newline at end of file
+}