Changeset 10285

Timestamp:

12/31/2008 05:40:05 PM (16 years ago)

Author:

ryan

Message:

phpdoc for wp_dropdown_roles(). Add role_names_listing filter. Props jeremyclarke. fixes #8761

File:

• trunk/wp-admin/includes/template.php (modified) (1 diff)

trunk/wp-admin/includes/template.php

@@ -2587 +2587 @@
 }
 
-/**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $default
- */
-function wp_dropdown_roles( $default = false ) {
+ 
+/**
+ * Print out <option> html elements for role selectors based on $wp_roles
+ *
+ * @package WordPress
+ * @subpackage Administration
+ * @since 2.1
+ *
+ * @uses $wp_roles
+ * @param string $default slug for the role that should be already selected
+ */
+function wp_dropdown_roles( $selected = false ) {
     global $wp_roles;
     $p = '';
     $r = '';
-    foreach( $wp_roles->role_names as $role => $name ) {
+    
+    $role_names = $wp_roles->role_names;
+    $role_names = apply_filters('role_names_listing', $role_names);
+    
+    foreach( $role_names as $role => $name ) {
         $name = translate_with_context($name);
-        if ( $default == $role ) // Make default first in list
+        if ( $selected == $role ) // Make default first in list
             $p = "\n\t<option selected='selected' value='$role'>$name</option>";
         else