Upstream
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Docs: Update documentation for some `WP_Customize_Widgets` methods per the documentation standards. 

* Add missing `@since` tags for the `$id_base` parameter of ::sanitize_widget_instance()` and `::sanitize_widget_js_instance()`.
* Document the usage of `$wp_widget_factory` global in `::sanitize_widget_instance()`.
* Use multi-line comment syntax for a comment in `::enqueue_scripts()`.

Follow-up to [50996], [51141].

See #52628.
Built from https://develop.svn.wordpress.org/trunk@51142


git-svn-id: http://core.svn.wordpress.org/trunk@50751 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2021-06-14 15:16:58 +00:00
parent 2e0e705d4c
commit 05e98e28f3
2 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
wp-includes/class-wp-customize-widgets.php
View File

@ -828,9 +828,11 @@ final class WP_Customize_Widgets {
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.
/*
* 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();
@ -1394,11 +1396,12 @@ final class WP_Customize_Widgets {
* only get applied to an instance *once*.
*
* @since 3.9.0
* @since 5.8.0 Added the `$id_base` parameter.
*
* @global WP_Widget_Factory $wp_widget_factory
*
* @param array $value Widget instance to sanitize.
* @param string $id_base Base of the ID of the widget being sanitized.
* @param array $value Widget instance to sanitize.
* @param string $id_base Optional. Base of the ID of the widget being sanitized. Default null.
* @return array|void Sanitized widget instance.
*/
public function sanitize_widget_instance( $value, $id_base = null ) {
@ -1444,9 +1447,12 @@ final class WP_Customize_Widgets {
* Converts a widget instance into JSON-representable format.
*
* @since 3.9.0
* @since 5.8.0 Added the `$id_base` parameter.
*
* @param array $value Widget instance to convert to JSON.
* @param string $id_base Base of the ID of the widget being sanitized.
* @global WP_Widget_Factory $wp_widget_factory
*
* @param array $value Widget instance to convert to JSON.
* @param string $id_base Optional. Base of the ID of the widget being sanitized. Default null.
* @return array JSON-converted widget instance.
*/
public function sanitize_widget_js_instance( $value, $id_base = null ) {

2
wp-includes/version.php
View File

@ -13,7 +13,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.8-beta1-51141';
$wp_version = '5.8-beta1-51142';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.