Changeset 35161

Timestamp:

10/14/2015 06:57:16 PM (10 years ago)

Author:

helen

Message:

Screen options: Improve the "Apply" button

Previously the button was output as a part of the per-page option rendering, inline with that input. While this was appropriate for core's usage, the screen_settings filter has allowed plugins to place additional items at the bottom of the panel, which a number take advantage of. This leads to confusing situations where plugins that don't save settings via Ajax either have to add their own button or piggyback onto the existing button, which doesn't make any sense in the flow of additional options. It also hinders core from adding any other options that need to be submitted.

Also, when the screen options panel is open, a submit button there is the primary action at that moment. The "Apply" button also does a full page load, which a primary button indicates better.

fixes #34295. see #22222, #23738.

Location:

trunk/src/wp-admin

Files:

• css/common.css (modified) (1 diff)
• includes/class-wp-screen.php (modified) (3 diffs)

trunk/src/wp-admin/css/common.css

@@ -1628 +1628 @@
 .screen-options + .screen-options {
     margin-top: 10px;
+}
+
+.metabox-prefs .submit {
+    margin-top: 1em;
+    padding: 0;
 }
 

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

@@ -994 +994 @@
         echo $this->_screen_settings;
 
+        /**
+         * Filter whether to show the Screen Options submit button.
+         *
+         * @since 4.4.0
+         * 
+         * @param bool      $show_button Whether to show Screen Options submit button.
+         *                               Default false.
+         * @param WP_Screen $this        Current WP_Screen instance.
+         */
+        $show_button = apply_filters( 'screen_options_show_submit', false, $this );
+
+        if ( $show_button ) {
+            submit_button( __( 'Apply' ), 'primary', 'screen-options-apply', true );
+        }
+
         echo $form_end . $wrapper_end;
     }
@@ -1156 +1171 @@
         }
 
+        // This needs a submit button
+        add_filter( 'screen_options_show_submit', '__return_true' );
+
         ?>
         <fieldset class="screen-options">
@@ -1164 +1182 @@
                     id="<?php echo esc_attr( $option ); ?>" maxlength="3"
                     value="<?php echo esc_attr( $per_page ); ?>" />
-            <?php endif;
-
-            echo get_submit_button( __( 'Apply' ), 'button', 'screen-options-apply', false ); ?>
-            <input type="hidden" name="wp_screen_options[option]" value="<?php echo esc_attr( $option ); ?>" />
+            <?php endif; ?>
+                <input type="hidden" name="wp_screen_options[option]" value="<?php echo esc_attr( $option ); ?>" />
         </fieldset>
         <?php