Ticket #18693: 18693.more-pointers.5.patch

wp-admin/includes/template.php

@@ -1669 +1669 @@
  *
  * @since 3.3.0
  *
- * Pointer user settings:
- *    p0 - Admin bar pointer, added 3.3.
+ * All pointers can be disabled using the following:
+ *     remove_action( 'admin_enqueue_scripts', 'wp_pointer_enqueue' );
+ *
+ * Individual pointers (e.g. wp330-toolbar) can be disabled using the following:
+ *     remove_action( 'admin_print_footer_scripts', '_wp_pointer_print_wp330_toolbar' );
  */
 function wp_pointer_enqueue( $hook_suffix ) {
-        $enqueue = false;
+        /*
+         * Register feature pointers
+         * Format: array( hook_suffix => pointer_id )
+         */
+        $registered_pointers = array(
+                'index.php'    => array( 'wp330-toolbar', 'wp330-flyout-menus' ),
+                'post-new.php' => 'wp330-media-uploader',
+                'themes.php'   => 'wp330-saving-widgets',
+        );
 
+        // Check if screen related pointers are registered
+        if ( empty( $registered_pointers[$hook_suffix] ) )
+                return;
+
+        // Get dismissed pointers
         $dismissed = explode( ',', (string) get_user_meta( get_current_user_id(), 'dismissed_wp_pointers', true ) );
 
-        if ( ! in_array( 'wp330-admin-bar', $dismissed ) ) {
-                $enqueue = true;
-                add_action( 'admin_print_footer_scripts', '_wp_pointer_print_admin_bar' );
-        }
+        // Sort dismissed pointers out
+        $pointers = array_diff( (array) $registered_pointers[$hook_suffix], $dismissed );
 
-        if ( $enqueue ) {
-                wp_enqueue_style( 'wp-pointer' );
-                wp_enqueue_script( 'wp-pointer' );
-        }
+        // Pointers were already shown
+        if ( empty( $pointers ) )
+                return;
+
+        // Init pointers print functions
+        foreach ( $pointers as $pointer )
+                add_action( 'admin_print_footer_scripts', '_wp_pointer_print_' . str_replace( '-', '_', $pointer ) );
+
+        // Add pointers script and style to queue
+        wp_enqueue_style( 'wp-pointer' );
+        wp_enqueue_script( 'wp-pointer' );
 }
 add_action( 'admin_enqueue_scripts', 'wp_pointer_enqueue' );
 
-function _wp_pointer_print_admin_bar() {
-        $pointer_content  = '<h3>' . 'The admin bar has been updated in WordPress 3.3.' . '</h3>';
-        $pointer_content .= '<p>' . sprintf( 'Have some feedback? Visit the <a href="%s">forum</a>.', 'http://wordpress.org/support/forum/alphabeta' ) . '</p>';
-        $pointer_content .= '<p>' . 'P.S. You are looking at a new admin pointer.' . '</p>';
+/**
+ * Print the pointer javascript data.
+ *
+ * @since 3.3.0
+ *
+ * @param string $pointer_id The pointer ID.
+ * @param string $selector The HTML elements, on which the pointer should be attached.
+ * @param array  $args Arguments to be passed to the pointer JS (see wp-pointer.dev.js).
+ */
+function _wp_pointer_print_js_data( $pointer_id, $selector, $args ) {
+        if ( empty( $pointer_id ) || empty( $selector ) || empty( $args ) || empty( $args['content'] ) )
+                return;
 
 ?>
 <script type="text/javascript">
 //<![CDATA[
 jQuery(document).ready( function($) {
-        $('#wpadminbar').pointer({
-                content: '<?php echo $pointer_content; ?>',
-                position: {
-                        edge:  'top',
-                        align: 'center'
-                },
+        var options = <?php echo json_encode( $args ); ?>;
+
+        if ( ! options )
+                return;
+
+        options = $.extend( options, {
                 close: function() {
                         $.post( ajaxurl, {
-                                        pointer: 'wp330-admin-bar',
-                                //      _ajax_nonce: $('#_ajax_nonce').val(),
-                                        action: 'dismiss-wp-pointer'
+                                pointer: '<?php echo $pointer_id; ?>',
+                                action: 'dismiss-wp-pointer'
                         });
                 }
-        }).pointer('open');
+        });
+
+        $('<?php echo $selector; ?>').pointer( options ).pointer('open');
 });
 //]]>
 </script>
 <?php
 }
+
+/**
+ * Print 'New Feature: Toolbar' for 3.3.0.
+ *
+ * @since 3.3.0
+ */
+function _wp_pointer_print_wp330_toolbar() {
+        $content  = '<h3>' . esc_js( __( 'New Feature: Toolbar' ) ). '</h3>';
+        $content .= '<p>' . esc_js( __( 'We&#8217;ve combined the admin bar and the old Dashboard header into one persistent toolbar. Hover over the toolbar items to see what&#8217;s new.' ) ) . '</p>';
+
+        if ( is_multisite() && is_super_admin() )
+                $content .= '<p>' .esc_js( __( 'Network Admin is now located in the My Sites menu.' ) ) . '</p>';
+
+        _wp_pointer_print_js_data( 'wp330-toolbar', '#wpadminbar', array(
+                'content'  => $content,
+                'position' => array( 'edge' => 'top', 'align' => 'right' ),
+        ) );
+}
+
+/**
+ * Print 'New Feature: Flyout Menus' for 3.3.0.
+ *
+ * @since 3.3.0
+ */
+function _wp_pointer_print_wp330_flyout_menus() {
+        $content  = '<h3>' .  esc_js( __( 'New Feature: Flyout Menus' ) ) . '</h3>';
+        $content .= '<p>' .  esc_js( __( 'Instead of clicking to open and close navigation sections, just hover over a menu item and the submenu will "fly out" to the side, allowing single-click access to any screen.' ) ) . '</p>';
+
+        _wp_pointer_print_js_data( 'wp330-flyout-menus', '#menu-users', array(
+                'content'  => $content,
+                'position' => array( 'edge' => 'left', 'align' => 'center' ),
+        ) );
+}
+
+/**
+ * Print 'Updated Media Uploader' for 3.3.0.
+ *
+ * @since 3.3.0
+ */
+function _wp_pointer_print_wp330_media_uploader() {
+        $content  = '<h3>' . esc_js( __( 'Updated Media Uploader' ) ) . '</h3>';
+        $content .= '<p>' . esc_js( __( 'The single media icon now launches the uploader for all file types, and the new drag and drop interface makes uploading a breeze.' ) ) . '</p>';
+
+        _wp_pointer_print_js_data( 'wp330-media-uploader', '#content-add_media', array(
+                'content'  => $content,
+                'position' => array( 'edge' => 'left', 'align' => 'center' ),
+        ) );
+}
+
+/**
+ * Print 'New Feature: Saving Widgets' for 3.3.0.
+ *
+ * @since 3.3.0
+ */
+function _wp_pointer_print_wp330_saving_widgets() {
+        $content  = '<h3>' . esc_js( __( 'New Feature: Saving Widgets' ) ) . '</h3>';
+        $content .= '<p>' . esc_js( __( '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_pointer_print_js_data( 'wp330-saving-widgets', '#message2', array(
+                'content'  => $content,
+                'position' => array( 'edge' => 'top', 'align' => 'left' ),
+        ) );
+
+}