Changeset 7228 for trunk/bp-members/bp-members-functions.php
- Timestamp:
- 06/19/2013 09:41:08 PM (11 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/bp-members/bp-members-functions.php
r7163 r7228 121 121 * @package BuddyPress Core 122 122 * @global $current_user WordPress global variable containing current logged in user information 123 * @param user_id The ID of the user.123 * @param int $user_id The ID of the user. 124 124 */ 125 125 function bp_core_get_user_domain( $user_id, $user_nicename = false, $user_login = false ) { … … 151 151 * 152 152 * @package BuddyPress Core 153 * @param user_id The ID of the user.153 * @param int $user_id The ID of the user. 154 154 * @uses BP_Core_User::get_core_userdata() Performs the query. 155 155 */ … … 171 171 * @package BuddyPress Core 172 172 * @uses bp_core_get_userid_from_user_login() Returns the user id for the username passed 173 * @return The user id for the user that is currently being displayed, return zero if this is not a user home and just a normal blog.173 * @return int The user id for the user that is currently being displayed, return zero if this is not a user home and just a normal blog. 174 174 */ 175 175 function bp_core_get_displayed_userid( $user_login ) { … … 181 181 * 182 182 * @package BuddyPress Core 183 * @param $username strUsername to check.183 * @param string $username Username to check. 184 184 * @global $wpdb WordPress DB access object. 185 * @return false on no match 186 * @return int the user ID of the matched user. 185 * @return int|bool The ID of the matched user, or false. 187 186 */ 188 187 function bp_core_get_userid( $username ) { … … 199 198 * 200 199 * @package BuddyPress Core 201 * @param $username strUsername to check.200 * @param string $username Username to check. 202 201 * @global $wpdb WordPress DB access object. 203 * @return false on no match 204 * @return int the user ID of the matched user. 202 * @return int|bool The ID of the matched user, or false. 205 203 */ 206 204 function bp_core_get_userid_from_nicename( $user_nicename ) { … … 217 215 * 218 216 * @package BuddyPress Core 219 * @param $uid intUser ID to check.217 * @param int $uid User ID to check. 220 218 * @global $userdata WordPress user data for the current logged in user. 221 219 * @uses get_userdata() WordPress function to fetch the userdata for a user ID 222 * @return false on no match 223 * @return str the username of the matched user. 220 * @return string|bool The username of the matched user, or false. 224 221 */ 225 222 function bp_core_get_username( $user_id, $user_nicename = false, $user_login = false ) { … … 291 288 * 292 289 * @package BuddyPress Core 293 * @param $uid intUser ID to check.290 * @param int $uid User ID to check. 294 291 * @global $userdata WordPress user data for the current logged in user. 295 292 * @uses get_userdata() WordPress function to fetch the userdata for a user ID 296 * @return false on no match 297 * @return str the username of the matched user. 293 * @return string|bool The username of the matched user, or false. 298 294 */ 299 295 function bp_members_get_user_nicename( $user_id ) { … … 344 340 * 345 341 * @package BuddyPress Core 346 * @param $uid intUser ID to check.342 * @param int $uid User ID to check. 347 343 * @uses get_userdata() WordPress function to fetch the userdata for a user ID 348 * @return false on no match 349 * @return str The email for the matched user. 344 * @return string The email for the matched user. Empty string if no user matched the $uid. 350 345 */ 351 346 function bp_core_get_user_email( $uid ) { … … 372 367 * 373 368 * @param int $user_id User ID to check. 374 * @param $no_anchor bool Disable URL and HTML and just return full name. Default false. 375 * @param $just_link bool Disable full name and HTML and just return the URL text. Default false. 376 * @return false on no match 377 * @return str The link text based on passed parameters. 369 * @param bool $no_anchor Disable URL and HTML and just return full name. Default false. 370 * @param bool $just_link Disable full name and HTML and just return the URL text. Default false. 371 * @return string|bool The link text based on passed parameters, or false on no match. 378 372 * @todo This function needs to be cleaned up or split into separate functions 379 373 */ … … 407 401 * @uses xprofile_set_field_data() Will update the field data for a user based on field name and user id. 408 402 * @uses wp_cache_set() Adds a value to the cache. 409 * @return str The display name for the user in question.403 * @return string|bool The display name for the user in question, or false if user not found. 410 404 */ 411 405 function bp_core_get_user_displayname( $user_id_or_username ) { … … 463 457 * 464 458 * @package BuddyPress Core 465 * @param $email strThe email address for the user.459 * @param string $email The email address for the user. 466 460 * @uses bp_core_get_userlink() BuddyPress function to get a userlink by user ID. 467 461 * @uses get_user_by() WordPress function to get userdata via an email address 468 * @return str The link to the users home base. False on no match.462 * @return string The link to the users home base. False on no match. 469 463 */ 470 464 function bp_core_get_userlink_by_email( $email ) { … … 476 470 * Returns the user link for the user based on the supplied identifier 477 471 * 478 * @param $username strIf BP_ENABLE_USERNAME_COMPATIBILITY_MODE is set, this will be user_login, otherwise it will be user_nicename.479 * @return str The link to the users home base. False on no match.472 * @param string $username If BP_ENABLE_USERNAME_COMPATIBILITY_MODE is set, this will be user_login, otherwise it will be user_nicename. 473 * @return string|bool The link to the users home base, false on no match. 480 474 */ 481 475 function bp_core_get_userlink_by_username( $username ) { … … 918 912 * redirect them to the home page and stop them from logging in. 919 913 * 920 * @param obj$user Either the WP_User object or the WP_Error object921 * @return objIf the user is not a spammer, return the WP_User object. Otherwise a new WP_Error object.914 * @param WP_User|WP_Error $user Either the WP_User object or the WP_Error object 915 * @return WP_User|WP_Error If the user is not a spammer, return the WP_User object. Otherwise a new WP_Error object. 922 916 * 923 917 * @since BuddyPress (1.1.2) … … 942 936 * 943 937 * @package BuddyPress Core 944 * @param $user_id The user id for the user to delete usermeta for938 * @param int $user_id The user id for the user to delete usermeta for 945 939 * @uses bp_delete_user_meta() deletes a row from the wp_usermeta table based on meta_key 946 940 */ … … 1099 1093 * @see bp_core_validate_email_address() 1100 1094 * 1101 * @param obj$errors WP_Error object1095 * @param WP_Error $errors WP_Error object 1102 1096 * @param array $validation_results The return value of a validation function 1103 1097 * like bp_core_validate_email_address() … … 1414 1408 * See {@link wpmu_signup_user()} and {@link wpmu_validate_user_signup()}. 1415 1409 * 1416 * @param obj$user Either the WP_User object or the WP_Error object1417 * @return objIf the user is not a spammer, return the WP_User object. Otherwise a new WP_Error object.1410 * @param WP_User|WP_Error $user Either the WP_User object or the WP_Error object 1411 * @return WP_User|WP_Error If the user is not a spammer, return the WP_User object. Otherwise a new WP_Error object. 1418 1412 * 1419 1413 * @since BuddyPress (1.2.2)
Note: See TracChangeset
for help on using the changeset viewer.