Skip to content

Commit 058d66e

Browse files
Administration: Add box reordering toggle to Screen Options.
1 parent 0a9838d commit 058d66e

12 files changed

Lines changed: 406 additions & 8 deletions

File tree

‎src/js/_enqueues/admin/common.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1859,6 +1859,7 @@ $( function() {
18591859
var width = navigator.userAgent.indexOf('AppleWebKit/') > -1 ? $window.width() : window.innerWidth;
18601860

18611861
if (
1862+
$body.hasClass( 'metabox-reordering-disabled' ) ||
18621863
( width <= 782 ) ||
18631864
( 1 >= $sortables.find( '.ui-sortable-handle:visible' ).length && jQuery( '.columns-prefs-1 input' ).prop( 'checked' ) )
18641865
) {

‎src/js/_enqueues/admin/postbox.js‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,10 @@
104104
postboxWithinSortablesIndex = postboxesWithinSortables.index( postbox ),
105105
firstOrLastPositionMessage;
106106

107+
if ( false === postboxes.reorderingEnabled ) {
108+
return;
109+
}
110+
107111
if ( 'dashboard_browser_nag' === postboxId ) {
108112
return;
109113
}
@@ -344,6 +348,13 @@
344348
postboxes.save_order( page );
345349
}
346350
});
351+
352+
$( '.meta-box-reorder-tog' ).on( 'click.postboxes', function() {
353+
var enabled = $( this ).prop( 'checked' );
354+
355+
postboxes.setReordering( enabled );
356+
postboxes.save_reordering_state( page, enabled );
357+
} );
347358
},
348359

349360
/**
@@ -419,6 +430,8 @@
419430
}
420431
});
421432

433+
this.setReordering( this.isReorderingEnabled() );
434+
422435
if ( isMobile ) {
423436
$(document.body).on('orientationchange.postboxes', function(){ postboxes._pb_change(); });
424437
this._pb_change();
@@ -437,6 +450,68 @@
437450
});
438451
},
439452

453+
/**
454+
* Checks whether meta box reordering is enabled.
455+
*
456+
* @since 7.1.0
457+
*
458+
* @return {boolean} Whether meta box reordering is enabled.
459+
*/
460+
isReorderingEnabled: function() {
461+
var $toggle = $( '#meta-box-reorder' );
462+
463+
if ( $toggle.length ) {
464+
return $toggle.prop( 'checked' );
465+
}
466+
467+
return ! $( document.body ).hasClass( 'metabox-reordering-disabled' );
468+
},
469+
470+
/**
471+
* Enables or disables the meta box reordering UI.
472+
*
473+
* @since 7.1.0
474+
*
475+
* @param {boolean} enabled Whether reordering should be enabled.
476+
* @return {void}
477+
*/
478+
setReordering: function( enabled ) {
479+
var $body = $( document.body ),
480+
$orderButtons = $( '.postbox .handle-order-higher, .postbox .handle-order-lower' );
481+
482+
this.reorderingEnabled = !! enabled;
483+
484+
$body
485+
.toggleClass( 'metabox-reordering-enabled', this.reorderingEnabled )
486+
.toggleClass( 'metabox-reordering-disabled', ! this.reorderingEnabled );
487+
488+
if ( this.reorderingEnabled ) {
489+
$orderButtons
490+
.prop( 'disabled', false )
491+
.removeAttr( 'tabindex aria-hidden' );
492+
this.updateOrderButtonsProperties();
493+
} else {
494+
$orderButtons
495+
.prop( 'disabled', true )
496+
.attr( {
497+
'aria-hidden': 'true',
498+
tabindex: '-1'
499+
} );
500+
}
501+
502+
if ( window.wpResponsive && window.wpResponsive.maybeDisableSortables ) {
503+
window.wpResponsive.maybeDisableSortables();
504+
return;
505+
}
506+
507+
try {
508+
$( '.meta-box-sortables' )
509+
.sortable( this.reorderingEnabled ? 'enable' : 'disable' )
510+
.find( '.ui-sortable-handle' )
511+
.toggleClass( 'is-non-sortable', ! this.reorderingEnabled );
512+
} catch ( e ) {}
513+
},
514+
440515
/**
441516
* Saves the state of the postboxes to the server.
442517
*
@@ -476,6 +551,32 @@
476551
);
477552
},
478553

554+
/**
555+
* Saves the meta box reordering setting to the server.
556+
*
557+
* @since 7.1.0
558+
*
559+
* @memberof postboxes
560+
*
561+
* @param {string} page The page we are currently on.
562+
* @param {boolean} enabled Whether meta box reordering is enabled.
563+
* @return {void}
564+
*/
565+
save_reordering_state : function( page, enabled ) {
566+
$.post(
567+
ajaxurl,
568+
{
569+
action: 'meta-box-reorder',
570+
enabled: enabled ? 1 : 0,
571+
screenoptionnonce: $( '#screenoptionnonce' ).val(),
572+
page: page
573+
},
574+
function() {
575+
wp.a11y.speak( __( 'Screen Options updated.' ) );
576+
}
577+
);
578+
},
579+
479580
/**
480581
* Saves the order of the postboxes to the server.
481582
*

‎src/wp-admin/admin-ajax.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@
7979
'add-user',
8080
'closed-postboxes',
8181
'hidden-columns',
82+
'meta-box-reorder',
8283
'update-welcome-panel',
8384
'menu-get-metabox',
8485
'wp-link-ajax',

‎src/wp-admin/admin-header.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,8 @@
214214
$admin_body_class .= ' block-editor-page wp-embed-responsive';
215215
}
216216

217+
$admin_body_class .= wp_is_meta_box_reordering_enabled( $current_screen ) ? ' metabox-reordering-enabled' : ' metabox-reordering-disabled';
218+
217219
$admin_body_class .= ' wp-theme-' . sanitize_html_class( get_template() );
218220
if ( is_child_theme() ) {
219221
$admin_body_class .= ' wp-child-theme-' . sanitize_html_class( get_stylesheet() );

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

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1947,6 +1947,26 @@ p.auto-update-status {
19471947
line-height: 2.35;
19481948
}
19491949

1950+
.metabox-prefs > p {
1951+
margin: 0 0 8px;
1952+
}
1953+
1954+
.meta-box-reorder-prefs {
1955+
margin-top: 14px;
1956+
}
1957+
1958+
.meta-box-reorder-prefs legend {
1959+
padding-bottom: 2px;
1960+
}
1961+
1962+
.meta-box-reorder-prefs p {
1963+
margin: 0 0 4px;
1964+
}
1965+
1966+
.meta-box-reorder-prefs label {
1967+
line-height: 2;
1968+
}
1969+
19501970
#number-of-columns {
19511971
display: inline-block;
19521972
vertical-align: middle;
@@ -2223,6 +2243,12 @@ html.wp-toolbar {
22232243

22242244
.postbox-header .handle-actions {
22252245
flex-shrink: 0;
2246+
padding-right: 8px;
2247+
}
2248+
2249+
.rtl .postbox-header .handle-actions {
2250+
padding-right: 0;
2251+
padding-left: 8px;
22262252
}
22272253

22282254
/* Post box order and toggle buttons. */
@@ -2244,6 +2270,30 @@ html.wp-toolbar {
22442270
width: 1.62rem;
22452271
}
22462272

2273+
.js.metabox-reordering-enabled .postbox .handle-order-higher,
2274+
.js.metabox-reordering-enabled .postbox .handle-order-lower {
2275+
opacity: 0;
2276+
pointer-events: none;
2277+
transform: translateY( -1px );
2278+
transition: opacity 0.12s ease-in-out, transform 0.12s ease-in-out;
2279+
}
2280+
2281+
.js.metabox-reordering-enabled .postbox-header:hover .handle-order-higher,
2282+
.js.metabox-reordering-enabled .postbox-header:hover .handle-order-lower,
2283+
.js.metabox-reordering-enabled .postbox-header:focus-within .handle-order-higher,
2284+
.js.metabox-reordering-enabled .postbox-header:focus-within .handle-order-lower,
2285+
.js.metabox-reordering-enabled .postbox .handle-order-higher:focus,
2286+
.js.metabox-reordering-enabled .postbox .handle-order-lower:focus {
2287+
opacity: 1;
2288+
pointer-events: auto;
2289+
transform: translateY( 0 );
2290+
}
2291+
2292+
.js.metabox-reordering-disabled .postbox .handle-order-higher,
2293+
.js.metabox-reordering-disabled .postbox .handle-order-lower {
2294+
display: none;
2295+
}
2296+
22472297
/* Post box order buttons in the block editor meta boxes area. */
22482298
.edit-post-meta-boxes-area .postbox .handle-order-higher,
22492299
.edit-post-meta-boxes-area .postbox .handle-order-lower {
@@ -3329,7 +3379,13 @@ img {
33293379
}
33303380

33313381
.postbox .handle-order-higher:focus,
3332-
.postbox .handle-order-lower:focus,
3382+
.postbox .handle-order-lower:focus {
3383+
box-shadow: inset 0 0 0 var(--wp-admin-border-width-focus, 1.5px) var(--wp-admin-theme-color);
3384+
border-radius: 4px;
3385+
/* Only visible in Windows High Contrast mode */
3386+
outline: 2px solid transparent;
3387+
}
3388+
33333389
.postbox .handlediv:focus {
33343390
box-shadow: inset 0 0 0 var(--wp-admin-border-width-focus, 1.5px) var(--wp-admin-theme-color);
33353391
border-radius: 50%;

‎src/wp-admin/css/dashboard.css‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,10 @@
6767
}
6868

6969
#dashboard-widgets .postbox-container .empty-container {
70-
outline: 2px dashed rgb(0, 0, 0, 0.15);
71-
outline-offset: -2px;
70+
box-sizing: border-box;
71+
border: 1px dashed #c3c4c7;
7272
border-radius: 8px;
7373
height: 250px;
74-
margin: 4px;
7574
}
7675

7776
/* Only highlight drop zones when dragging. */
@@ -82,7 +81,7 @@
8281
}
8382

8483
.is-dragging-metaboxes #dashboard-widgets .postbox-container .empty-container {
85-
background: rgb(0, 0, 0, 0.01);
84+
background: rgb(var(--wp-admin-theme-color--rgb), 0.04);
8685
}
8786

8887
#dashboard-widgets .postbox-container .empty-container:after {
@@ -1385,6 +1384,19 @@ a.rsswidget {
13851384
}
13861385
}
13871386

1387+
.js.metabox-reordering-disabled #dashboard-widgets .postbox-container .empty-container {
1388+
display: none;
1389+
height: 0;
1390+
min-height: 0;
1391+
margin: 0;
1392+
outline: none;
1393+
}
1394+
1395+
.js.metabox-reordering-disabled #dashboard-widgets .postbox-container .empty-container:after {
1396+
content: none;
1397+
display: none;
1398+
}
1399+
13881400
@media screen and (max-width: 870px) {
13891401
/* @deprecated 5.9.0 -- Lists removed from welcome panel. */
13901402
.welcome-panel .welcome-panel-column li {

‎src/wp-admin/includes/ajax-actions.php‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1856,6 +1856,30 @@ function wp_ajax_hidden_columns() {
18561856
wp_die( 1 );
18571857
}
18581858

1859+
/**
1860+
* Handles the meta box reordering setting via AJAX.
1861+
*
1862+
* @since 7.1.0
1863+
*/
1864+
function wp_ajax_meta_box_reorder() {
1865+
check_ajax_referer( 'screen-options-nonce', 'screenoptionnonce' );
1866+
$page = $_POST['page'] ?? '';
1867+
1868+
if ( sanitize_key( $page ) !== $page ) {
1869+
wp_die( 0 );
1870+
}
1871+
1872+
$user = wp_get_current_user();
1873+
if ( ! $user ) {
1874+
wp_die( -1 );
1875+
}
1876+
1877+
$enabled = isset( $_POST['enabled'] ) && '1' === (string) $_POST['enabled'];
1878+
update_user_meta( $user->ID, "metaboxreorder_$page", $enabled ? 'enabled' : 'disabled' );
1879+
1880+
wp_die( 1 );
1881+
}
1882+
18591883
/**
18601884
* Handles updating whether to display the welcome panel via AJAX.
18611885
*

0 commit comments

Comments
 (0)