sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clean up the documentation for dynamic_sidebar(). props johnbillion, fixes #24720. 

git-svn-id: https://develop.svn.wordpress.org/trunk@24982 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Andrew Nacin 2013-08-05 22:03:49 +00:00
parent 23d2b353d6
commit 1d27af8036
1 changed files with 4 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
wp-includes/widgets.php
View File

@ -833,20 +833,13 @@ function wp_unregister_widget_control($id) {
/** /**
* Display dynamic sidebar. * Display dynamic sidebar.
* *
* By default it displays the default sidebar or 'sidebar-1'. The 'sidebar-1' is * By default this displays the default sidebar or 'sidebar-1'. If your theme specifies the 'id' or
* not named by the theme, the actual name is '1', but 'sidebar-' is added to * 'name' parameter for its registered sidebars you can pass an id or name as the $index parameter.
* the registered sidebars for the name. If you named your sidebar 'after-post', * Otherwise, you can pass in a numerical index to display the sidebar at that index.
* then the parameter $index will still be 'after-post', but the lookup will be
* for 'sidebar-after-post'.
*
* It is confusing for the $index parameter, but just know that it should just
* work. When you register the sidebar in the theme, you will use the same name
* for this function or "Pay no heed to the man behind the curtain." Just accept
* it as an oddity of WordPress sidebar register and display.
* *
* @since 2.2.0 * @since 2.2.0
* *
* @param int|string $index Optional, default is 1. Name or ID of dynamic sidebar. * @param int|string $index Optional, default is 1. Index, name or ID of dynamic sidebar.
* @return bool True, if widget sidebar was found and called. False if not found or not called. * @return bool True, if widget sidebar was found and called. False if not found or not called.
*/ */
function dynamic_sidebar($index = 1) { function dynamic_sidebar($index = 1) {