From 8775b69cd0637535c25cb2d3af3f3749ecf343c7 Mon Sep 17 00:00:00 2001 From: noisysocks Date: Tue, 25 May 2021 08:52:58 +0000 Subject: [PATCH] Adds the widgets block editor to widgets.php and customize.php 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(). Follows [50996] which was missing these files. See #51506. Props isabel_brison, TimothyBlynJacobs, andraganescu, kevin940726, talldanwp. Built from https://develop.svn.wordpress.org/trunk@50997 git-svn-id: http://core.svn.wordpress.org/trunk@50606 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/widgets-form-blocks.php | 66 ++ wp-admin/widgets-form.php | 570 ++++++++++++++++++ wp-includes/blocks/legacy-widget.php | 111 ++++ wp-includes/blocks/legacy-widget/block.json | 28 + .../class-wp-sidebar-block-editor-control.php | 37 ++ wp-includes/version.php | 2 +- 6 files changed, 813 insertions(+), 1 deletion(-) create mode 100644 wp-admin/widgets-form-blocks.php create mode 100644 wp-admin/widgets-form.php create mode 100644 wp-includes/blocks/legacy-widget.php create mode 100644 wp-includes/blocks/legacy-widget/block.json create mode 100644 wp-includes/customize/class-wp-sidebar-block-editor-control.php diff --git a/wp-admin/widgets-form-blocks.php b/wp-admin/widgets-form-blocks.php new file mode 100644 index 0000000000..c6cb6624e8 --- /dev/null +++ b/wp-admin/widgets-form-blocks.php @@ -0,0 +1,66 @@ +is_block_editor( true ); + +$block_editor_context = new WP_Block_Editor_Context(); + +$preload_paths = array( + array( '/wp/v2/media', 'OPTIONS' ), + '/wp/v2/sidebars?context=edit&per_page=-1', + '/wp/v2/widgets?context=edit&per_page=-1&_embed=about', +); +block_editor_rest_api_preload( $preload_paths, $block_editor_context ); + +$editor_settings = get_block_editor_settings( array(), $block_editor_context ); + +wp_add_inline_script( + 'wp-edit-widgets', + sprintf( + 'wp.domReady( function() { + wp.editWidgets.initialize( "widgets-editor", %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-editor' ) ) ), + 'after' +); + +wp_enqueue_script( 'wp-edit-widgets' ); +wp_enqueue_script( 'admin-widgets' ); +wp_enqueue_script( 'wp-format-library' ); +wp_enqueue_style( 'wp-edit-widgets' ); +wp_enqueue_style( 'wp-format-library' ); + +/** This action is documented in edit-form-blocks.php */ +do_action( 'enqueue_block_editor_assets' ); + +require_once ABSPATH . 'wp-admin/admin-header.php'; +?> + +
+ +add_help_tab( + array( + 'id' => 'overview', + 'title' => __( 'Overview' ), + 'content' => + '

' . __( '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.' ) . '

+

' . __( '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.' ) . '

', + ) +); +get_current_screen()->add_help_tab( + array( + 'id' => 'removing-reusing', + 'title' => __( 'Removing and Reusing' ), + 'content' => + '

' . __( '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.' ) . '

+

' . __( 'Widgets may be used multiple times. You can give each widget a title, to display on your site, but it’s not required.' ) . '

+

' . __( 'Enabling Accessibility Mode, via Screen Options, allows you to use Add and Edit buttons instead of using drag and drop.' ) . '

', + ) +); +get_current_screen()->add_help_tab( + array( + 'id' => 'missing-widgets', + 'title' => __( 'Missing Widgets' ), + 'content' => + '

' . __( '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.' ) . '

' . + '

' . __( '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.' ) . '

', + ) +); + +get_current_screen()->set_help_sidebar( + '

' . __( 'For more information:' ) . '

' . + '

' . __( 'Documentation on Widgets' ) . '

' . + '

' . __( 'Support' ) . '

' +); + +if ( ! current_theme_supports( 'widgets' ) ) { + wp_die( __( 'The theme you are currently using isn’t widget-aware, meaning that it has no sidebars that you are able to change. For information on making your theme widget-aware, please follow these instructions.' ) ); +} + +// 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'; ?> +
+

+
> +

+ +

+ +
+
+ ' . __( 'There are no options for this widget.' ) . "

\n"; + } + ?> +
+ +

+
+ + $sbvalue ) { + echo "\t\t\n"; + } + ?> +
"; + if ( 'wp_inactive_widgets' === $sbname || 'orphaned_widgets' === substr( $sbname, 0, 16 ) ) { + echo ' '; + } 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\n"; + } + echo "
+
+ +
+
+ + + + | + + + + +
+
+ + + + + +
+
+
+ +
+
+
+ + +
+

+ +

+ +%2$s', + 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' ); +?> +
+ +
+ +
+ + +

+ + +

+ + + + +
+
+
+
+ +

+
+
+
+

+
+
+ +
+
+
+
+
+ + $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']; + ?> +
+
+ + + +
+
+

+ 'inactive-widgets-control-remove' ); + + if ( empty( $sidebars_widgets['wp_inactive_widgets'] ) ) { + $attributes['disabled'] = ''; + } + + submit_button( __( 'Clear Inactive Widgets' ), 'delete', 'removeinactivewidgets', false, $attributes ); + ?> + +

+ +
+
+ +
+ +

+ +
+ +
+
+ 1 ) { + $split = (int) ceil( $sidebars_count / 2 ); +} else { + $single_sidebar_class = ' single-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 ) { + ?> +
+ +
+ +
+ +
+
+
+
+ +
+
+
+ +
+ +
+ + +
+
+ + 'render_block_core_legacy_widget', + ) + ); +} + +add_action( 'init', 'register_block_core_legacy_widget', 20 ); + +/** + * Intercepts any request with legacy-widget-preview in the query param and, if + * set, renders a page containing a preview of the requested Legacy Widget + * block. + */ +function handle_legacy_widget_preview_iframe() { + if ( empty( $_GET['legacy-widget-preview'] ) ) { + return; + } + + if ( ! current_user_can( 'edit_theme_options' ) ) { + return; + } + + define( 'IFRAME_REQUEST', true ); + + ?> + + > + + + + + + + + > +
+
+ get_registered( 'core/legacy-widget' ); + echo $block->render( $_GET['legacy-widget-preview'] ); + ?> +
+
+ + + +