Changeset 12213 for trunk/wp-includes/widgets.php

Timestamp:

11/19/2009 09:12:16 AM (16 years ago)

Author:

azaozz

Message:

Add sidebar descriptions to sidebar settings and widget admin screen, props jeremyclarke scribu, fixes #11157

File:

• trunk/wp-includes/widgets.php (modified) (2 diffs)

trunk/wp-includes/widgets.php

@@ -545 +545 @@
         'name' => sprintf(__('Sidebar %d'), $i ),
         'id' => "sidebar-$i",
+        'description' => '',
         'before_widget' => '<li id="%1$s" class="widget %2$s">',
         'after_widget' => "</li>\n",
@@ -650 +651 @@
         return esc_html( $wp_registered_widgets[$id]['description'] );
 }
+
+/**
+ * Retrieve description for a sidebar.
+ *
+ * When registering sidebars a 'description' parameter can be included that
+ * describes the sidebar for display on the widget administration panel.
+ *
+ * @since 2.9.0
+ *
+ * @param int|string $id sidebar ID.
+ * @return string Sidebar description, if available. Null on failure to retrieve description.
+ */
+function wp_sidebar_description( $id ) {
+    if ( !is_scalar($id) )
+        return;
+
+    global $wp_registered_sidebars;
+
+    if ( isset($wp_registered_sidebars[$id]['description']) )
+        return esc_html( $wp_registered_sidebars[$id]['description'] );
+}
+
 
 /**