Changeset 15590 for trunk/wp-admin/includes/template.php

Timestamp:

09/07/2010 11:21:11 AM (15 years ago)

Author:

nacin

Message:

Phpdoc argument/@param cleanups. props duck_, see #14783.

File:

• trunk/wp-admin/includes/template.php (modified) (4 diffs)

trunk/wp-admin/includes/template.php

@@ -713 +713 @@
 
 /**
- * Print out <option> html elements for role selectors based on $wp_roles
- *
- * @package WordPress
- * @subpackage Administration
+ * Print out <option> html elements for role selectors
+ *
  * @since 2.1
  *
- * @uses $wp_roles
- * @param string $default slug for the role that should be already selected
+ * @param string $selected slug for the role that should be already selected
  */
 function wp_dropdown_roles( $selected = false ) {
@@ -730 +727 @@
     foreach ( $editable_roles as $role => $details ) {
         $name = translate_user_role($details['name'] );
-        if ( $selected == $role ) // Make default first in list
+        if ( $selected == $role ) // preselect specified role
             $p = "\n\t<option selected='selected' value='" . esc_attr($role) . "'>$name</option>";
         else
@@ -1269 +1266 @@
  * @param boolean $sanitize Whether to re-sanitize the setting value before returning errors.
  * @param boolean $hide_on_update If set to true errors will not be shown if the settings page has already been submitted.
- * @return <type>
- */
-function settings_errors ( $setting = '', $sanitize = FALSE, $hide_on_update = FALSE ) {
+ */
+function settings_errors( $setting = '', $sanitize = FALSE, $hide_on_update = FALSE ) {
 
     if ($hide_on_update AND $_GET['updated']) return;
@@ -1494 +1490 @@
  *
  * @since 2.7.0
- * @param int $id The post id. If not supplied the global $post is used.
- *
- */
-function _draft_or_post_title($post_id = 0) {
+ * @param int $post_id The post id. If not supplied the global $post is used.
+ * @return string The post title if set
+ */
+function _draft_or_post_title( $post_id = 0 ) {
     $title = get_the_title($post_id);
     if ( empty($title) )