Widgets are normally displayed as part of a sidebar using the dynamic_sidebar()
function. There is the_widget function for static widgets, but there is no
equivalent for specific widgets configured in the Appearance > Widgets area.
The Widget Instance plugin allows WordPress users of all abilities to display
these widgets outside of the sidebars they have been assigned to.
- A wysiwyg editor button for selecting available widgets,
- A shortcode [widget_instance id=”[widget_id]”],
- A theme action do_action(‘widget_instance’, [widget_id]) and finally
- Utility functions for developers get_widget_instance and widget_instance
- [widget_instance id=”[widget_id]”]
- do_action(‘widget_instance’, ‘[widget_id]’);
This section describes how to install the plugin and get it working.
- Activate the plugin through the ‘Plugins’ menu in WordPress
- Within the editor, you can use the Widget Instance editor button to select
from available widgets or enter a shortcode following the syntax: [widget_instance id=”[widget_id]”]
- Optional step: If you would like to retain the sidebar format of the widget, check the Include Sidebar format checkbox
- Within template files you can use the following php snippets:
- Action: do_action(‘widget_instance’, ‘[widget_id]’);
- Function: the_widget_instance(‘[widget_id]’);
- Function: get_the_widget_instance(‘[widget_id]’);
- How do I get the widget id?
Of course the editor button automagically retrieves all the available widgets
(and their ids) for you, but if you are using one of the PHP functions, you can
get the available widget ids by looping over the array returned by the function
Contributors & Developers
“Widget Instance” is open source software. The following people have contributed to this plugin.Contributors
- Tested in WordPress 4.9.7
- Included Immánuel Fodor’s fix for empty dropdown
- Tested in WordPress 4.2.2, new banner, icons and tinymce button created.
- Can now select a widget by it’s title as well as its id. The title is in parenthesis after the id.
- Tested on 3.5.1
- Fixed php warnign typo
- Tested on 3.4.1
- Added option for including sidebar formatting
- The widget’s title will now include the sidebar title markup (More useful than having a plain text title)
- Initial release