Changeset 7228 for trunk/bp-xprofile/bp-xprofile-functions.php

Timestamp:

06/19/2013 09:41:08 PM (12 years ago)

Author:

djpaul

Message:

Quick audit of existing phpDoc @param, @return, and @since parameters. Fixes #5031

File:

• trunk/bp-xprofile/bp-xprofile-functions.php (modified) (7 diffs)

trunk/bp-xprofile/bp-xprofile-functions.php

@@ -195 +195 @@
  *
  * @package BuddyPress Core
- * @param $field The ID of the field, or the $name of the field.
- * @param $user_id The ID of the user
- * @param $value The value for the field you want to set for the user.
+ * @param int|string $field The ID of the field, or the $name of the field.
+ * @param int|$user_id The ID of the user
+ * @param mixed The value for the field you want to set for the user.
  * @global BuddyPress $bp The one true BuddyPress instance
  * @uses xprofile_get_field_id_from_name() Gets the ID for the field based on the name.
- * @return true on success, false on failure.
+ * @return bool True on success, false on failure.
  */
 function xprofile_set_field_data( $field, $user_id, $value, $is_required = false ) {
@@ -322 +322 @@
  *
  * @package BuddyPress Core
- * @param $field_name The name of the field to get the ID for.
+ * @param string $field_name The name of the field to get the ID for.
  * @return int $field_id on success, false on failure.
  */
@@ -333 +333 @@
  *
  * @package BuddyPress Core
- * @param $user_id User ID of the user to get random data for
- * @param $exclude_fullname whether or not to exclude the full name field as random data.
+ * @param int $user_id User ID of the user to get random data for
+ * @param bool $exclude_fullname Optional; whether or not to exclude the full name field as random data. Defaults to true.
  * @global BuddyPress $bp The one true BuddyPress instance
  * @global $wpdb WordPress DB access object.
  * @global $current_user WordPress global variable containing current logged in user information
  * @uses xprofile_format_profile_field() Formats profile field data so it is suitable for display.
- * @return $field_data The fetched random data for the user.
+ * @return string|bool The fetched random data for the user, or false if no data or no match.
  */
 function xprofile_get_random_profile_data( $user_id, $exclude_fullname = true ) {
@@ -359 +359 @@
  *
  * @package BuddyPress Core
- * @param $field_type The type of field: datebox, selectbox, textbox etc
- * @param $field_value The actual value
+ * @param string $field_type The type of field: datebox, selectbox, textbox etc
+ * @param string $field_value The actual value
  * @uses bp_format_time() Formats a time value based on the WordPress date format setting
- * @return $field_value The formatted value
+ * @return string|bool The formatted value, or false if value is empty
  */
 function xprofile_format_profile_field( $field_type, $field_value ) {
@@ -388 +388 @@
  *
  * @package BuddyPress Core
- * @param $directory The root directory name
- * @param $user_id The user ID.
+ * @param string $directory The root directory name. Optional.
+ * @param int $user_id The user ID. Optional.
  * @return array() containing the path and URL plus some other settings.
  */
@@ -485 +485 @@
  *
  * @package BuddyPress XProfile
- * @param $user_id The ID of the deleted user
+ * @param int $user_id The ID of the deleted user
  */
 function xprofile_remove_data( $user_id ) {
@@ -630 +630 @@
  * @since BuddyPress (1.5)
  *
- * @return str The field name
+ * @return string The field name
  */
 function bp_xprofile_fullname_field_name() {