# gutenberg/12.1.0/lib/widgets-api.php Gutenberg, version 12.1.0. 270 lines. - Page: https://pluginprobe.com/plugins/gutenberg/12.1.0/code/lib/widgets-api.php - Raw: https://pluginprobe.com/plugins/gutenberg/12.1.0/raw/lib/widgets-api.php - Modified: 2021-07-07T15:06:36+00:00 Line numbers below start at 1. Link to a line or a range by appending a fragment to the page URL, for example `https://pluginprobe.com/plugins/gutenberg/12.1.0/code/lib/widgets-api.php#L10-L20`. ```php $widgets ) { foreach ( $widgets as $i => $maybe_widget_id ) { if ( $widget_id === $maybe_widget_id && $sidebar_id !== $maybe_sidebar_id ) { unset( $sidebars[ $maybe_sidebar_id ][ $i ] ); // We could technically break 2 here, but continue looping in case the id is duplicated. continue 2; } } } if ( $sidebar_id ) { $sidebars[ $sidebar_id ][] = $widget_id; } wp_set_sidebars_widgets( $sidebars ); } } if ( ! function_exists( 'wp_find_widgets_sidebar' ) ) { /** * Finds the sidebar that a given widget belongs to. * * Can be removed when minimum WordPress version is 5.8. * * @since 10.3.0 * * @param string $widget_id The widget id to look for. * @return string|null The found sidebar's id, or null if it was not found. */ function wp_find_widgets_sidebar( $widget_id ) { foreach ( wp_get_sidebars_widgets() as $sidebar_id => $widget_ids ) { foreach ( $widget_ids as $maybe_widget_id ) { if ( $maybe_widget_id === $widget_id ) { return (string) $sidebar_id; } } } return null; } } if ( ! function_exists( 'wp_parse_widget_id' ) ) { /** * Converts a widget ID into its id_base and number components. * * Can be removed when minimum WordPress version is 5.8. * * @since 10.2.0 * * @param string $id Widget ID. * @return array Array containing a widget's id_base and number components. */ function wp_parse_widget_id( $id ) { $parsed = array(); if ( preg_match( '/^(.+)-(\d+)$/', $id, $matches ) ) { $parsed['id_base'] = $matches[1]; $parsed['number'] = (int) $matches[2]; } else { // Likely an old single widget. $parsed['id_base'] = $id; } return $parsed; } } if ( ! function_exists( 'wp_render_widget' ) ) { /** * Calls the render callback of a widget and returns the output. * * Can be removed when minimum WordPress version is 5.8. * * @since 10.2.0 * * @param string $widget_id Widget ID. * @param string $sidebar_id Sidebar ID. * @return string */ function wp_render_widget( $widget_id, $sidebar_id ) { global $wp_registered_widgets, $wp_registered_sidebars; if ( ! isset( $wp_registered_widgets[ $widget_id ] ) ) { return ''; } if ( isset( $wp_registered_sidebars[ $sidebar_id ] ) ) { $sidebar = $wp_registered_sidebars[ $sidebar_id ]; } elseif ( 'wp_inactive_widgets' === $sidebar_id ) { $sidebar = array(); } else { return ''; } $params = array_merge( array( array_merge( $sidebar, array( 'widget_id' => $widget_id, 'widget_name' => $wp_registered_widgets[ $widget_id ]['name'], ) ), ), (array) $wp_registered_widgets[ $widget_id ]['params'] ); // Substitute HTML `id` and `class` attributes into `before_widget`. $classname_ = ''; foreach ( (array) $wp_registered_widgets[ $widget_id ]['classname'] as $cn ) { if ( is_string( $cn ) ) { $classname_ .= '_' . $cn; } elseif ( is_object( $cn ) ) { $classname_ .= '_' . get_class( $cn ); } } $classname_ = ltrim( $classname_, '_' ); $params[0]['before_widget'] = sprintf( $params[0]['before_widget'], $widget_id, $classname_ ); /** This filter is documented in wp-includes/widgets.php */ $params = apply_filters( 'dynamic_sidebar_params', $params ); $callback = $wp_registered_widgets[ $widget_id ]['callback']; ob_start(); /** This filter is documented in wp-includes/widgets.php */ do_action( 'dynamic_sidebar', $wp_registered_widgets[ $widget_id ] ); if ( is_callable( $callback ) ) { call_user_func_array( $callback, $params ); } return ob_get_clean(); } } if ( ! function_exists( 'wp_render_widget_control' ) ) { /** * Calls the control callback of a widget and returns the output. * * Can be removed when minimum WordPress version is 5.8. * * @since 10.2.0 * * @param string $id Widget ID. * @return string|null */ function wp_render_widget_control( $id ) { global $wp_registered_widget_controls; if ( ! isset( $wp_registered_widget_controls[ $id ]['callback'] ) ) { return null; } $callback = $wp_registered_widget_controls[ $id ]['callback']; $params = $wp_registered_widget_controls[ $id ]['params']; ob_start(); if ( is_callable( $callback ) ) { call_user_func_array( $callback, $params ); } return ob_get_clean(); } } if ( ! function_exists( 'gutenberg_get_widget_instance' ) ) { /** * Returns the instance settings of the given widget. Must be a widget that * is registered using WP_Widget. * * Belongs in WP_Widget when merged to Core. * * Can be removed when minimum WordPress version is 5.8. * * @since 10.2.0 * * @param string $id Widget ID. * @return array|null */ function gutenberg_get_widget_instance( $id ) { $parsed_id = wp_parse_widget_id( $id ); $widget_object = gutenberg_get_widget_object( $parsed_id['id_base'] ); if ( ! isset( $parsed_id['number'] ) || ! $widget_object ) { return null; } $all_instances = $widget_object->get_settings(); return $all_instances[ $parsed_id['number'] ]; } } if ( ! function_exists( 'gutenberg_get_widget_key' ) ) { /** * Returns the registered key for the given widget type. * * Belongs in WP_Widget_Factory when merged to Core. * * Can be removed when minimum WordPress version is 5.8. * * @since 10.3.0 * * @param string $id_base Widget type ID. * @return string */ function gutenberg_get_widget_key( $id_base ) { global $wp_widget_factory; foreach ( $wp_widget_factory->widgets as $key => $widget_object ) { if ( $widget_object->id_base === $id_base ) { return $key; } } return ''; } } if ( ! function_exists( 'gutenberg_get_widget_object' ) ) { /** * Returns the registered WP_Widget object for the given widget type. * * Belongs in WP_Widget_Factory when merged to Core. * * Can be removed when minimum WordPress version is 5.8. * * @since 10.2.0 * * @param string $id_base Widget type ID. * @return WP_Widget|null */ function gutenberg_get_widget_object( $id_base ) { global $wp_widget_factory; $key = gutenberg_get_widget_key( $id_base ); if ( ! $key ) { return null; } return $wp_widget_factory->widgets[ $key ]; } } ```