vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2025-10-16 12:05:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Adds the widgets block editor to widgets.php and customize.php

Browse Source 
Moves the widgets block editor from Gutenberg into WordPress Core.

- Adds @wordpress/edit-widgets, @wordpress/customize-widgets and
  @wordpress/widgets.
- Modifies wp-admin/widgets.php to branch between the old editor and new editor
  depending on wp_use_widgets_block_editor().
- Modifies WP_Customize_Widgets to branch between the old editor control and new
  editor control depending on wp_use_widgets_block_editor().

Fixes #51506.
Props isabel_brison, TimothyBlynJacobs, andraganescu, kevin940726, talldanwp.


git-svn-id: https://develop.svn.wordpress.org/trunk@50996 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Robert Anderson 2021-05-25 08:38:04 +00:00
parent bc48d7ae09
commit 00bc227eb8
16 changed files with 973 additions and 811 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

823
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

15
package.json
View File

@ -82,22 +82,24 @@
"@wordpress/api-fetch": "5.1.0",
"@wordpress/autop": "3.1.0",
"@wordpress/blob": "3.1.0",
"@wordpress/block-directory": "2.1.0",
"@wordpress/block-directory": "2.1.2",
"@wordpress/block-editor": "6.1.0",
"@wordpress/block-library": "3.1.0",
"@wordpress/block-library": "3.2.1",
"@wordpress/block-serialization-default-parser": "4.1.0",
"@wordpress/blocks": "9.1.0",
"@wordpress/components": "14.1.0",
"@wordpress/compose": "4.1.0",
"@wordpress/core-data": "3.1.0",
"@wordpress/core-data": "3.1.1",
"@wordpress/customize-widgets": "1.0.1",
"@wordpress/data": "5.1.0",
"@wordpress/data-controls": "2.1.0",
"@wordpress/date": "4.1.0",
"@wordpress/deprecated": "3.1.0",
"@wordpress/dom": "3.1.0",
"@wordpress/dom-ready": "3.1.0",
"@wordpress/edit-post": "4.1.0",
"@wordpress/editor": "10.1.0",
"@wordpress/edit-post": "4.1.2",
"@wordpress/edit-widgets": "2.1.2",
"@wordpress/editor": "10.1.1",
"@wordpress/element": "3.1.0",
"@wordpress/escape-html": "2.1.0",
"@wordpress/format-library": "2.1.0",
@ -117,7 +119,7 @@
"@wordpress/primitives": "2.1.0",
"@wordpress/priority-queue": "2.1.0",
"@wordpress/redux-routine": "4.1.0",
"@wordpress/reusable-blocks": "2.1.0",
"@wordpress/reusable-blocks": "2.1.1",
"@wordpress/rich-text": "4.1.0",
"@wordpress/server-side-render": "2.1.0",
"@wordpress/shortcode": "3.1.0",
@ -125,6 +127,7 @@
"@wordpress/url": "3.1.0",
"@wordpress/viewport": "3.1.0",
"@wordpress/warning": "2.1.0",
"@wordpress/widgets": "1.1.1",
"@wordpress/wordcount": "3.1.0",
"backbone": "1.4.0",
"clipboard": "2.0.8",

3
src/wp-admin/admin-header.php
View File

@ -190,8 +190,7 @@ if ( is_network_admin() ) {
$admin_body_class .= ' no-customize-support no-svg';
if ( $current_screen->is_block_editor() ) {
// Default to is-fullscreen-mode to avoid jumps in the UI.
$admin_body_class .= ' block-editor-page is-fullscreen-mode wp-embed-responsive';
$admin_body_class .= ' block-editor-page wp-embed-responsive';
}
$error_get_last = error_get_last();

8
src/wp-admin/edit-form-blocks.php
View File

@ -29,6 +29,14 @@ $block_editor_context = new WP_Block_Editor_Context( array( 'post' => $post ) );
$current_screen = get_current_screen();
$current_screen->is_block_editor( true );
// Default to is-fullscreen-mode to avoid jumps in the UI.
add_filter(
'admin_body_class',
function( $classes ) {
return "$classes is-fullscreen-mode";
}
);
/*
* Emoji replacement is disabled for now, until it plays nicely with React.
*/

560
src/wp-admin/widgets.php
View File

@ -1,6 +1,6 @@
<?php
/**
* Widget administration panel
* Widget administration screen.
*
* @package WordPress
* @subpackage Administration
@ -20,563 +20,11 @@ if ( ! current_user_can( 'edit_theme_options' ) ) {
);
}
$widgets_access = get_user_setting( 'widgets_access' );
if ( isset( $_GET['widgets-access'] ) ) {
check_admin_referer( 'widgets-access' );
$widgets_access = 'on' === $_GET['widgets-access'] ? 'on' : 'off';
set_user_setting( 'widgets_access', $widgets_access );
}
if ( 'on' === $widgets_access ) {
add_filter( 'admin_body_class', 'wp_widgets_access_body_class' );
} else {
wp_enqueue_script( 'admin-widgets' );
if ( wp_is_mobile() ) {
wp_enqueue_script( 'jquery-touch-punch' );
}
}
/**
* Fires early before the Widgets administration screen loads,
* after scripts are enqueued.
*
* @since 2.2.0
*/
do_action( 'sidebar_admin_setup' );
$title = __( 'Widgets' );
$parent_file = 'themes.php';
get_current_screen()->add_help_tab(
array(
'id' => 'overview',
'title' => __( 'Overview' ),
'content' =>
'<p>' . __( 'Widgets are independent sections of content that can be placed into any widgetized area provided by your theme (commonly called sidebars). To populate your sidebars/widget areas with individual widgets, drag and drop the title bars into the desired area. By default, only the first widget area is expanded. To populate additional widget areas, click on their title bars to expand them.' ) . '</p>
<p>' . __( 'The Available Widgets section contains all the widgets you can choose from. Once you drag a widget into a sidebar, it will open to allow you to configure its settings. When you are happy with the widget settings, click the Save button and the widget will go live on your site. If you click Delete, it will remove the widget.' ) . '</p>',
)
);
get_current_screen()->add_help_tab(
array(
'id' => 'removing-reusing',
'title' => __( 'Removing and Reusing' ),
'content' =>
'<p>' . __( 'If you want to remove the widget but save its setting for possible future use, just drag it into the Inactive Widgets area. You can add them back anytime from there. This is especially helpful when you switch to a theme with fewer or different widget areas.' ) . '</p>
<p>' . __( 'Widgets may be used multiple times. You can give each widget a title, to display on your site, but it&#8217;s not required.' ) . '</p>
<p>' . __( 'Enabling Accessibility Mode, via Screen Options, allows you to use Add and Edit buttons instead of using drag and drop.' ) . '</p>',
)
);
get_current_screen()->add_help_tab(
array(
'id' => 'missing-widgets',
'title' => __( 'Missing Widgets' ),
'content' =>
'<p>' . __( 'Many themes show some sidebar widgets by default until you edit your sidebars, but they are not automatically displayed in your sidebar management tool. After you make your first widget change, you can re-add the default widgets by adding them from the Available Widgets area.' ) . '</p>' .
'<p>' . __( 'When changing themes, there is often some variation in the number and setup of widget areas/sidebars and sometimes these conflicts make the transition a bit less smooth. If you changed themes and seem to be missing widgets, scroll down on this screen to the Inactive Widgets area, where all of your widgets and their settings will have been saved.' ) . '</p>',
)
);
get_current_screen()->set_help_sidebar(
'<p><strong>' . __( 'For more information:' ) . '</strong></p>' .
'<p>' . __( '<a href="https://wordpress.org/support/article/appearance-widgets-screen/">Documentation on Widgets</a>' ) . '</p>' .
'<p>' . __( '<a href="https://wordpress.org/support/">Support</a>' ) . '</p>'
);
if ( ! current_theme_supports( 'widgets' ) ) {
wp_die( __( 'The theme you are currently using isn&#8217;t widget-aware, meaning that it has no sidebars that you are able to change. For information on making your theme widget-aware, please <a href="https://developer.wordpress.org/themes/functionality/widgets/">follow these instructions</a>.' ) );
}
// These are the widgets grouped by sidebar.
$sidebars_widgets = wp_get_sidebars_widgets();
if ( empty( $sidebars_widgets ) ) {
$sidebars_widgets = wp_get_widget_defaults();
}
foreach ( $sidebars_widgets as $sidebar_id => $widgets ) {
if ( 'wp_inactive_widgets' === $sidebar_id ) {
continue;
}
if ( ! is_registered_sidebar( $sidebar_id ) ) {
if ( ! empty( $widgets ) ) { // Register the inactive_widgets area as sidebar.
register_sidebar(
array(
'name' => __( 'Inactive Sidebar (not used)' ),
'id' => $sidebar_id,
'class' => 'inactive-sidebar orphan-sidebar',
'description' => __( 'This sidebar is no longer available and does not show anywhere on your site. Remove each of the widgets below to fully remove this inactive sidebar.' ),
'before_widget' => '',
'after_widget' => '',
'before_title' => '',
'after_title' => '',
)
);
} else {
unset( $sidebars_widgets[ $sidebar_id ] );
}
}
}
// Register the inactive_widgets area as sidebar.
register_sidebar(
array(
'name' => __( 'Inactive Widgets' ),
'id' => 'wp_inactive_widgets',
'class' => 'inactive-sidebar',
'description' => __( 'Drag widgets here to remove them from the sidebar but keep their settings.' ),
'before_widget' => '',
'after_widget' => '',
'before_title' => '',
'after_title' => '',
)
);
retrieve_widgets();
// We're saving a widget without JS.
if ( isset( $_POST['savewidget'] ) || isset( $_POST['removewidget'] ) ) {
$widget_id = $_POST['widget-id'];
check_admin_referer( "save-delete-widget-$widget_id" );
$number = isset( $_POST['multi_number'] ) ? (int) $_POST['multi_number'] : '';
if ( $number ) {
foreach ( $_POST as $key => $val ) {
if ( is_array( $val ) && preg_match( '/__i__|%i%/', key( $val ) ) ) {
$_POST[ $key ] = array( $number => array_shift( $val ) );
break;
}
}
}
$sidebar_id = $_POST['sidebar'];
$position = isset( $_POST[ $sidebar_id . '_position' ] ) ? (int) $_POST[ $sidebar_id . '_position' ] - 1 : 0;
$id_base = $_POST['id_base'];
$sidebar = isset( $sidebars_widgets[ $sidebar_id ] ) ? $sidebars_widgets[ $sidebar_id ] : array();
// Delete.
if ( isset( $_POST['removewidget'] ) && $_POST['removewidget'] ) {
if ( ! in_array( $widget_id, $sidebar, true ) ) {
wp_redirect( admin_url( 'widgets.php?error=0' ) );
exit;
}
$sidebar = array_diff( $sidebar, array( $widget_id ) );
$_POST = array(
'sidebar' => $sidebar_id,
'widget-' . $id_base => array(),
'the-widget-id' => $widget_id,
'delete_widget' => '1',
);
/**
* Fires immediately after a widget has been marked for deletion.
*
* @since 4.4.0
*
* @param string $widget_id ID of the widget marked for deletion.
* @param string $sidebar_id ID of the sidebar the widget was deleted from.
* @param string $id_base ID base for the widget.
*/
do_action( 'delete_widget', $widget_id, $sidebar_id, $id_base );
}
$_POST['widget-id'] = $sidebar;
foreach ( (array) $wp_registered_widget_updates as $name => $control ) {
if ( $name !== $id_base || ! is_callable( $control['callback'] ) ) {
continue;
}
ob_start();
call_user_func_array( $control['callback'], $control['params'] );
ob_end_clean();
break;
}
$sidebars_widgets[ $sidebar_id ] = $sidebar;
// Remove old position.
if ( ! isset( $_POST['delete_widget'] ) ) {
foreach ( $sidebars_widgets as $key => $sb ) {
if ( is_array( $sb ) ) {
$sidebars_widgets[ $key ] = array_diff( $sb, array( $widget_id ) );
}
}
array_splice( $sidebars_widgets[ $sidebar_id ], $position, 0, $widget_id );
}
wp_set_sidebars_widgets( $sidebars_widgets );
wp_redirect( admin_url( 'widgets.php?message=0' ) );
exit;
}
// Remove inactive widgets without JS.
if ( isset( $_POST['removeinactivewidgets'] ) ) {
check_admin_referer( 'remove-inactive-widgets', '_wpnonce_remove_inactive_widgets' );
if ( $_POST['removeinactivewidgets'] ) {
foreach ( $sidebars_widgets['wp_inactive_widgets'] as $key => $widget_id ) {
$pieces = explode( '-', $widget_id );
$multi_number = array_pop( $pieces );
$id_base = implode( '-', $pieces );
$widget = get_option( 'widget_' . $id_base );
unset( $widget[ $multi_number ] );
update_option( 'widget_' . $id_base, $widget );
unset( $sidebars_widgets['wp_inactive_widgets'][ $key ] );
}
wp_set_sidebars_widgets( $sidebars_widgets );
}
wp_redirect( admin_url( 'widgets.php?message=0' ) );
exit;
}
// Output the widget form without JS.
if ( isset( $_GET['editwidget'] ) && $_GET['editwidget'] ) {
$widget_id = $_GET['editwidget'];
if ( isset( $_GET['addnew'] ) ) {
// Default to the first sidebar.
$keys = array_keys( $wp_registered_sidebars );
$sidebar = reset( $keys );
if ( isset( $_GET['base'] ) && isset( $_GET['num'] ) ) { // Multi-widget.
// Copy minimal info from an existing instance of this widget to a new instance.
foreach ( $wp_registered_widget_controls as $control ) {
if ( $_GET['base'] === $control['id_base'] ) {
$control_callback = $control['callback'];
$multi_number = (int) $_GET['num'];
$control['params'][0]['number'] = -1;
$control['id'] = $control['id_base'] . '-' . $multi_number;
$widget_id = $control['id'];
$wp_registered_widget_controls[ $control['id'] ] = $control;
break;
}
}
}
}
if ( isset( $wp_registered_widget_controls[ $widget_id ] ) && ! isset( $control ) ) {
$control = $wp_registered_widget_controls[ $widget_id ];
$control_callback = $control['callback'];
} elseif ( ! isset( $wp_registered_widget_controls[ $widget_id ] ) && isset( $wp_registered_widgets[ $widget_id ] ) ) {
$name = esc_html( strip_tags( $wp_registered_widgets[ $widget_id ]['name'] ) );
}
if ( ! isset( $name ) ) {
$name = esc_html( strip_tags( $control['name'] ) );
}
if ( ! isset( $sidebar ) ) {
$sidebar = isset( $_GET['sidebar'] ) ? $_GET['sidebar'] : 'wp_inactive_widgets';
}
if ( ! isset( $multi_number ) ) {
$multi_number = isset( $control['params'][0]['number'] ) ? $control['params'][0]['number'] : '';
}
$id_base = isset( $control['id_base'] ) ? $control['id_base'] : $control['id'];
// Show the widget form.
$width = ' style="width:' . max( $control['width'], 350 ) . 'px"';
$key = isset( $_GET['key'] ) ? (int) $_GET['key'] : 0;
require_once ABSPATH . 'wp-admin/admin-header.php'; ?>
<div class="wrap">
<h1><?php echo esc_html( $title ); ?></h1>
<div class="editwidget"<?php echo $width; ?>>
<h2>
<?php
/* translators: %s: Widget name. */
printf( __( 'Widget %s' ), $name );
?>
</h2>
<form action="widgets.php" method="post">
<div class="widget-inside">
<?php
if ( is_callable( $control_callback ) ) {
call_user_func_array( $control_callback, $control['params'] );
} else {
echo '<p>' . __( 'There are no options for this widget.' ) . "</p>\n";
}
?>
</div>
<p class="describe"><?php _e( 'Select both the sidebar for this widget and the position of the widget in that sidebar.' ); ?></p>
<div class="widget-position">
<table class="widefat"><thead><tr><th><?php _e( 'Sidebar' ); ?></th><th><?php _e( 'Position' ); ?></th></tr></thead><tbody>
<?php
foreach ( $wp_registered_sidebars as $sbname => $sbvalue ) {
echo "\t\t<tr><td><label><input type='radio' name='sidebar' value='" . esc_attr( $sbname ) . "'" . checked( $sbname, $sidebar, false ) . " /> $sbvalue[name]</label></td><td>";
if ( 'wp_inactive_widgets' === $sbname || 'orphaned_widgets' === substr( $sbname, 0, 16 ) ) {
echo '&nbsp;';
} else {
if ( ! isset( $sidebars_widgets[ $sbname ] ) || ! is_array( $sidebars_widgets[ $sbname ] ) ) {
$j = 1;
$sidebars_widgets[ $sbname ] = array();
} else {
$j = count( $sidebars_widgets[ $sbname ] );
if ( isset( $_GET['addnew'] ) || ! in_array( $widget_id, $sidebars_widgets[ $sbname ], true ) ) {
$j++;
}
}
$selected = '';
echo "\t\t<select name='{$sbname}_position'>\n";
echo "\t\t<option value=''>" . __( '&mdash; Select &mdash;' ) . "</option>\n";
for ( $i = 1; $i <= $j; $i++ ) {
if ( in_array( $widget_id, $sidebars_widgets[ $sbname ], true ) ) {
$selected = selected( $i, $key + 1, false );
}
echo "\t\t<option value='$i'$selected> $i </option>\n";
}
echo "\t\t</select>\n";
}
echo "</td></tr>\n";
}
?>
</tbody></table>
</div>
<div class="widget-control-actions">
<div class="alignleft">
<?php if ( ! isset( $_GET['addnew'] ) ) : ?>
<input type="submit" name="removewidget" id="removewidget" class="button-link button-link-delete widget-control-remove" value="<?php _e( 'Delete' ); ?>" />
<span class="widget-control-close-wrapper">
| <a href="widgets.php" class="button-link widget-control-close"><?php _e( 'Cancel' ); ?></a>
</span>
<?php else : ?>
<a href="widgets.php" class="button-link widget-control-close"><?php _e( 'Cancel' ); ?></a>
<?php endif; ?>
</div>
<div class="alignright">
<?php submit_button( __( 'Save Widget' ), 'primary alignright', 'savewidget', false ); ?>
<input type="hidden" name="widget-id" class="widget-id" value="<?php echo esc_attr( $widget_id ); ?>" />
<input type="hidden" name="id_base" class="id_base" value="<?php echo esc_attr( $id_base ); ?>" />
<input type="hidden" name="multi_number" class="multi_number" value="<?php echo esc_attr( $multi_number ); ?>" />
<?php wp_nonce_field( "save-delete-widget-$widget_id" ); ?>
</div>
<br class="clear" />
</div>
</form>
</div>
</div>
<?php
require_once ABSPATH . 'wp-admin/admin-footer.php';
exit;
}
$messages = array(
__( 'Changes saved.' ),
);
$errors = array(
__( 'Error while saving.' ),
__( 'Error in displaying the widget settings form.' ),
);
require_once ABSPATH . 'wp-admin/admin-header.php';
?>
<div class="wrap">
<h1 class="wp-heading-inline">
<?php
echo esc_html( $title );
?>
</h1>
<?php
if ( current_user_can( 'customize' ) ) {
printf(
' <a class="page-title-action hide-if-no-customize" href="%1$s">%2$s</a>',
esc_url(
add_query_arg(
array(
array( 'autofocus' => array( 'panel' => 'widgets' ) ),
'return' => urlencode( remove_query_arg( wp_removable_query_args(), wp_unslash( $_SERVER['REQUEST_URI'] ) ) ),
),
admin_url( 'customize.php' )
)
),
__( 'Manage with Live Preview' )
);
}
$nonce = wp_create_nonce( 'widgets-access' );
?>
<div class="widget-access-link">
<a id="access-on" href="widgets.php?widgets-access=on&_wpnonce=<?php echo urlencode( $nonce ); ?>"><?php _e( 'Enable accessibility mode' ); ?></a><a id="access-off" href="widgets.php?widgets-access=off&_wpnonce=<?php echo urlencode( $nonce ); ?>"><?php _e( 'Disable accessibility mode' ); ?></a>
</div>
<hr class="wp-header-end">
<?php if ( isset( $_GET['message'] ) && isset( $messages[ $_GET['message'] ] ) ) { ?>
<div id="message" class="updated notice is-dismissible"><p><?php echo $messages[ $_GET['message'] ]; ?></p></div>
<?php } ?>
<?php if ( isset( $_GET['error'] ) && isset( $errors[ $_GET['error'] ] ) ) { ?>
<div id="message" class="error"><p><?php echo $errors[ $_GET['error'] ]; ?></p></div>
<?php } ?>
<?php
/**
* Fires before the Widgets administration page content loads.
*
* @since 3.0.0
*/
do_action( 'widgets_admin_page' );
?>
<div class="widget-liquid-left">
<div id="widgets-left">
<div id="available-widgets" class="widgets-holder-wrap">
<div class="sidebar-name">
<button type="button" class="handlediv hide-if-no-js" aria-expanded="true">
<span class="screen-reader-text"><?php _e( 'Available Widgets' ); ?></span>
<span class="toggle-indicator" aria-hidden="true"></span>
</button>
<h2><?php _e( 'Available Widgets' ); ?> <span id="removing-widget"><?php _ex( 'Deactivate', 'removing-widget' ); ?> <span></span></span></h2>
</div>
<div class="widget-holder">
<div class="sidebar-description">
<p class="description"><?php _e( 'To activate a widget drag it to a sidebar or click on it. To deactivate a widget and delete its settings, drag it back.' ); ?></p>
</div>
<div id="widget-list">
<?php wp_list_widgets(); ?>
</div>
<br class='clear' />
</div>
<br class="clear" />
</div>
<?php
$theme_sidebars = array();
foreach ( $wp_registered_sidebars as $sidebar => $registered_sidebar ) {
if ( false !== strpos( $registered_sidebar['class'], 'inactive-sidebar' ) || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) {
$wrap_class = 'widgets-holder-wrap';
if ( ! empty( $registered_sidebar['class'] ) ) {
$wrap_class .= ' ' . $registered_sidebar['class'];
}
$is_inactive_widgets = 'wp_inactive_widgets' === $registered_sidebar['id'];
?>
<div class="<?php echo esc_attr( $wrap_class ); ?>">
<div class="widget-holder inactive">
<?php wp_list_widget_controls( $registered_sidebar['id'], $registered_sidebar['name'] ); ?>
<?php if ( $is_inactive_widgets ) { ?>
<div class="remove-inactive-widgets">
<form action="" method="post">
<p>
<?php
$attributes = array( 'id' => 'inactive-widgets-control-remove' );
if ( empty( $sidebars_widgets['wp_inactive_widgets'] ) ) {
$attributes['disabled'] = '';
}
submit_button( __( 'Clear Inactive Widgets' ), 'delete', 'removeinactivewidgets', false, $attributes );
?>
<span class="spinner"></span>
</p>
<?php wp_nonce_field( 'remove-inactive-widgets', '_wpnonce_remove_inactive_widgets' ); ?>
</form>
</div>
<?php } ?>
</div>
<?php if ( $is_inactive_widgets ) { ?>
<p class="description"><?php _e( 'This will clear all items from the inactive widgets list. You will not be able to restore any customizations.' ); ?></p>
<?php } ?>
</div>
<?php
} else {
$theme_sidebars[ $sidebar ] = $registered_sidebar;
}
}
?>
</div>
</div>
<?php
$i = 0;
$split = 0;
$single_sidebar_class = '';
$sidebars_count = count( $theme_sidebars );
if ( $sidebars_count > 1 ) {
$split = (int) ceil( $sidebars_count / 2 );
if ( wp_use_widgets_block_editor() ) {
require ABSPATH . 'wp-admin/widgets-form-blocks.php';
} else {
$single_sidebar_class = ' single-sidebar';
require ABSPATH . 'wp-admin/widgets-form.php';
}
?>
<div class="widget-liquid-right">
<div id="widgets-right" class="wp-clearfix<?php echo $single_sidebar_class; ?>">
<div class="sidebars-column-1">
<?php
foreach ( $theme_sidebars as $sidebar => $registered_sidebar ) {
$wrap_class = 'widgets-holder-wrap';
if ( ! empty( $registered_sidebar['class'] ) ) {
$wrap_class .= ' sidebar-' . $registered_sidebar['class'];
}
if ( $i > 0 ) {
$wrap_class .= ' closed';
}
if ( $split && $i === $split ) {
?>
</div><div class="sidebars-column-2">
<?php
}
?>
<div class="<?php echo esc_attr( $wrap_class ); ?>">
<?php
// Show the control forms for each of the widgets in this sidebar.
wp_list_widget_controls( $sidebar, $registered_sidebar['name'] );
?>
</div>
<?php
$i++;
}
?>
</div>
</div>
</div>
<form method="post">
<?php wp_nonce_field( 'save-sidebar-widgets', '_wpnonce_widgets', false ); ?>
</form>
<br class="clear" />
</div>
<div class="widgets-chooser">
<ul class="widgets-chooser-sidebars"></ul>
<div class="widgets-chooser-actions">
<button class="button widgets-chooser-cancel"><?php _e( 'Cancel' ); ?></button>
<button class="button button-primary widgets-chooser-add"><?php _e( 'Add Widget' ); ?></button>
</div>
</div>
<?php
/**
* Fires after the available widgets and sidebars have loaded, before the admin footer.
*
* @since 2.2.0
*/
do_action( 'sidebar_admin_page' );
require_once ABSPATH . 'wp-admin/admin-footer.php';

2
src/wp-includes/assets/script-loader-packages.php
View File

File diff suppressed because one or more lines are too long

34
src/wp-includes/block-editor.php
View File

@ -225,6 +225,40 @@ function get_default_block_editor_settings() {
$editor_settings['gradients'] = $gradient_presets;
}
/**
* Filters the list of widget-type IDs that should **not** be offered by the
* Legacy Widget block.
*
* Returning an empty array will make all widgets available.
*
* @since 5.8.0
*
* @param array $widgets An array of excluded widget-type IDs.
*/
$editor_settings['widgetTypesToHideFromLegacyWidgetBlock'] = apply_filters(
'widget_types_to_hide_from_legacy_widget_block',
array(
'pages',
'calendar',
'archives',
'media_audio',
'media_image',
'media_gallery',
'media_video',
'meta',
'search',
'text',
'categories',
'recent-posts',
'recent-comments',
'rss',
'tag_cloud',
'nav_menu',
'custom_html',
'block',
)
);
return $editor_settings;
}

1
src/wp-includes/blocks/index.php
View File

@ -13,6 +13,7 @@ require ABSPATH . WPINC . '/blocks/categories.php';
require ABSPATH . WPINC . '/blocks/file.php';
require ABSPATH . WPINC . '/blocks/latest-comments.php';
require ABSPATH . WPINC . '/blocks/latest-posts.php';
require ABSPATH . WPINC . '/blocks/legacy-widget.php';
require ABSPATH . WPINC . '/blocks/loginout.php';
require ABSPATH . WPINC . '/blocks/post-content.php';
require ABSPATH . WPINC . '/blocks/post-date.php';

5
src/wp-includes/class-wp-customize-control.php
View File

@ -795,3 +795,8 @@ require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-auto-add-
* WP_Customize_Date_Time_Control class.
*/
require_once ABSPATH . WPINC . '/customize/class-wp-customize-date-time-control.php';
/**
* WP_Sidebar_Block_Editor_Control class.
*/
require_once ABSPATH . WPINC . '/customize/class-wp-sidebar-block-editor-control.php';

215
src/wp-includes/class-wp-customize-widgets.php
View File

@ -118,6 +118,7 @@ final class WP_Customize_Widgets {
add_action( 'customize_controls_print_footer_scripts', array( $this, 'output_widget_control_templates' ) );
add_action( 'customize_preview_init', array( $this, 'customize_preview_init' ) );
add_filter( 'customize_refresh_nonces', array( $this, 'refresh_nonces' ) );
add_filter( 'should_load_block_editor_scripts_and_styles', array( $this, 'should_load_block_editor_scripts_and_styles' ) );
add_action( 'dynamic_sidebar', array( $this, 'tally_rendered_widgets' ) );
add_filter( 'is_active_sidebar', array( $this, 'tally_sidebars_via_is_active_sidebar_calls' ), 10, 2 );
@ -368,6 +369,8 @@ final class WP_Customize_Widgets {
public function customize_register() {
global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_sidebars;
$use_widgets_block_editor = wp_use_widgets_block_editor();
add_filter( 'sidebars_widgets', array( $this, 'preview_sidebars_widgets' ), 1 );
$sidebars_widgets = array_merge(
@ -446,13 +449,18 @@ final class WP_Customize_Widgets {
if ( $is_active_sidebar ) {
$section_args = array(
'title' => $wp_registered_sidebars[ $sidebar_id ]['name'],
'description' => $wp_registered_sidebars[ $sidebar_id ]['description'],
'priority' => array_search( $sidebar_id, array_keys( $wp_registered_sidebars ), true ),
'panel' => 'widgets',
'sidebar_id' => $sidebar_id,
'title' => $wp_registered_sidebars[ $sidebar_id ]['name'],
'priority' => array_search( $sidebar_id, array_keys( $wp_registered_sidebars ), true ),
'panel' => 'widgets',
'sidebar_id' => $sidebar_id,
);
if ( $use_widgets_block_editor ) {
$section_args['description'] = '';
} else {
$section_args['description'] = $wp_registered_sidebars[ $sidebar_id ]['description'];
}
/**
* Filters Customizer widget section arguments for a given sidebar.
*
@ -467,49 +475,63 @@ final class WP_Customize_Widgets {
$section = new WP_Customize_Sidebar_Section( $this->manager, $section_id, $section_args );
$this->manager->add_section( $section );
$control = new WP_Widget_Area_Customize_Control(
$this->manager,
$setting_id,
array(
'section' => $section_id,
'sidebar_id' => $sidebar_id,
'priority' => count( $sidebar_widget_ids ), // place 'Add Widget' and 'Reorder' buttons at end.
)
);
$new_setting_ids[] = $setting_id;
if ( $use_widgets_block_editor ) {
$control = new WP_Sidebar_Block_Editor_Control(
$this->manager,
$setting_id,
array(
'section' => $section_id,
'sidebar_id' => $sidebar_id,
)
);
} else {
$control = new WP_Widget_Area_Customize_Control(
$this->manager,
$setting_id,
array(
'section' => $section_id,
'sidebar_id' => $sidebar_id,
'priority' => count( $sidebar_widget_ids ), // place 'Add Widget' and 'Reorder' buttons at end.
)
);
}
$this->manager->add_control( $control );
$new_setting_ids[] = $setting_id;
}
}
// Add a control for each active widget (located in a sidebar).
foreach ( $sidebar_widget_ids as $i => $widget_id ) {
if ( ! $use_widgets_block_editor ) {
// Add a control for each active widget (located in a sidebar).
foreach ( $sidebar_widget_ids as $i => $widget_id ) {
// Skip widgets that may have gone away due to a plugin being deactivated.
if ( ! $is_active_sidebar || ! isset( $wp_registered_widgets[ $widget_id ] ) ) {
continue;
// Skip widgets that may have gone away due to a plugin being deactivated.
if ( ! $is_active_sidebar || ! isset( $wp_registered_widgets[ $widget_id ] ) ) {
continue;
}
$registered_widget = $wp_registered_widgets[ $widget_id ];
$setting_id = $this->get_setting_id( $widget_id );
$id_base = $wp_registered_widget_controls[ $widget_id ]['id_base'];
$control = new WP_Widget_Form_Customize_Control(
$this->manager,
$setting_id,
array(
'label' => $registered_widget['name'],
'section' => $section_id,
'sidebar_id' => $sidebar_id,
'widget_id' => $widget_id,
'widget_id_base' => $id_base,
'priority' => $i,
'width' => $wp_registered_widget_controls[ $widget_id ]['width'],
'height' => $wp_registered_widget_controls[ $widget_id ]['height'],
'is_wide' => $this->is_wide_widget( $widget_id ),
)
);
$this->manager->add_control( $control );
}
$registered_widget = $wp_registered_widgets[ $widget_id ];
$setting_id = $this->get_setting_id( $widget_id );
$id_base = $wp_registered_widget_controls[ $widget_id ]['id_base'];
$control = new WP_Widget_Form_Customize_Control(
$this->manager,
$setting_id,
array(
'label' => $registered_widget['name'],
'section' => $section_id,
'sidebar_id' => $sidebar_id,
'widget_id' => $widget_id,
'widget_id_base' => $id_base,
'priority' => $i,
'width' => $wp_registered_widget_controls[ $widget_id ]['width'],
'height' => $wp_registered_widget_controls[ $widget_id ]['height'],
'is_wide' => $this->is_wide_widget( $widget_id ),
)
);
$this->manager->add_control( $control );
}
}
@ -805,6 +827,46 @@ final class WP_Customize_Widgets {
'data',
sprintf( 'var _wpCustomizeWidgetsSettings = %s;', wp_json_encode( $settings ) )
);
// TODO: Update 'wp-customize-widgets' to not rely so much on things in
// 'customize-widgets'. This will let us skip most of the above and not
// enqueue 'customize-widgets' which saves bytes.
if ( wp_use_widgets_block_editor() ) {
$block_editor_context = new WP_Block_Editor_Context();
$editor_settings = get_block_editor_settings( array(), $block_editor_context );
wp_add_inline_script(
'wp-customize-widgets',
sprintf(
'wp.domReady( function() {
wp.customizeWidgets.initialize( "widgets-customizer", %s );
} );',
wp_json_encode( $editor_settings )
)
);
// Preload server-registered block schemas.
wp_add_inline_script(
'wp-blocks',
'wp.blocks.unstable__bootstrapServerSideBlockDefinitions(' . wp_json_encode( get_block_editor_server_block_settings() ) . ');'
);
wp_add_inline_script(
'wp-blocks',
sprintf( 'wp.blocks.setCategories( %s );', wp_json_encode( get_block_categories( 'widgets-customizer' ) ) ),
'after'
);
wp_enqueue_script( 'wp-customize-widgets' );
wp_enqueue_style( 'wp-customize-widgets' );
wp_enqueue_script( 'wp-format-library' );
wp_enqueue_style( 'wp-format-library' );
/** This action is documented in edit-form-blocks.php */
do_action( 'enqueue_block_editor_assets' );
}
}
/**
@ -888,8 +950,13 @@ final class WP_Customize_Widgets {
$args['sanitize_js_callback'] = array( $this, 'sanitize_sidebar_widgets_js_instance' );
$args['transport'] = current_theme_supports( 'customize-selective-refresh-widgets' ) ? 'postMessage' : 'refresh';
} elseif ( preg_match( $this->setting_id_patterns['widget_instance'], $id, $matches ) ) {
$args['sanitize_callback'] = array( $this, 'sanitize_widget_instance' );
$args['sanitize_js_callback'] = array( $this, 'sanitize_widget_js_instance' );
$id_base = $matches['id_base'];
$args['sanitize_callback'] = function( $value ) use ( $id_base ) {
return $this->sanitize_widget_instance( $value, $id_base );
};
$args['sanitize_js_callback'] = function( $value ) use ( $id_base ) {
return $this->sanitize_widget_js_instance( $value, $id_base );
};
$args['transport'] = $this->is_widget_selective_refreshable( $matches['id_base'] ) ? 'postMessage' : 'refresh';
}
@ -1108,6 +1175,23 @@ final class WP_Customize_Widgets {
return $nonces;
}
/**
* Tells the script loader to load the scripts and styles of custom blocks
* if the widgets block editor is enabled.
*
* @since 5.8.0
*
* @param bool $is_block_editor_screen Current decision about loading block assets.
* @return bool Filtered decision about loading block assets.
*/
public function should_load_block_editor_scripts_and_styles( $is_block_editor_screen ) {
if ( wp_use_widgets_block_editor() ) {
return true;
}
return $is_block_editor_screen;
}
/**
* When previewing, ensures the proper previewing widgets are used.
*
@ -1314,16 +1398,28 @@ final class WP_Customize_Widgets {
* @since 3.9.0
*
* @param array $value Widget instance to sanitize.
* @param string $id_base Base of the ID of the widget being sanitized.
* @return array|void Sanitized widget instance.
*/
public function sanitize_widget_instance( $value ) {
public function sanitize_widget_instance( $value, $id_base = null ) {
global $wp_widget_factory;
if ( array() === $value ) {
return $value;
return;
}
if ( empty( $value['is_widget_customizer_js_value'] )
|| empty( $value['instance_hash_key'] )
|| empty( $value['encoded_serialized_instance'] ) ) {
if ( isset( $value['raw_instance'] ) && $id_base && wp_use_widgets_block_editor() ) {
$widget_object = $wp_widget_factory->get_widget_object( $id_base );
if ( ! empty( $widget_object->widget_options['show_instance_in_rest'] ) ) {
return $value['raw_instance'];
}
}
if (
empty( $value['is_widget_customizer_js_value'] ) ||
empty( $value['instance_hash_key'] ) ||
empty( $value['encoded_serialized_instance'] )
) {
return;
}
@ -1350,19 +1446,32 @@ final class WP_Customize_Widgets {
* @since 3.9.0
*
* @param array $value Widget instance to convert to JSON.
* @param string $id_base Base of the ID of the widget being sanitized.
* @return array JSON-converted widget instance.
*/
public function sanitize_widget_js_instance( $value ) {
public function sanitize_widget_js_instance( $value, $id_base = null ) {
global $wp_widget_factory;
if ( empty( $value['is_widget_customizer_js_value'] ) ) {
$serialized = serialize( $value );
$value = array(
$js_value = array(
'encoded_serialized_instance' => base64_encode( $serialized ),
'title' => empty( $value['title'] ) ? '' : $value['title'],
'is_widget_customizer_js_value' => true,
'instance_hash_key' => $this->get_instance_hash_key( $serialized ),
);
if ( $id_base && wp_use_widgets_block_editor() ) {
$widget_object = $wp_widget_factory->get_widget_object( $id_base );
if ( ! empty( $widget_object->widget_options['show_instance_in_rest'] ) ) {
$js_value['raw_instance'] = (object) $value;
}
}
return $js_value;
}
return $value;
}
@ -1432,7 +1541,7 @@ final class WP_Customize_Widgets {
return new WP_Error( 'widget_setting_malformed' );
}
$instance = $this->sanitize_widget_instance( $sanitized_widget_setting );
$instance = $this->sanitize_widget_instance( $sanitized_widget_setting, $parsed_id['id_base'] );
if ( is_null( $instance ) ) {
$this->stop_capturing_option_updates();
return new WP_Error( 'widget_setting_unsanitized' );
@ -1498,7 +1607,7 @@ final class WP_Customize_Widgets {
* in place from WP_Customize_Setting::preview() will use this value
* instead of the default widget instance value (an empty array).
*/
$this->manager->set_post_value( $setting_id, $this->sanitize_widget_js_instance( $instance ) );
$this->manager->set_post_value( $setting_id, $this->sanitize_widget_js_instance( $instance, $parsed_id['id_base'] ) );
// Obtain the widget control with the updated instance in place.
ob_start();
@ -1571,7 +1680,7 @@ final class WP_Customize_Widgets {
}
$form = $updated_widget['form'];
$instance = $this->sanitize_widget_js_instance( $updated_widget['instance'] );
$instance = $this->sanitize_widget_js_instance( $updated_widget['instance'], $id_base );
wp_send_json_success( compact( 'form', 'instance' ) );
}

14
src/wp-includes/script-loader.php
View File

@ -1552,6 +1552,20 @@ function wp_default_styles( $styles ) {
'list-reusable-blocks' => array( 'wp-components' ),
'reusable-blocks' => array( 'wp-components' ),
'nux' => array( 'wp-components' ),
'edit-widgets' => array(
'wp-components',
'wp-block-editor',
'wp-edit-blocks',
'wp-block-library',
'wp-reusable-blocks',
),
'customize-widgets' => array(
'wp-components',
'wp-block-editor',
'wp-edit-blocks',
'wp-block-library',
'wp-reusable-blocks',
),
);
foreach ( $package_styles as $package => $dependencies ) {

36
src/wp-includes/widgets.php
View File

@ -1801,6 +1801,8 @@ function wp_widgets_init() {
register_widget( 'WP_Widget_Block' );
add_theme_support( 'widgets-block-editor' );
/**
* Fires after all default WordPress widgets have been registered.
*
@ -1809,6 +1811,27 @@ function wp_widgets_init() {
do_action( 'widgets_init' );
}
/**
* Whether or not to use the block editor to manage widgets. Defaults to true
* unless a theme has removed support for widgets-block-editor or a plugin has
* filtered the return value of this function.
*
* @since 5.8.0
*
* @return boolean Whether or not to use the block editor to manage widgets.
*/
function wp_use_widgets_block_editor() {
/**
* Filters whether or not to use the block editor to manage widgets.
*
* @param boolean $use_widgets_block_editor Whether or not to use the block editor to manage widgets.
*/
return apply_filters(
'use_widgets_block_editor',
get_theme_support( 'widgets-block-editor' )
);
}
/**
* Converts a widget ID into its id_base and number components.
*
@ -1971,3 +1994,16 @@ function wp_render_widget_control( $id ) {
return ob_get_clean();
}
// Needed until src/blocks/legacy-widget/index.php in @wordpress/block-library
// is updated to use the 'wp_' functions.
function gutenberg_find_widgets_sidebar( $widget_id ) {
return wp_find_widgets_sidebar( $widget_id );
}
function gutenberg_render_widget( $widget_id, $sidebar_id ) {
return wp_render_widget( $widget_id, $sidebar_id );
}
function gutenberg_get_widget_object( $id_base ) {
global $wp_widget_factory;
return $wp_widget_factory->get_widget_object( $id_base );
}

1
tests/phpunit/includes/functions.php
View File

@ -310,6 +310,7 @@ function _unhook_block_registration() {
remove_action( 'init', 'register_block_core_loginout' );
remove_action( 'init', 'register_block_core_latest_comments' );
remove_action( 'init', 'register_block_core_latest_posts' );
remove_action( 'init', 'register_block_core_legacy_widget', 20 );
remove_action( 'init', 'register_block_core_post_author' );
remove_action( 'init', 'register_block_core_post_content' );
remove_action( 'init', 'register_block_core_post_date' );

25
tests/phpunit/tests/blocks/block-editor.php
View File

@ -159,7 +159,7 @@ class WP_Test_Block_Editor extends WP_UnitTestCase {
function test_get_default_block_editor_settings() {
$settings = get_default_block_editor_settings();
$this->assertCount( 16, $settings );
$this->assertCount( 17, $settings );
$this->assertFalse( $settings['alignWide'] );
$this->assertInternalType( 'array', $settings['allowedMimeTypes'] );
$this->assertTrue( $settings['allowedBlockTypes'] );
@ -254,6 +254,29 @@ class WP_Test_Block_Editor extends WP_UnitTestCase {
$settings['imageSizes']
);
$this->assertInternalType( 'int', $settings['maxUploadFileSize'] );
$this->assertSameSets(
array(
'archives',
'block',
'calendar',
'categories',
'custom_html',
'media_audio',
'media_gallery',
'media_image',
'media_video',
'meta',
'nav_menu',
'pages',
'recent-comments',
'recent-posts',
'rss',
'search',
'tag_cloud',
'text',
),
$settings['widgetTypesToHideFromLegacyWidgetBlock']
);
}
/**

41
tests/phpunit/tests/customize/widgets.php
View File

@ -25,6 +25,7 @@ class Tests_WP_Customize_Widgets extends WP_UnitTestCase {
require_once ABSPATH . WPINC . '/class-wp-customize-manager.php';
add_theme_support( 'customize-selective-refresh-widgets' );
add_action( 'widgets_init', array( $this, 'remove_widgets_block_editor' ) );
$user_id = self::factory()->user->create( array( 'role' => 'administrator' ) );
wp_set_current_user( $user_id );
$GLOBALS['wp_customize'] = new WP_Customize_Manager();
@ -85,6 +86,10 @@ class Tests_WP_Customize_Widgets extends WP_UnitTestCase {
do_action( 'wp', $GLOBALS['wp'] );
}
function remove_widgets_block_editor() {
remove_theme_support( 'widgets-block-editor' );
}
/**
* Test WP_Customize_Widgets::__construct()
*/
@ -258,31 +263,31 @@ class Tests_WP_Customize_Widgets extends WP_UnitTestCase {
add_filter( 'widget_customizer_setting_args', array( $this, 'filter_widget_customizer_setting_args' ), 10, 2 );
$default_args = array(
'type' => 'option',
'capability' => 'edit_theme_options',
'transport' => 'refresh',
'default' => array(),
'sanitize_callback' => array( $this->manager->widgets, 'sanitize_widget_instance' ),
'sanitize_js_callback' => array( $this->manager->widgets, 'sanitize_widget_js_instance' ),
'type' => 'option',
'capability' => 'edit_theme_options',
'transport' => 'refresh',
'default' => array(),
);
$args = $this->manager->widgets->get_setting_args( 'widget_foo[2]' );
foreach ( $default_args as $key => $default_value ) {
$this->assertSame( $default_value, $args[ $key ] );
}
$this->assertTrue( is_callable( $args['sanitize_callback'] ), 'sanitize_callback is callable' );
$this->asserttrue( is_callable( $args['sanitize_js_callback'] ), 'sanitize_js_callback is callable' );
$this->assertSame( 'WIDGET_FOO[2]', $args['uppercase_id_set_by_filter'] );
$default_args = array(
'type' => 'option',
'capability' => 'edit_theme_options',
'transport' => 'postMessage',
'default' => array(),
'sanitize_callback' => array( $this->manager->widgets, 'sanitize_widget_instance' ),
'sanitize_js_callback' => array( $this->manager->widgets, 'sanitize_widget_js_instance' ),
'type' => 'option',
'capability' => 'edit_theme_options',
'transport' => 'postMessage',
'default' => array(),
);
$args = $this->manager->widgets->get_setting_args( 'widget_search[2]' );
foreach ( $default_args as $key => $default_value ) {
$this->assertSame( $default_value, $args[ $key ] );
}
$this->assertTrue( is_callable( $args['sanitize_callback'] ), 'sanitize_callback is callable' );
$this->asserttrue( is_callable( $args['sanitize_js_callback'] ), 'sanitize_js_callback is callable' );
remove_theme_support( 'customize-selective-refresh-widgets' );
$args = $this->manager->widgets->get_setting_args( 'widget_search[2]' );
@ -304,17 +309,17 @@ class Tests_WP_Customize_Widgets extends WP_UnitTestCase {
$this->assertSame( 'WIDGET_BAR[3]', $args['uppercase_id_set_by_filter'] );
$default_args = array(
'type' => 'option',
'capability' => 'edit_theme_options',
'transport' => 'postMessage',
'default' => array(),
'sanitize_callback' => array( $this->manager->widgets, 'sanitize_sidebar_widgets' ),
'sanitize_js_callback' => array( $this->manager->widgets, 'sanitize_sidebar_widgets_js_instance' ),
'type' => 'option',
'capability' => 'edit_theme_options',
'transport' => 'postMessage',
'default' => array(),
);
$args = $this->manager->widgets->get_setting_args( 'sidebars_widgets[sidebar-1]' );
foreach ( $default_args as $key => $default_value ) {
$this->assertSame( $default_value, $args[ $key ] );
}
$this->assertTrue( is_callable( $args['sanitize_callback'] ), 'sanitize_callback is callable' );
$this->asserttrue( is_callable( $args['sanitize_js_callback'] ), 'sanitize_js_callback is callable' );
$this->assertSame( 'SIDEBARS_WIDGETS[SIDEBAR-1]', $args['uppercase_id_set_by_filter'] );
$override_args = array(

1
tools/webpack/packages.js
View File

@ -112,6 +112,7 @@ module.exports = function( env = { environment: 'production', watch: false, buil
'file',
'latest-comments',
'latest-posts',
'legacy-widget',
'loginout',
'post-content',
'post-date',