Changeset 37972

Timestamp:

07/05/2016 03:21:44 PM (8 years ago)

Author:

ocean90

Message:

Dashboard: Don't add a "Configure" link to the toggle button.

The HTML for the toggle gets appended to the widget name which is later used for the widget title and the screen reader text of the toggle button. Storing the original widget name in the arguments allows us to use the name without the HTML for the screen reader text and doesn't require further changes by plugin developers.

Props nicholas_io, swissspidy.
Fixes #35021.

Location:

trunk/src/wp-admin/includes

Files:

• dashboard.php (modified) (1 diff)
• screen.php (modified) (1 diff)
• template.php (modified) (1 diff)

trunk/src/wp-admin/includes/dashboard.php

@@ -148 +148 @@
     $screen = get_current_screen();
     global $wp_dashboard_control_callbacks;
+
+    $private_callback_args = array( '__widget_basename' => $widget_name );
+
+    if ( is_null( $callback_args ) ) {
+        $callback_args = $private_callback_args;
+    } else if ( is_array( $callback_args ) ) {
+        $callback_args = array_merge( $callback_args, $private_callback_args );
+    }
 
     if ( $control_callback && current_user_can( 'edit_dashboard' ) && is_callable( $control_callback ) ) {

trunk/src/wp-admin/includes/screen.php

@@ -118 +118 @@
                 if ( 'submitdiv' == $box['id'] || 'linksubmitdiv' == $box['id'] )
                     continue;
-                $box_id = $box['id'];
-                echo '<label for="' . $box_id . '-hide">';
-                echo '<input class="hide-postbox-tog" name="' . $box_id . '-hide" type="checkbox" id="' . $box_id . '-hide" value="' . $box_id . '"' . (! in_array($box_id, $hidden) ? ' checked="checked"' : '') . ' />';
-                echo "{$box['title']}</label>\n";
+
+                $widget_title = $box['title'];
+
+                if ( isset( $box['args']['__widget_basename'] ) ) {
+                    $widget_title = $box['args']['__widget_basename'];
+                }
+
+                printf(
+                    '<label for="%1$s-hide"><input class="hide-postbox-tog" name="%1$s-hide" type="checkbox" id="%1$s-hide" value="%1$s" %2$s />%3$s</label>',
+                    esc_attr( $box['id'] ),
+                    checked( in_array( $box['id'], $hidden ), false, false ),
+                    $widget_title
+                );
             }
         }

trunk/src/wp-admin/includes/template.php

@@ -1028 +1028 @@
                     echo '<div id="' . $box['id'] . '" class="postbox ' . postbox_classes($box['id'], $page) . $hidden_class . '" ' . '>' . "\n";
                     if ( 'dashboard_browser_nag' != $box['id'] ) {
+                        $widget_title = $box[ 'title' ];
+
+                        if ( is_array( $box[ 'args' ] ) && isset( $box[ 'args' ][ '__widget_basename' ] ) ) {
+                            $widget_title = esc_html( $box[ 'args' ][ '__widget_basename' ] );
+                            // Do not pass this parameter to the user callback function.
+                            unset( $box[ 'args' ][ '__widget_basename' ] );
+                        }
+
                         echo '<button type="button" class="handlediv button-link" aria-expanded="true">';
-                        echo '<span class="screen-reader-text">' . sprintf( __( 'Toggle panel: %s' ), $box['title'] ) . '</span>';
+                        echo '<span class="screen-reader-text">' . sprintf( __( 'Toggle panel: %s' ), $widget_title ) . '</span>';
                         echo '<span class="toggle-indicator" aria-hidden="true"></span>';
                         echo '</button>';