WP_Widget_Factory::get_widget_key() WordPress Method

The WP_Widget_Factory::get_widget_key() is a Wordpress method that allows you to retrieve the widget key for a given widget. This can be useful if you need to programmatically access a widget's settings.

WP_Widget_Factory::get_widget_key( string $id_base ) #

Returns the registered key for the given widget type.


Parameters

$id_base

(string)(Required)Widget type ID.


Top ↑

Return

(string)


Top ↑

Source

File: wp-includes/class-wp-widget-factory.php

	public function get_widget_key( $id_base ) {
		foreach ( $this->widgets as $key => $widget_object ) {
			if ( $widget_object->id_base === $id_base ) {
				return $key;
			}
		}

		return '';
	}


Top ↑

Changelog

Changelog
VersionDescription
5.8.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.