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

Refresh phpdoc for register_sidebar(). props jeremyfelt, SergeyBiryukov. fixes #22905. 

git-svn-id: http://core.svn.wordpress.org/trunk@23196 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Helen Hou-Sandí 2012-12-23 16:18:16 +00:00
parent eac55364bc
commit a3b736bdd2
1 changed files with 32 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
wp-includes/widgets.php
View File

@ -509,34 +509,45 @@ function register_sidebars($number = 1, $args = array()) {
/** /**
* Builds the definition for a single sidebar and returns the ID. * Builds the definition for a single sidebar and returns the ID.
* *
* The $args parameter takes either a string or an array with 'name' and 'id' * Accepts either a string or an array and then parses that against a set
* contained in either usage. It will be noted that the values will be applied * of default arguments for the new sidebar. WordPress will automatically
* to all sidebars, so if creating more than one, it will be advised to allow * generate a sidebar ID and name based on the current number of registered
* for WordPress to create the defaults for you. * sidebars if those arguments are not included.
* *
* Example for string would be <code>'name=whatever;id=whatever1'</code> and for * When allowing for automatic generation of the name and ID parameters, keep
* the array it would be <code>array( * in mind that the incrementor for your sidebar can change over time depending
* 'name' => 'whatever', * on what other plugins and themes are installed.
* 'id' => 'whatever1')</code>.
* *
* name - The name of the sidebar, which presumably the title which will be * If theme support for 'widgets' has not yet been added when this function is
* displayed. * called, it will be automatically enabled through the use of add_theme_support()
* id - The unique identifier by which the sidebar will be called by.
* before_widget - The content that will prepended to the widgets when they are
* displayed.
* after_widget - The content that will be appended to the widgets when they are
* displayed.
* before_title - The content that will be prepended to the title when displayed.
* after_title - the content that will be appended to the title when displayed.
* *
* <em>Content</em> is assumed to be HTML and should be formatted as such, but * Arguments passed as a string should be separated by '&'
* doesn't have to be. *
* e.g. 'name=Sidebar&id=my_prefix_sidebar'
*
* The same argument passed as an array:
*
* array(
* 'name' => 'Sidebar',
* 'id' => 'my_prefix_sidebar',
* )
*
* Arguments:
* name - The name or title of the sidebar displayed in the admin dashboard.
* id - The unique identifier by which the sidebar will be called.
* before_widget - HTML content that will be prepended to each widget's HTML output
* when assigned to this sidebar.
* after_widget - HTML content that will be appended to each widget's HTML output
* when assigned to this sidebar.
* before_title - HTML content that will be prepended to the sidebar title when displayed.
* after_title - HTML content that will be appended to the sidebar title when displayed.
* *
* @since 2.2.0 * @since 2.2.0
* @uses $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID. * @uses $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
* @uses add_theme_support() to ensure widget support has been added.
* *
* @param string|array $args Builds Sidebar based off of 'name' and 'id' values * @param string|array $args Arguments for the sidebar being registered.
* @return string The sidebar id that was added. * @return string Sidebar ID added to $wp_registered_sidebars global.
*/ */
function register_sidebar($args = array()) { function register_sidebar($args = array()) {
global $wp_registered_sidebars; global $wp_registered_sidebars;