From fb107a4573de06cd52b38ceea7ef7aacb10fce62 Mon Sep 17 00:00:00 2001 From: Poli Gilad <83961704+poligilad-auto@users.noreply.github.com> Date: Mon, 15 Jun 2026 14:12:03 +0200 Subject: [PATCH 1/3] Administration: Add box reordering toggle to Screen Options. --- src/js/_enqueues/admin/common.js | 1 + src/js/_enqueues/admin/postbox.js | 99 +++++++++++++++++++ src/wp-admin/admin-ajax.php | 1 + src/wp-admin/admin-header.php | 2 + src/wp-admin/css/common.css | 17 ++++ src/wp-admin/css/dashboard.css | 4 + src/wp-admin/includes/ajax-actions.php | 19 ++++ src/wp-admin/includes/class-wp-screen.php | 73 ++++++++++++-- src/wp-admin/includes/screen.php | 13 +++ tests/phpunit/includes/testcase-ajax.php | 1 + tests/phpunit/tests/admin/includesScreen.php | 35 +++++++ .../tests/ajax/wpAjaxMetaBoxReordering.php | 55 +++++++++++ 12 files changed, 313 insertions(+), 7 deletions(-) create mode 100644 tests/phpunit/tests/ajax/wpAjaxMetaBoxReordering.php diff --git a/src/js/_enqueues/admin/common.js b/src/js/_enqueues/admin/common.js index c3d49310e8897..93fd8d686a63c 100644 --- a/src/js/_enqueues/admin/common.js +++ b/src/js/_enqueues/admin/common.js @@ -1859,6 +1859,7 @@ $( function() { var width = navigator.userAgent.indexOf('AppleWebKit/') > -1 ? $window.width() : window.innerWidth; if ( + $body.hasClass( 'meta-box-reordering-disabled' ) || ( width <= 782 ) || ( 1 >= $sortables.find( '.ui-sortable-handle:visible' ).length && jQuery( '.columns-prefs-1 input' ).prop( 'checked' ) ) ) { diff --git a/src/js/_enqueues/admin/postbox.js b/src/js/_enqueues/admin/postbox.js index b6d1b6569dc84..d0173134c9d0d 100644 --- a/src/js/_enqueues/admin/postbox.js +++ b/src/js/_enqueues/admin/postbox.js @@ -104,6 +104,10 @@ postboxWithinSortablesIndex = postboxesWithinSortables.index( postbox ), firstOrLastPositionMessage; + if ( ! postboxes.metaBoxReorderingEnabled ) { + return; + } + if ( 'dashboard_browser_nag' === postboxId ) { return; } @@ -344,6 +348,13 @@ postboxes.save_order( page ); } }); + + $( '.meta-box-reordering-toggle' ).on( 'click.postboxes', function() { + var enabled = $( this ).prop( 'checked' ); + + postboxes.setMetaBoxReordering( enabled ); + postboxes.save_meta_box_reordering_state( enabled ); + } ); }, /** @@ -419,6 +430,8 @@ } }); + this.setMetaBoxReordering( this.isMetaBoxReorderingEnabled() ); + if ( isMobile ) { $(document.body).on('orientationchange.postboxes', function(){ postboxes._pb_change(); }); this._pb_change(); @@ -437,6 +450,68 @@ }); }, + /** + * Checks whether meta box reordering is enabled. + * + * @since 7.1.0 + * + * @return {boolean} Whether meta box reordering is enabled. + */ + isMetaBoxReorderingEnabled: function() { + var $toggle = $( '#meta-box-reordering' ); + + if ( $toggle.length ) { + return $toggle.prop( 'checked' ); + } + + return ! $( document.body ).hasClass( 'meta-box-reordering-disabled' ); + }, + + /** + * Enables or disables the meta box reordering UI. + * + * @since 7.1.0 + * + * @param {boolean} enabled Whether reordering should be enabled. + * @return {void} + */ + setMetaBoxReordering: function( enabled ) { + var $body = $( document.body ), + $orderButtons = $( '.postbox .handle-order-higher, .postbox .handle-order-lower' ); + + this.metaBoxReorderingEnabled = !! enabled; + + $body + .toggleClass( 'meta-box-reordering-enabled', this.metaBoxReorderingEnabled ) + .toggleClass( 'meta-box-reordering-disabled', ! this.metaBoxReorderingEnabled ); + + if ( this.metaBoxReorderingEnabled ) { + $orderButtons + .prop( 'disabled', false ) + .removeAttr( 'tabindex aria-hidden' ); + this.updateOrderButtonsProperties(); + } else { + $orderButtons + .prop( 'disabled', true ) + .attr( { + 'aria-hidden': 'true', + tabindex: '-1' + } ); + } + + if ( window.wpResponsive && window.wpResponsive.maybeDisableSortables ) { + window.wpResponsive.maybeDisableSortables(); + return; + } + + try { + $( '.meta-box-sortables' ) + .sortable( this.metaBoxReorderingEnabled ? 'enable' : 'disable' ) + .find( '.ui-sortable-handle' ) + .toggleClass( 'is-non-sortable', ! this.metaBoxReorderingEnabled ); + } catch ( e ) {} + }, + /** * Saves the state of the postboxes to the server. * @@ -476,6 +551,30 @@ ); }, + /** + * Saves the meta box reordering setting to the server. + * + * @since 7.1.0 + * + * @memberof postboxes + * + * @param {boolean} enabled Whether meta box reordering is enabled. + * @return {void} + */ + save_meta_box_reordering_state : function( enabled ) { + $.post( + ajaxurl, + { + action: 'meta-box-reordering', + enabled: enabled ? 1 : 0, + screenoptionnonce: $( '#screenoptionnonce' ).val() + }, + function() { + wp.a11y.speak( __( 'Screen Options updated.' ) ); + } + ); + }, + /** * Saves the order of the postboxes to the server. * diff --git a/src/wp-admin/admin-ajax.php b/src/wp-admin/admin-ajax.php index 3ad60f95766e3..5e3d484fae988 100644 --- a/src/wp-admin/admin-ajax.php +++ b/src/wp-admin/admin-ajax.php @@ -79,6 +79,7 @@ 'add-user', 'closed-postboxes', 'hidden-columns', + 'meta-box-reordering', 'update-welcome-panel', 'menu-get-metabox', 'wp-link-ajax', diff --git a/src/wp-admin/admin-header.php b/src/wp-admin/admin-header.php index 92fbd3a4a2f79..263c76015524d 100644 --- a/src/wp-admin/admin-header.php +++ b/src/wp-admin/admin-header.php @@ -214,6 +214,8 @@ $admin_body_class .= ' block-editor-page wp-embed-responsive'; } +$admin_body_class .= wp_is_meta_box_reordering_enabled() ? ' meta-box-reordering-enabled' : ' meta-box-reordering-disabled'; + $admin_body_class .= ' wp-theme-' . sanitize_html_class( get_template() ); if ( is_child_theme() ) { $admin_body_class .= ' wp-child-theme-' . sanitize_html_class( get_stylesheet() ); diff --git a/src/wp-admin/css/common.css b/src/wp-admin/css/common.css index 784166086af4f..4c588ce4d2166 100644 --- a/src/wp-admin/css/common.css +++ b/src/wp-admin/css/common.css @@ -1962,6 +1962,18 @@ p.auto-update-status { line-height: 2.35; } +.metabox-prefs > p { + margin: 0 0 8px; +} + +.additional-settings-prefs { + margin-top: 14px; +} + +.additional-settings-prefs legend { + padding-bottom: 2px; +} + #number-of-columns { display: inline-block; vertical-align: middle; @@ -2259,6 +2271,11 @@ html.wp-toolbar { width: 1.62rem; } +.js.meta-box-reordering-disabled .postbox .handle-order-higher, +.js.meta-box-reordering-disabled .postbox .handle-order-lower { + display: none; +} + /* Post box order buttons in the block editor meta boxes area. */ .edit-post-meta-boxes-area .postbox .handle-order-higher, .edit-post-meta-boxes-area .postbox .handle-order-lower { diff --git a/src/wp-admin/css/dashboard.css b/src/wp-admin/css/dashboard.css index 1f1207606439e..2a4b0bcb09931 100644 --- a/src/wp-admin/css/dashboard.css +++ b/src/wp-admin/css/dashboard.css @@ -1408,6 +1408,10 @@ a.rsswidget { } } +.js.meta-box-reordering-disabled #dashboard-widgets .postbox-container .empty-container { + display: none; +} + @media screen and (max-width: 870px) { /* @deprecated 5.9.0 -- Lists removed from welcome panel. */ .welcome-panel .welcome-panel-column li { diff --git a/src/wp-admin/includes/ajax-actions.php b/src/wp-admin/includes/ajax-actions.php index a04de73bd64e4..276c8fa879e79 100644 --- a/src/wp-admin/includes/ajax-actions.php +++ b/src/wp-admin/includes/ajax-actions.php @@ -1856,6 +1856,25 @@ function wp_ajax_hidden_columns() { wp_die( 1 ); } +/** + * Handles the meta box reordering setting via Ajax. + * + * @since 7.1.0 + */ +function wp_ajax_meta_box_reordering() { + check_ajax_referer( 'screen-options-nonce', 'screenoptionnonce' ); + + $user = wp_get_current_user(); + if ( ! $user ) { + wp_die( -1 ); + } + + $enabled = isset( $_POST['enabled'] ) && '1' === (string) $_POST['enabled']; + update_user_meta( $user->ID, 'meta_box_reordering', $enabled ? 'enabled' : 'disabled' ); + + wp_die( 1 ); +} + /** * Handles updating whether to display the welcome panel via AJAX. * diff --git a/src/wp-admin/includes/class-wp-screen.php b/src/wp-admin/includes/class-wp-screen.php index ab7dfef77f67c..ac2297e63d40c 100644 --- a/src/wp-admin/includes/class-wp-screen.php +++ b/src/wp-admin/includes/class-wp-screen.php @@ -1006,11 +1006,23 @@ public function show_screen_options() { $this->_screen_settings = ''; + $additional_settings = ''; + + if ( $this->show_meta_box_reordering_options() ) { + $additional_settings .= $this->get_meta_box_reordering_option(); + } + if ( 'post' === $this->base ) { - $expand = ''; - $this->_screen_settings = $expand; + $additional_settings .= ''; + } + + if ( $additional_settings ) { + $this->_screen_settings = '
'; + $this->_screen_settings .= '' . __( 'Additional settings' ) . ''; + $this->_screen_settings .= $additional_settings; + $this->_screen_settings .= '
'; } /** @@ -1023,7 +1035,7 @@ public function show_screen_options() { */ $this->_screen_settings = apply_filters( 'screen_settings', $this->_screen_settings, $this ); - if ( $this->_screen_settings || $this->_options ) { + if ( $this->_screen_settings || $this->_options || $this->show_meta_box_reordering_options() ) { $show_screen = true; } @@ -1120,8 +1132,8 @@ public function render_meta_boxes_preferences() {

- - + +

show_meta_box_reordering_options() ) { + return; + } + + ?> +
+ + get_meta_box_reordering_option(); ?> +
+ ' + . ' ' + . __( 'Enable box reordering' ) + . ''; + } + + /** + * Determines whether to show the meta box reordering option. + * + * @since 7.1.0 + * + * @global array $wp_meta_boxes Global meta box state. + * + * @return bool Whether to show the option. + */ + private function show_meta_box_reordering_options() { + global $wp_meta_boxes; + + return ! empty( $wp_meta_boxes[ $this->id ] ); + } + /** * Renders the list table columns preferences. * diff --git a/src/wp-admin/includes/screen.php b/src/wp-admin/includes/screen.php index 3388ced49a4aa..ad3aa9b140a14 100644 --- a/src/wp-admin/includes/screen.php +++ b/src/wp-admin/includes/screen.php @@ -194,6 +194,19 @@ function get_hidden_meta_boxes( $screen ) { return apply_filters( 'hidden_meta_boxes', $hidden, $screen, $use_defaults ); } +/** + * Determines whether meta box reordering is enabled. + * + * @since 7.1.0 + * + * @return bool Whether meta box reordering is enabled. + */ +function wp_is_meta_box_reordering_enabled() { + $setting = get_user_option( 'meta_box_reordering' ); + + return false === $setting ? true : 'disabled' !== $setting; +} + /** * Register and configure an admin screen option * diff --git a/tests/phpunit/includes/testcase-ajax.php b/tests/phpunit/includes/testcase-ajax.php index 2e86c29e67284..fa8b98d190b94 100644 --- a/tests/phpunit/includes/testcase-ajax.php +++ b/tests/phpunit/includes/testcase-ajax.php @@ -66,6 +66,7 @@ abstract class WP_Ajax_UnitTestCase extends WP_UnitTestCase { 'add-user', 'closed-postboxes', 'hidden-columns', + 'meta-box-reordering', 'update-welcome-panel', 'menu-get-metabox', 'wp-link-ajax', diff --git a/tests/phpunit/tests/admin/includesScreen.php b/tests/phpunit/tests/admin/includesScreen.php index 26186391f261d..8eee4f41a846d 100644 --- a/tests/phpunit/tests/admin/includesScreen.php +++ b/tests/phpunit/tests/admin/includesScreen.php @@ -260,6 +260,41 @@ public function test_taxonomy_with_special_suffix_as_hookname() { $this->assertFalse( $screen->is_block_editor ); } + public function test_meta_box_reordering_enabled_defaults_to_true() { + wp_set_current_user( self::factory()->user->create( array( 'role' => 'administrator' ) ) ); + + $this->assertTrue( wp_is_meta_box_reordering_enabled() ); + } + + public function test_meta_box_reordering_enabled_respects_user_option() { + $user_id = self::factory()->user->create( array( 'role' => 'administrator' ) ); + wp_set_current_user( $user_id ); + update_user_meta( $user_id, 'meta_box_reordering', 'disabled' ); + + $this->assertFalse( wp_is_meta_box_reordering_enabled() ); + } + + public function test_meta_box_reordering_option_is_rendered_for_screens_with_meta_boxes() { + global $wp_meta_boxes; + + $old_wp_meta_boxes = $wp_meta_boxes; + $screen = convert_to_screen( 'dashboard' ); + + add_meta_box( 'testbox1', 'Test Metabox', '__return_false', $screen ); + + try { + ob_start(); + $screen->render_meta_box_reordering_options(); + $output = ob_get_clean(); + } finally { + $wp_meta_boxes = $old_wp_meta_boxes; + } + + $this->assertStringContainsString( 'id="meta-box-reordering"', $output ); + $this->assertStringContainsString( 'Additional settings', $output ); + $this->assertStringContainsString( 'Enable box reordering', $output ); + } + public function test_post_type_with_edit_prefix() { register_post_type( 'edit-some-thing' ); $screen = convert_to_screen( 'edit-some-thing' ); diff --git a/tests/phpunit/tests/ajax/wpAjaxMetaBoxReordering.php b/tests/phpunit/tests/ajax/wpAjaxMetaBoxReordering.php new file mode 100644 index 0000000000000..e3f866f06436d --- /dev/null +++ b/tests/phpunit/tests/ajax/wpAjaxMetaBoxReordering.php @@ -0,0 +1,55 @@ +_setRole( 'administrator' ); + + $_POST = array( + 'screenoptionnonce' => wp_create_nonce( 'screen-options-nonce' ), + 'enabled' => $enabled, + ); + + try { + $this->_handleAjax( 'meta-box-reordering' ); + $this->fail( 'Expected exception: WPAjaxDieStopException' ); + } catch ( WPAjaxDieStopException $e ) { + unset( $e ); + } + + $this->assertSame( $expected, get_user_meta( get_current_user_id(), 'meta_box_reordering', true ) ); + } + + /** + * Data provider. + * + * @return array[] + */ + public function data_meta_box_reordering_states() { + return array( + 'enabled' => array( 1, 'enabled' ), + 'enabled as string' => array( '1', 'enabled' ), + 'disabled' => array( 0, 'disabled' ), + 'disabled as string' => array( '0', 'disabled' ), + 'disabled when false' => array( 'false', 'disabled' ), + ); + } +} From c045aadbed7a82c44babbf17fd6090786726ad49 Mon Sep 17 00:00:00 2001 From: Jill Quek Date: Tue, 21 Jul 2026 21:50:26 +0800 Subject: [PATCH 2/3] Address meta box reordering review feedback --- src/js/_enqueues/admin/common.js | 2 +- src/js/_enqueues/admin/postbox.js | 27 +++-------- src/wp-admin/admin-header.php | 4 +- src/wp-admin/includes/ajax-actions.php | 7 +-- src/wp-admin/includes/class-wp-screen.php | 45 ++++++++----------- tests/phpunit/tests/admin/includesScreen.php | 36 +++++++++++++-- .../tests/ajax/wpAjaxMetaBoxReordering.php | 2 +- 7 files changed, 63 insertions(+), 60 deletions(-) diff --git a/src/js/_enqueues/admin/common.js b/src/js/_enqueues/admin/common.js index 93fd8d686a63c..b891a1d408fa2 100644 --- a/src/js/_enqueues/admin/common.js +++ b/src/js/_enqueues/admin/common.js @@ -1845,7 +1845,7 @@ $( function() { $document.on( 'postbox-toggled', this.maybeDisableSortables ); // When the screen columns are changed, potentially disable sortables. - $( '#screen-options-wrap input' ).on( 'click', this.maybeDisableSortables ); + $( '#screen-options-wrap input:not(.meta-box-reordering-toggle)' ).on( 'click', this.maybeDisableSortables ); }, /** diff --git a/src/js/_enqueues/admin/postbox.js b/src/js/_enqueues/admin/postbox.js index d0173134c9d0d..5ed2d1488e1a2 100644 --- a/src/js/_enqueues/admin/postbox.js +++ b/src/js/_enqueues/admin/postbox.js @@ -476,40 +476,23 @@ * @return {void} */ setMetaBoxReordering: function( enabled ) { - var $body = $( document.body ), - $orderButtons = $( '.postbox .handle-order-higher, .postbox .handle-order-lower' ); + var $sortables = $( '.meta-box-sortables' ); this.metaBoxReorderingEnabled = !! enabled; - $body - .toggleClass( 'meta-box-reordering-enabled', this.metaBoxReorderingEnabled ) - .toggleClass( 'meta-box-reordering-disabled', ! this.metaBoxReorderingEnabled ); - - if ( this.metaBoxReorderingEnabled ) { - $orderButtons - .prop( 'disabled', false ) - .removeAttr( 'tabindex aria-hidden' ); - this.updateOrderButtonsProperties(); - } else { - $orderButtons - .prop( 'disabled', true ) - .attr( { - 'aria-hidden': 'true', - tabindex: '-1' - } ); - } + $( document.body ).toggleClass( 'meta-box-reordering-disabled', ! this.metaBoxReorderingEnabled ); if ( window.wpResponsive && window.wpResponsive.maybeDisableSortables ) { window.wpResponsive.maybeDisableSortables(); return; } - try { - $( '.meta-box-sortables' ) + if ( $sortables.hasClass( 'ui-sortable' ) ) { + $sortables .sortable( this.metaBoxReorderingEnabled ? 'enable' : 'disable' ) .find( '.ui-sortable-handle' ) .toggleClass( 'is-non-sortable', ! this.metaBoxReorderingEnabled ); - } catch ( e ) {} + } }, /** diff --git a/src/wp-admin/admin-header.php b/src/wp-admin/admin-header.php index 263c76015524d..eed1af62ae3d2 100644 --- a/src/wp-admin/admin-header.php +++ b/src/wp-admin/admin-header.php @@ -214,7 +214,9 @@ $admin_body_class .= ' block-editor-page wp-embed-responsive'; } -$admin_body_class .= wp_is_meta_box_reordering_enabled() ? ' meta-box-reordering-enabled' : ' meta-box-reordering-disabled'; +if ( ! wp_is_meta_box_reordering_enabled() ) { + $admin_body_class .= ' meta-box-reordering-disabled'; +} $admin_body_class .= ' wp-theme-' . sanitize_html_class( get_template() ); if ( is_child_theme() ) { diff --git a/src/wp-admin/includes/ajax-actions.php b/src/wp-admin/includes/ajax-actions.php index 276c8fa879e79..075494681dd8a 100644 --- a/src/wp-admin/includes/ajax-actions.php +++ b/src/wp-admin/includes/ajax-actions.php @@ -1864,13 +1864,8 @@ function wp_ajax_hidden_columns() { function wp_ajax_meta_box_reordering() { check_ajax_referer( 'screen-options-nonce', 'screenoptionnonce' ); - $user = wp_get_current_user(); - if ( ! $user ) { - wp_die( -1 ); - } - $enabled = isset( $_POST['enabled'] ) && '1' === (string) $_POST['enabled']; - update_user_meta( $user->ID, 'meta_box_reordering', $enabled ? 'enabled' : 'disabled' ); + update_user_option( get_current_user_id(), 'meta_box_reordering', $enabled ? 'enabled' : 'disabled' ); wp_die( 1 ); } diff --git a/src/wp-admin/includes/class-wp-screen.php b/src/wp-admin/includes/class-wp-screen.php index ac2297e63d40c..20c493eeadd1a 100644 --- a/src/wp-admin/includes/class-wp-screen.php +++ b/src/wp-admin/includes/class-wp-screen.php @@ -1006,16 +1006,24 @@ public function show_screen_options() { $this->_screen_settings = ''; - $additional_settings = ''; + $additional_settings = ''; + $show_meta_box_reordering_option = $this->show_meta_box_reordering_options(); - if ( $this->show_meta_box_reordering_options() ) { + if ( $show_meta_box_reordering_option ) { $additional_settings .= $this->get_meta_box_reordering_option(); } if ( 'post' === $this->base ) { - $additional_settings .= ''; + if ( $show_meta_box_reordering_option ) { + $additional_settings .= ''; + } else { + $expand = ''; + $this->_screen_settings = $expand; + } } if ( $additional_settings ) { @@ -1035,7 +1043,7 @@ public function show_screen_options() { */ $this->_screen_settings = apply_filters( 'screen_settings', $this->_screen_settings, $this ); - if ( $this->_screen_settings || $this->_options || $this->show_meta_box_reordering_options() ) { + if ( $this->_screen_settings || $this->_options || $show_meta_box_reordering_option ) { $show_screen = true; } @@ -1132,8 +1140,11 @@ public function render_meta_boxes_preferences() {

- - + + + show_meta_box_reordering_options() ) : ?> + +

show_meta_box_reordering_options() ) { - return; - } - - ?> -
- - get_meta_box_reordering_option(); ?> -
- user->create( array( 'role' => 'administrator' ) ); wp_set_current_user( $user_id ); - update_user_meta( $user_id, 'meta_box_reordering', 'disabled' ); + update_user_option( $user_id, 'meta_box_reordering', 'disabled' ); $this->assertFalse( wp_is_meta_box_reordering_enabled() ); } @@ -278,13 +278,16 @@ public function test_meta_box_reordering_option_is_rendered_for_screens_with_met global $wp_meta_boxes; $old_wp_meta_boxes = $wp_meta_boxes; - $screen = convert_to_screen( 'dashboard' ); + set_current_screen( 'index.php' ); + $screen = get_current_screen(); add_meta_box( 'testbox1', 'Test Metabox', '__return_false', $screen ); try { + $screen->show_screen_options(); + ob_start(); - $screen->render_meta_box_reordering_options(); + $screen->render_screen_options(); $output = ob_get_clean(); } finally { $wp_meta_boxes = $old_wp_meta_boxes; @@ -293,6 +296,33 @@ public function test_meta_box_reordering_option_is_rendered_for_screens_with_met $this->assertStringContainsString( 'id="meta-box-reordering"', $output ); $this->assertStringContainsString( 'Additional settings', $output ); $this->assertStringContainsString( 'Enable box reordering', $output ); + $this->assertStringContainsString( 'Some screen elements can be shown or hidden by using the checkboxes.', $output ); + $this->assertStringContainsString( 'Expand or collapse the elements by clicking on their headings, and arrange them by dragging their headings or by clicking on the up and down arrows.', $output ); + $this->assertStringContainsString( 'Use the setting below to enable or disable box reordering.', $output ); + } + + public function test_meta_box_reordering_option_does_not_render_empty_additional_settings() { + global $wp_meta_boxes; + + $old_wp_meta_boxes = $wp_meta_boxes; + set_current_screen( 'post.php' ); + $screen = get_current_screen(); + + unset( $wp_meta_boxes[ $screen->id ] ); + + try { + $screen->show_screen_options(); + + ob_start(); + $screen->render_screen_options(); + $output = ob_get_clean(); + } finally { + $wp_meta_boxes = $old_wp_meta_boxes; + } + + $this->assertStringNotContainsString( 'additional-settings-prefs', $output ); + $this->assertStringContainsString( '