Changeset 9877
- Timestamp:
- 05/19/2015 01:40:26 AM (9 years ago)
- Location:
- trunk/src/bp-members
- Files:
-
- 13 edited
-
admin/bp-members-admin-classes.php (modified) (15 diffs)
-
bp-members-actions.php (modified) (1 diff)
-
bp-members-activity.php (modified) (3 diffs)
-
bp-members-admin.php (modified) (18 diffs)
-
bp-members-adminbar.php (modified) (1 diff)
-
bp-members-classes.php (modified) (1 diff)
-
bp-members-filters.php (modified) (4 diffs)
-
bp-members-functions.php (modified) (48 diffs)
-
bp-members-loader.php (modified) (4 diffs)
-
bp-members-screens.php (modified) (5 diffs)
-
bp-members-template.php (modified) (26 diffs)
-
bp-members-widgets.php (modified) (11 diffs)
-
classes/class-bp-signup.php (modified) (10 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/bp-members/admin/bp-members-admin-classes.php
r9819 r9877 110 110 * 111 111 * @since BuddyPress (2.0.0) 112 * 113 * @param array $which 112 114 */ 113 115 public function extra_tablenav( $which ) { … … 116 118 117 119 /** 118 * Specific signups columns 120 * Specific signups columns. 119 121 * 120 122 * @since BuddyPress (2.0.0) … … 216 218 * 217 219 * @see WP_List_Table::single_row() for explanation of params. 220 * 221 * @param object|null $signup_object Signup user object. 222 * @param string $style Styles for the row. 223 * @param string $role Role to be assigned to user. 224 * @param int $numposts Numper of posts. 225 * 226 * @return string 218 227 */ 219 228 public function single_row( $signup_object = null, $style = '', $role = '', $numposts = 0 ) { … … 349 358 * 350 359 * @since BuddyPress (2.0.0) 360 * 361 * @param object $signup_object Signup object instance. 362 * 363 * @return int 351 364 */ 352 365 public function column_count_sent( $signup_object = null ) { … … 359 372 * @since BuddyPress (2.1.0) 360 373 * 361 * @param object $signup_object The signup data object. 362 * @param string the column name. 374 * @param object|null $signup_object The signup data object. 375 * @param string $column_name The column name. 376 * 377 * @return string 363 378 */ 364 379 function column_default( $signup_object = null, $column_name = '' ) { … … 458 473 * @since BuddyPress (2.0.0) 459 474 * 460 * @uses WP_MS_Users_List_Table::get_views() to get the users views 475 * @uses WP_MS_Users_List_Table::get_views() to get the users views. 461 476 */ 462 477 public function get_views() { … … 471 486 472 487 /** 473 * Specific signups columns 488 * Specific signups columns. 474 489 * 475 490 * @since BuddyPress (2.0.0) … … 496 511 497 512 /** 498 * Specific bulk actions for signups 513 * Specific bulk actions for signups. 499 514 * 500 515 * @since BuddyPress (2.0.0) … … 535 550 536 551 /** 537 * The columns signups can be reordered with 552 * The columns signups can be reordered with. 538 553 * 539 554 * @since BuddyPress (2.0.0) … … 566 581 * 567 582 * @see WP_List_Table::single_row() for explanation of params. 583 * 584 * @param object|null $signup_object Signup user object. 585 * @param string $style Styles for the row. 568 586 */ 569 587 public function single_row( $signup_object = null, $style = '' ) { … … 578 596 * @since BuddyPress (2.0.0) 579 597 * 580 * @param object $signup_object The signup data object.598 * @param object|null $signup_object The signup data object. 581 599 */ 582 600 public function column_cb( $signup_object = null ) { … … 667 685 668 686 /** 669 * Display registration date 687 * Display registration date. 670 688 * 671 689 * @since BuddyPress (2.0.0) … … 689 707 * 690 708 * @since BuddyPress (2.0.0) 709 * 710 * @param object|null $signup_object Signup object instance. 691 711 */ 692 712 public function column_date_sent( $signup_object = null ) { … … 706 726 * 707 727 * @since BuddyPress (2.0.0) 728 * 729 * @param object|null $signup_object Signup object instance. 708 730 */ 709 731 public function column_count_sent( $signup_object = null ) { … … 716 738 * @since BuddyPress 2.1.0 717 739 * 718 * @param object $signup_object The signup data object. 719 * @param string the column name. 740 * @param object|null $signup_object The signup data object. 741 * @param string $column_name The column name. 742 * 743 * @return string 720 744 */ 721 745 function column_default( $signup_object = null, $column_name = '' ) { -
trunk/src/bp-members/bp-members-actions.php
r9819 r9877 24 24 * Note: no longer used in the current state. See the Settings component. 25 25 * 26 * @param int $user_id Optional. User ID to mark as spam. Defaults to displayed 27 * user. 26 * @param int $user_id Optional. User ID to mark as spam. Defaults to displayed user. 28 27 */ 29 28 function bp_core_action_set_spammer_status( $user_id = 0 ) { -
trunk/src/bp-members/bp-members-activity.php
r9819 r9877 12 12 13 13 /** 14 * Register the 'new member' activity type 14 * Register the 'new member' activity type. 15 15 * 16 * @since 16 * @since BuddyPress (2.2.0) 17 17 * 18 18 * @uses bp_activity_set_action() … … 44 44 * @since BuddyPress (2.2.0) 45 45 * 46 * @param string $action Static activity action.46 * @param string $action Static activity action. 47 47 * @param object $activity Activity object. 48 * 48 49 * @return string 49 50 */ … … 72 73 * 73 74 * @param array $user Array of userdata passed to bp_core_activated_user hook. 75 * 76 * @return bool 74 77 */ 75 78 function bp_core_new_user_activity( $user ) { -
trunk/src/bp-members/bp-members-admin.php
r9819 r9877 208 208 209 209 /** 210 * Get the user ID 210 * Get the user ID. 211 211 * 212 212 * Look for $_GET['user_id']. If anything else, force the user ID to the … … 233 233 234 234 /** 235 * Can the current user edit the one displayed 235 * Can the current user edit the one displayed. 236 236 * 237 237 * self profile editing / or bp_moderate check. … … 241 241 * @access public 242 242 * @since BuddyPress (2.1.0) 243 * 244 * @param int $user_id ID of the user being checked for edit ability. 245 * 246 * @return bool 243 247 */ 244 248 private function member_can_edit( $user_id = 0 ) { … … 263 267 264 268 /** 265 * Get admin notice when saving a user or member profile 269 * Get admin notice when saving a user or member profile. 266 270 * 267 271 * @since BuddyPress (2.1.0) … … 464 468 465 469 /** 466 * Highlight the Users menu if on Edit Profile. 467 * 468 * + Check if on the user's admin profile 470 * Highlight the Users menu if on Edit Profile and check if on the user's admin profile. 469 471 * 470 472 * @access public … … 599 601 * @access public 600 602 * @since BuddyPress (2.0.0) 603 * 604 * @param object|null $user User to create profile navigation for. 605 * @param string $active Which profile to highlight. 606 * 607 * @return string 601 608 */ 602 609 public function profile_nav( $user = null, $active = 'WordPress' ) { … … 1152 1159 * @since BuddyPress (2.0.0) 1153 1160 * 1154 * @param array $actions WordPress row actions (edit, delete). 1155 * @param object $user The object for the user row. 1161 * @param array|string $actions WordPress row actions (edit, delete). 1162 * @param object $user The object for the user row. 1163 * 1156 1164 * @return array Merged actions. 1157 1165 */ … … 1206 1214 1207 1215 /** 1208 * Add a filter to edit profile url in WP Admin Bar 1216 * Add a filter to edit profile url in WP Admin Bar. 1209 1217 * 1210 1218 * @access public … … 1216 1224 1217 1225 /** 1218 * Filter the profile url 1226 * Filter the profile url. 1219 1227 * 1220 1228 * @access public … … 1222 1230 * 1223 1231 * @uses user_admin_url() 1232 * 1233 * @param string $profile_link Profile Link for admin bar. 1234 * @param string $url Profile URL. 1235 * @param int $user_id User ID. 1236 * 1237 * @return string 1224 1238 */ 1225 1239 public function filter_adminbar_profile_link( $profile_link = '', $url = '', $user_id = 0 ) { … … 1231 1245 1232 1246 /** 1233 * Remove the filter to edit profile url in WP Admin Bar 1247 * Remove the filter to edit profile url in WP Admin Bar. 1234 1248 * 1235 1249 * @access public … … 1248 1262 * @since BuddyPress (2.0.0) 1249 1263 * 1250 * @param int $value 1251 * @param string $option 1252 * @param int $new_value 1253 * @return int the pagination preferences 1264 * @param int $value 1265 * @param string $option 1266 * @param int $new_value 1267 * 1268 * @return int The pagination preferences. 1254 1269 */ 1255 1270 public function signup_screen_options( $value = 0, $option = '', $new_value = 0 ) { … … 1275 1290 * @since BuddyPress (2.0.0) 1276 1291 * 1277 * @param WP_User_Query $query The users query. 1292 * @param WP_User_Query $query The users query. 1293 * 1278 1294 * @return WP_User_Query The users query without the signups. 1279 1295 */ … … 1317 1333 * @since BuddyPress (2.0.0) 1318 1334 * 1319 * @param array $views WP List Table views. 1335 * @param array $views WP List Table views. 1336 * 1320 1337 * @return array The views with the signup view added. 1321 1338 */ … … 1344 1361 * @since BuddyPress (2.0.0) 1345 1362 * 1346 * @param string $class The name of the class to use. 1347 * @param string $required The parent class. 1363 * @param string $class The name of the class to use. 1364 * @param string $required The parent class. 1365 * 1348 1366 * @return WP_List_Table The List table. 1349 1367 */ … … 1569 1587 1570 1588 /** 1571 * Get admin notice when viewing the sign-up page 1589 * Get admin notice when viewing the sign-up page. 1572 1590 * 1573 1591 * @since BuddyPress (2.1.0) … … 1720 1738 * 1721 1739 * Depending on the context, display 1722 * - the list of signups 1723 * - or the delete confirmation screen 1724 * - or the activate confirmation screen 1725 * - or the "resend" email confirmation screen 1740 * - the list of signups, 1741 * - or the delete confirmation screen, 1742 * - or the activate confirmation screen, 1743 * - or the "resend" email confirmation screen. 1726 1744 * 1727 1745 * Also prepare the admin notices. … … 1864 1882 * 1865 1883 * @param string $action Delete, activate, or resend activation link. 1884 * 1885 * @return string 1866 1886 */ 1867 1887 public function signups_admin_manage( $action = '' ) { -
trunk/src/bp-members/bp-members-adminbar.php
r9819 r9877 2 2 3 3 /** 4 * BuddyPress Members Toolbar 4 * BuddyPress Members Toolbar. 5 5 * 6 6 * Handles the member functions related to the WordPress Toolbar. -
trunk/src/bp-members/bp-members-classes.php
r9819 r9877 1 1 <?php 2 2 /** 3 * BuddyPress Members Classes 3 * BuddyPress Members Classes. 4 4 * 5 5 * @package BuddyPress -
trunk/src/bp-members/bp-members-filters.php
r9819 r9877 2 2 3 3 /** 4 * BuddyPress Members Filters 4 * BuddyPress Members Filters. 5 5 * 6 6 * Filters specific to the Members component. … … 58 58 59 59 /** 60 * Make sure the username is not the blog slug in case of root profile & subdirectory blog 60 * Make sure the username is not the blog slug in case of root profile & subdirectory blog. 61 61 * 62 62 * If BP_ENABLE_ROOT_PROFILES is defined & multisite config is set to subdirectories, … … 65 65 * is not the same than the blog slug for this particular config. 66 66 * 67 * @since BuddyPress (2.1.0) 68 * @param array $illegal_names 67 * @since BuddyPress (2.1.0) 68 * 69 * @param array $illegal_names 70 * 69 71 * @return array $illegal_names 70 72 */ … … 99 101 * @since BuddyPress (1.6.0) 100 102 * 101 * @param string $url WP profile edit URL.102 * @param int $user_id ID of the user.103 * @param string $url WP profile edit URL. 104 * @param int $user_id ID of the user. 103 105 * @param string $scheme 106 * 104 107 * @return string 105 108 */ -
trunk/src/bp-members/bp-members-functions.php
r9819 r9877 2 2 3 3 /** 4 * BuddyPress Member Functions 4 * BuddyPress Member Functions. 5 5 * 6 6 * Functions specific to the members component. … … 76 76 * bp_use_legacy_user_query value, returning true. 77 77 * 78 * @param array $args {78 * @param array|string $args { 79 79 * Array of arguments. All are optional. See {@link BP_User_Query} for 80 80 * a more complete description of arguments. … … 86 86 * @type string $meta_value Limit to users with a meta_value (with meta_key). Default: false. 87 87 * @type array|string $member_type Array or comma-separated string of member types. 88 * @type mixed $includeLimit results by user IDs. Default: false.88 * @type mixed $include Limit results by user IDs. Default: false. 89 89 * @type int $per_page Results per page. Default: 20. 90 90 * @type int $page Page of results. Default: 1. … … 154 154 * Return the domain for the passed user: e.g. http://example.com/members/andy/. 155 155 * 156 * @param int $user_id The ID of the user. 157 * @param string $user_nicename Optional. user_nicename of the user. 158 * @param string $user_login Optional. user_login of the user. 156 * @param int $user_id The ID of the user. 157 * @param string|bool $user_nicename Optional. user_nicename of the user. 158 * @param string|bool $user_login Optional. user_login of the user. 159 * 160 * @return string 159 161 */ 160 162 function bp_core_get_user_domain( $user_id = 0, $user_nicename = false, $user_login = false ) { … … 194 196 * 195 197 * @param int $user_id The ID of the user. 198 * 196 199 * @return array 197 200 */ … … 224 227 * 225 228 * @param string $user_login user_login of the user being queried. 229 * 226 230 * @return int 227 231 */ … … 236 240 * 237 241 * @param string $username user_login to check. 242 * 238 243 * @return int|null The ID of the matched user on success, null on failure. 239 244 */ … … 262 267 * 263 268 * @param string $user_nicename user_nicename to check. 269 * 264 270 * @return int|null The ID of the matched user on success, null on failure. 265 271 */ … … 288 294 * so it will return the user_login or user_nicename as appropriate. 289 295 * 290 * @param int $user_id User ID to check. 291 * @param string $user_nicename Optional. user_nicename of user being checked. 292 * @param string $user_login Optional. user_login of user being checked. 296 * @param int $user_id User ID to check. 297 * @param string|bool $user_nicename Optional. user_nicename of user being checked. 298 * @param string|bool $user_login Optional. user_login of user being checked. 299 * 293 300 * @return string|bool The username of the matched user, or false. 294 301 */ … … 374 381 * 375 382 * @param int $user_id User ID to check. 383 * 376 384 * @return string|bool The username of the matched user, or false. 377 385 */ … … 431 439 * 432 440 * @param int $uid User ID to check. 441 * 433 442 * @return string The email for the matched user. Empty string if no user 434 * matched the $uid.443 * matched the $uid. 435 444 */ 436 445 function bp_core_get_user_email( $uid ) { … … 468 477 * Optional parameters will return just the name or just the URL. 469 478 * 470 * @param int $user_idUser ID to check.479 * @param int $user_id User ID to check. 471 480 * @param bool $no_anchor Disable URL and HTML and just return full name. 472 * Default: false.481 * Default: false. 473 482 * @param bool $just_link Disable full name and HTML and just return the URL 474 * text. Default false. 483 * text. Default false. 484 * 475 485 * @return string|bool The link text based on passed parameters, or false on 476 * no match.486 * no match. 477 487 */ 478 488 function bp_core_get_userlink( $user_id, $no_anchor = false, $just_link = false ) { … … 515 525 * 516 526 * @param array $user_ids 527 * 528 * @return array 517 529 */ 518 530 function bp_core_get_user_displaynames( $user_ids ) { … … 593 605 * 594 606 * @param int|string $user_id_or_username User ID or username. 607 * 595 608 * @return string|bool The display name for the user in question, or false if 596 * user not found.609 * user not found. 597 610 */ 598 611 function bp_core_get_user_displayname( $user_id_or_username ) { … … 638 651 * 639 652 * @param string $email The email address for the user. 653 * 640 654 * @return string The link to the users home base. False on no match. 641 655 */ … … 657 671 * 658 672 * @param string $username If BP_ENABLE_USERNAME_COMPATIBILITY_MODE is set, 659 * this should be user_login, otherwise it should be user_nicename. 673 * this should be user_login, otherwise it should 674 * be user_nicename. 675 * 660 676 * @return string|bool The link to the user's domain, false on no match. 661 677 */ … … 708 724 709 725 /** 710 * Return the total number of members, limited to those members with last_activity 711 * 712 * @return int The number of active members 726 * Return the total number of members, limited to those members with last_activity. 727 * 728 * @return int The number of active members. 713 729 */ 714 730 function bp_core_get_active_member_count() { … … 754 770 * @since BuddyPress (1.6.0) 755 771 * 756 * @param int $user_id The ID of the user being spammed/hammed. 757 * @param string $status 'spam' if being marked as spam, 'ham' otherwise. 758 * @param bool $do_wp_cleanup True to force the cleanup of WordPress content 759 * and status, otherwise false. Generally, this should only be false if 760 * WordPress is expected to have performed this cleanup independently, 761 * as when hooked to 'make_spam_user'. 772 * @param int $user_id The ID of the user being spammed/hammed. 773 * @param string $status 'spam' if being marked as spam, 'ham' otherwise. 774 * @param bool $do_wp_cleanup True to force the cleanup of WordPress content 775 * and status, otherwise false. Generally, this should 776 * only be false if WordPress is expected to have 777 * performed this cleanup independently, as when hooked 778 * to 'make_spam_user'. 779 * 762 780 * @return bool True on success, false on failure. 763 781 */ … … 884 902 return true; 885 903 } 886 887 904 /** 888 905 * Hook to WP's make_spam_user and run our custom BP spam functions. … … 913 930 * 914 931 * @param int $user_id The ID for the user. 932 * 915 933 * @return bool True if spammer, otherwise false. 916 934 */ … … 977 995 * 978 996 * @param int $user_id The ID for the user. 997 * 979 998 * @return bool True if deleted, otherwise false. 980 999 */ … … 1048 1067 * 1049 1068 * @param int $user_id The user ID to check. 1069 * 1050 1070 * @return bool True if active, otherwise false. 1051 1071 */ … … 1084 1104 * bp_is_user_active(). 1085 1105 * 1086 * @uses is_user_logged_in() To check if user is logged in 1087 * @uses bp_get_displayed_user_id() To get current user ID 1088 * @uses bp_is_user_active() To check if user is active 1106 * @uses is_user_logged_in() To check if user is logged in. 1107 * @uses bp_get_displayed_user_id() To get current user ID. 1108 * @uses bp_is_user_active() To check if user is active. 1089 1109 * 1090 1110 * @param int $user_id The user ID to check. 1111 * 1091 1112 * @return bool True if inactive, otherwise false. 1092 1113 */ … … 1112 1133 * @since BuddyPress (1.9.0) 1113 1134 * 1114 * @param int $user_id ID of the user being updated. 1115 * @param string $time Time of last activity, in 'Y-m-d H:i:s' format. 1135 * @param int $user_id ID of the user being updated. 1136 * @param string $time Time of last activity, in 'Y-m-d H:i:s' format. 1137 * 1116 1138 * @return bool True on success, false on failure. 1117 1139 */ … … 1157 1179 * @access private For internal use only. 1158 1180 * 1159 * @param null $retval 1160 * @param int $object_id ID of the user. 1161 * @param string $meta_key Meta key being fetched. 1181 * @param null $retval 1182 * @param int $object_id ID of the user. 1183 * @param string $meta_key Meta key being fetched. 1184 * 1185 * @return mixed 1162 1186 */ 1163 1187 function _bp_get_user_meta_last_activity_warning( $retval, $object_id, $meta_key ) { … … 1190 1214 * @access private For internal use only. 1191 1215 * 1192 * @param int $meta_idID of the just-set usermeta row.1193 * @param int $object_idID of the user.1194 * @param string $meta_key Meta key being fetched.1216 * @param int $meta_id ID of the just-set usermeta row. 1217 * @param int $object_id ID of the user. 1218 * @param string $meta_key Meta key being fetched. 1195 1219 * @param string $meta_value Active time. 1196 1220 */ … … 1207 1231 * 1208 1232 * @param int $user_id The ID of the user. 1233 * 1209 1234 * @return string Time of last activity, in 'Y-m-d H:i:s' format, or an empty 1210 * string if none is found.1235 * string if none is found. 1211 1236 */ 1212 1237 function bp_get_user_last_activity( $user_id = 0 ) { … … 1266 1291 * 1267 1292 * @param int $user_id ID of the user being queried. 1293 * 1268 1294 * @return array Post IDs. 1269 1295 */ … … 1284 1310 * 1285 1311 * @param int $user_id Optional. ID of the user to be deleted. Default: the 1286 * logged-in user.1312 * logged-in user. 1287 1313 * @return bool True on success, false on failure. 1288 1314 */ … … 1353 1379 * 1354 1380 * @param int $user_id ID of the user who is about to be deleted. 1381 * 1355 1382 * @return bool True on success, false on failure. 1356 1383 */ … … 1370 1397 * 1371 1398 * @param string $str String to be upper-cased. 1399 * 1372 1400 * @return string 1373 1401 */ … … 1390 1418 * 1391 1419 * @param WP_User|WP_Error $user Either the WP_User object or the WP_Error 1392 * object, as passed to the 'authenticate' filter. 1420 * object, as passed to the 'authenticate' filter. 1421 * 1393 1422 * @return WP_User|WP_Error If the user is not a spammer, return the WP_User 1394 * object. Otherwise a new WP_Error object.1423 * object. Otherwise a new WP_Error object. 1395 1424 */ 1396 1425 function bp_core_boot_spammer( $user ) { … … 1463 1492 * Add BuddyPress-specific items to the illegal_names array. 1464 1493 * 1465 * @param array|string $value Illegal names as being saved defined in1466 * Multisite settings.1494 * @param array|string $value Illegal names as being saved defined in 1495 * Multisite settings. 1467 1496 * @param array|string $oldvalue The old value of the option. 1497 * 1468 1498 * @return array Merged and unique array of illegal names. 1469 1499 */ … … 1555 1585 * @since BuddyPress (1.6.2) 1556 1586 * 1557 * @param string $user_email The email being checked 1587 * @param string $user_email The email being checked. 1588 * 1558 1589 * @return bool|array True if the address passes all checks; otherwise an array 1559 * of error codes.1590 * of error codes. 1560 1591 */ 1561 1592 function bp_core_validate_email_address( $user_email ) { … … 1606 1637 * @see bp_core_validate_email_address() 1607 1638 * 1608 * @param WP_Error $errors WP_Error object.1609 * @param array $validation_results The return value of a validation function1610 * like bp_core_validate_email_address().1639 * @param WP_Error $errors WP_Error object. 1640 * @param array $validation_results The return value of a validation function 1641 * like bp_core_validate_email_address(). 1611 1642 */ 1612 1643 function bp_core_add_validation_error_messages( WP_Error $errors, $validation_results ) { … … 1631 1662 * Validate a user name and email address when creating a new user. 1632 1663 * 1633 * @param string $user_name Username to validate.1664 * @param string $user_name Username to validate. 1634 1665 * @param string $user_email Email address to validate. 1666 * 1635 1667 * @return array Results of user validation including errors, if any. 1636 1668 */ … … 1736 1768 * @todo Why do we have this wrapper? 1737 1769 * 1738 * @param string $blog_url Blog URL requested during registration.1770 * @param string $blog_url Blog URL requested during registration. 1739 1771 * @param string $blog_title Blog title requested during registration. 1772 * 1740 1773 * @return array 1741 1774 */ … … 1760 1793 * @todo There appears to be a bug in the return value on success. 1761 1794 * 1762 * @param string $user_login Login name requested by the user.1795 * @param string $user_login Login name requested by the user. 1763 1796 * @param string $user_password Password requested by the user. 1764 * @param string $user_email Email address entered by the user. 1765 * @param array $usermeta Miscellaneous metadata about the user (blog-specific 1766 * signup data, xprofile data, etc). 1797 * @param string $user_email Email address entered by the user. 1798 * @param array $usermeta Miscellaneous metadata about the user (blog-specific 1799 * signup data, xprofile data, etc). 1800 * 1767 1801 * @return bool|WP_Error True on success, WP_Error on failure. 1768 1802 */ … … 1856 1890 * 1857 1891 * @param string $blog_domain Domain requested by user. 1858 * @param string $blog_path Path requested by user. 1859 * @param string $blog_title Title as entered by user. 1860 * @param string $user_name user_login of requesting user. 1861 * @param string $user_email Email address of requesting user. 1862 * @param string $usermeta Miscellaneous metadata for the user. 1892 * @param string $blog_path Path requested by user. 1893 * @param string $blog_title Title as entered by user. 1894 * @param string $user_name user_login of requesting user. 1895 * @param string $user_email Email address of requesting user. 1896 * @param string $usermeta Miscellaneous metadata for the user. 1897 * 1898 * @return bool 1863 1899 */ 1864 1900 function bp_core_signup_blog( $blog_domain, $blog_path, $blog_title, $user_name, $user_email, $usermeta ) { … … 1884 1920 * 1885 1921 * @param string $key Activation key. 1922 * 1886 1923 * @return int|bool User ID on success, false on failure. 1887 1924 */ … … 2125 2162 * 2126 2163 * @param int $user_id ID of the user. 2164 * 2165 * @return bool 2127 2166 */ 2128 2167 function bp_core_map_user_registration( $user_id ) { … … 2187 2226 * Send activation email to a newly registered user. 2188 2227 * 2189 * @param int $user_idID of the new user.2228 * @param int $user_id ID of the new user. 2190 2229 * @param string $user_email Email address of the new user. 2191 * @param string $key Activation key.2230 * @param string $key Activation key. 2192 2231 */ 2193 2232 function bp_core_signup_send_validation_email( $user_id, $user_email, $key ) { … … 2248 2287 * Display a "resend email" link when an unregistered user attempts to log in. 2249 2288 * 2250 * @param WP_User|WP_Error $user Either the WP_User or the WP_Error object 2251 * @param string $username The inputted, attempted username. 2252 * @param string $password The inputted, attempted password. 2289 * @since BuddyPress (1.2.2) 2290 * 2291 * @param WP_User|WP_Error $user Either the WP_User or the WP_Error object. 2292 * @param string $username The inputted, attempted username. 2293 * @param string $password The inputted, attempted password. 2294 * 2253 2295 * @return WP_User|WP_Error 2254 *2255 * @since BuddyPress (1.2.2)2256 2296 */ 2257 2297 function bp_core_signup_disable_inactive( $user = null, $username = '', $password ='' ) { … … 2526 2566 * @since BuddyPress (2.2.0) 2527 2567 * 2528 * @param string $member_type The name of the member type. 2568 * @param string $member_type The name of the member type. 2569 * 2529 2570 * @return object A member type object. 2530 2571 */ … … 2553 2594 * element from the array needs to match; 'and' means all elements 2554 2595 * must match. Accepts 'or' or 'and'. Default 'and'. 2596 * 2555 2597 * @return array A list of member type names or objects. 2556 2598 */ … … 2660 2702 * @since BuddyPress (2.2.0) 2661 2703 * 2662 * @param int $user_id ID of the user. 2663 * @param bool $single Optional. Whether to return a single type string. If multiple types are found 2664 * for the user, the oldest one will be returned. Default: true. 2704 * @param int $user_id ID of the user. 2705 * @param bool $single Optional. Whether to return a single type string. If multiple types are found 2706 * for the user, the oldest one will be returned. Default: true. 2707 * 2665 2708 * @return string|array|bool On success, returns a single member type (if $single is true) or an array of member 2666 2709 * types (if $single is false). Returns false on failure. … … 2704 2747 * @since BuddyPress (2.3.0) 2705 2748 * 2706 * @param int $user_id $user_id ID of the user. 2707 * @param string $member_type Member Type. 2749 * @param int $user_id $user_id ID of the user. 2750 * @param string $member_type Member Type. 2751 * 2708 2752 * @return bool Whether the user has the given member type. 2709 2753 */ … … 2729 2773 * @since BuddyPress (2.2.0) 2730 2774 * 2731 * @param int $user_id ID of the user. 2775 * @param int $user_id ID of the user. 2776 * 2732 2777 * @return See {@see bp_set_member_type()}. 2733 2778 */ -
trunk/src/bp-members/bp-members-loader.php
r9819 r9877 2 2 3 3 /** 4 * BuddyPress Member Loader 4 * BuddyPress Member Loader. 5 5 * 6 6 * @package BuddyPress … … 12 12 13 13 class BP_Members_Component extends BP_Component { 14 14 15 /** 15 16 * Member types. … … 214 215 * 215 216 * @param array $main_nav Optional. See BP_Component::setup_nav() for 216 * description.217 * @param array $sub_nav Optional. See BP_Component::setup_nav() for218 * description.217 * description. 218 * @param array $sub_nav Optional. See BP_Component::setup_nav() for 219 * description. 219 220 */ 220 221 public function setup_nav( $main_nav = array(), $sub_nav = array() ) { … … 280 281 281 282 /** 282 * Setup cache groups 283 * Setup cache groups. 283 284 * 284 285 * @since BuddyPress (2.2.0) -
trunk/src/bp-members/bp-members-screens.php
r9819 r9877 2 2 3 3 /** 4 * BuddyPress Member Screens 4 * BuddyPress Member Screens. 5 5 * 6 6 * Handlers for member screens that aren't handled elsewhere. … … 294 294 */ 295 295 function bp_core_screen_activation() { 296 296 297 297 // Bail if not viewing the activation page 298 298 if ( ! bp_is_current_component( 'activate' ) ) { … … 522 522 * 523 523 * @param string $templates The templates from 524 * bp_get_theme_compat_templates(). 524 * bp_get_theme_compat_templates(). 525 * 525 526 * @return array $templates Array of custom templates to look for. 526 527 */ … … 592 593 593 594 /** 594 * Setup the groups component theme compatibility 595 * Setup the groups component theme compatibility. 595 596 * 596 597 * @since BuddyPress (1.7.0) … … 632 633 * 633 634 * @param string $templates The templates from bp_get_theme_compat_templates(). 635 * 634 636 * @return array $templates Array of custom templates to look for. 635 637 */ -
trunk/src/bp-members/bp-members-template.php
r9819 r9877 2 2 3 3 /** 4 * BuddyPress Member Template Tags 4 * BuddyPress Member Template Tags. 5 5 * 6 6 * Functions that are safe to use inside your template files and themes. … … 232 232 233 233 /** 234 * The unique string used for pagination queries 234 * The unique string used for pagination queries. 235 235 * 236 236 * @access public 237 * @var public237 * @var string 238 238 */ 239 239 public $pag_arg; … … 243 243 * 244 244 * @access public 245 * @var public245 * @var string 246 246 */ 247 247 public $pag_page; … … 251 251 * 252 252 * @access public 253 * @var public253 * @var string 254 254 */ 255 255 public $pag_num; … … 287 287 * @param array $meta_key Limit to users with a meta_key. 288 288 * @param array $meta_value Limit to users with a meta_value (with meta_key). 289 * @param array$page_arg Optional. The string used as a query parameter in pagination links.289 * @param string $page_arg Optional. The string used as a query parameter in pagination links. 290 290 * Default: 'upage'. 291 291 * @param array|string $member_type Array or comma-separated string of member types to limit results to. … … 467 467 * @global object $members_template {@link BP_Members_Template} 468 468 * 469 * @param array $args {469 * @param array|string $args { 470 470 * Arguments for limiting the contents of the members loop. Most arguments 471 471 * are in the same format as {@link BP_User_Query}. However, because … … 497 497 * @type string $search_terms Limit results by a search term. Default: null. 498 498 * @type string $meta_key Limit results by the presence of a usermeta key. 499 * Default: false.499 * Default: false. 500 500 * @type mixed $meta_value When used with meta_key, limits results by the 501 * a matching usermeta value. Default: false.501 * a matching usermeta value. Default: false. 502 502 * @type bool $populate_extras Whether to fetch optional data, such as 503 * friend counts. Default: true.503 * friend counts. Default: true. 504 504 * } 505 505 * @return bool Returns true when blogs are found, otherwise false. … … 862 862 * @see bp_get_member_avatar() for description of arguments. 863 863 * 864 * @param array $args See {@link bp_get_member_avatar()}.864 * @param array|string $args See {@link bp_get_member_avatar()}. 865 865 */ 866 866 function bp_member_avatar( $args = '' ) { … … 872 872 * 873 873 * @param string $value Formatted HTML <img> element, 874 * or raw avatar URL based on $html arg 874 * or raw avatar URL based on $html arg. 875 875 */ 876 876 echo apply_filters( 'bp_member_avatar', bp_get_member_avatar( $args ) ); … … 882 882 * return values. 883 883 * 884 * @param array $args {884 * @param array|string $args { 885 885 * Arguments are listed here with an explanation of their defaults. 886 886 * For more information about the arguments, see 887 887 * {@link bp_core_fetch_avatar()}. 888 * @type string $altDefault: 'Profile picture of [user name]'.889 * @type string $classDefault: 'avatar'.890 * @type string $typeDefault: 'thumb'.891 * @type int|bool $width Default: false.892 * @type int|bool $height Default: false.893 * @type bool $idCurrently unused.894 * @type bool $no_grav Default: false.888 * @type string $alt Default: 'Profile picture of [user name]'. 889 * @type string $class Default: 'avatar'. 890 * @type string $type Default: 'thumb'. 891 * @type int|bool $width Default: false. 892 * @type int|bool $height Default: false. 893 * @type bool $id Currently unused. 894 * @type bool $no_grav Default: false. 895 895 * } 896 896 * @return string User avatar string. … … 919 919 * 920 920 * @param string $value Formatted HTML <img> element, 921 * or raw avatar URL based on $html arg 921 * or raw avatar URL based on $html arg. 922 922 */ 923 923 return apply_filters( 'bp_get_member_avatar', bp_core_fetch_avatar( array( 'item_id' => $members_template->member->id, 'type' => $type, 'alt' => $alt, 'css_id' => $id, 'class' => $class, 'width' => $width, 'height' => $height, 'email' => $members_template->member->user_email ) ) ); … … 1032 1032 * Array of optional arguments. 1033 1033 * @type mixed $active_format If true, formatted "active 5 minutes 1034 * ago". If false, formatted "5 minutes ago". If string, should 1035 * be sprintf'able like 'last seen %s ago'. 1034 * ago". If false, formatted "5 minutes ago". 1035 * If string, should be sprintf'able like 1036 * 'last seen %s ago'. 1036 1037 * } 1037 1038 * @return string … … 1076 1077 /** 1077 1078 * Output the latest update of the current member in the loop. 1079 * 1080 * @param array|string $args 1078 1081 */ 1079 1082 function bp_member_latest_update( $args = '' ) { … … 1083 1086 * Get the latest update from the current member in the loop. 1084 1087 * 1085 * @param array $args {1088 * @param array|string $args { 1086 1089 * Array of optional arguments. 1087 * @type int $lengthTruncation length. Default: 225.1090 * @type int $length Truncation length. Default: 225. 1088 1091 * @type bool $view_link Whether to provide a 'View' link for 1089 * truncated entries. Default: false.1092 * truncated entries. Default: false. 1090 1093 * } 1091 1094 * @return string … … 1139 1142 * @see bp_get_member_profile_data() for a description of params. 1140 1143 * 1141 * @param array $args See {@link bp_get_member_profile_data()}.1144 * @param array|string $args See {@link bp_get_member_profile_data()}. 1142 1145 */ 1143 1146 function bp_member_profile_data( $args = '' ) { … … 1151 1154 * to use outside of the loop. 1152 1155 * 1153 * @param array $args {1156 * @param array|string $args { 1154 1157 * Array of config parameters. 1155 * @type string $field Name of the profile field.1156 * @type int $user_id ID of the user whose data is being fetched.1157 * Defaults to the current member in the loop, or if not1158 * present, to the currently displayed user.1158 * @type string $field Name of the profile field. 1159 * @type int $user_id ID of the user whose data is being fetched. 1160 * Defaults to the current member in the loop, or if not 1161 * present, to the currently displayed user. 1159 1162 * } 1160 1163 * @return string|bool Profile data if found, otherwise false. … … 1413 1416 * 1414 1417 * @see bp_get_loggedin_user_avatar() for a description of params. 1418 * 1419 * @param array|string $args 1415 1420 */ 1416 1421 function bp_loggedin_user_avatar( $args = '' ) { … … 1423 1428 * return values. 1424 1429 * 1425 * @param array $args {1430 * @param array|string $args { 1426 1431 * Arguments are listed here with an explanation of their defaults. 1427 1432 * For more information about the arguments, see 1428 1433 * {@link bp_core_fetch_avatar()}. 1429 * @type string $altDefault: 'Profile picture of [user name]'.1430 * @type bool $htmlDefault: true.1431 * @type string $typeDefault: 'thumb'.1432 * @type int|bool $width Default: false.1434 * @type string $alt Default: 'Profile picture of [user name]'. 1435 * @type bool $html Default: true. 1436 * @type string $type Default: 'thumb'. 1437 * @type int|bool $width Default: false. 1433 1438 * @type int|bool $height Default: false. 1434 1439 * } … … 1460 1465 * 1461 1466 * @see bp_get_displayed_user_avatar() for a description of params. 1467 * 1468 * @param array|string $args 1462 1469 */ 1463 1470 function bp_displayed_user_avatar( $args = '' ) { … … 1470 1477 * return values. 1471 1478 * 1472 * @param array $args {1479 * @param array|string $args { 1473 1480 * Arguments are listed here with an explanation of their defaults. 1474 1481 * For more information about the arguments, see 1475 1482 * {@link bp_core_fetch_avatar()}. 1476 * @type string $altDefault: 'Profile picture of [user name]'.1477 * @type bool $htmlDefault: true.1478 * @type string $typeDefault: 'thumb'.1479 * @type int|bool $width Default: false.1483 * @type string $alt Default: 'Profile picture of [user name]'. 1484 * @type bool $html Default: true. 1485 * @type string $type Default: 'thumb'. 1486 * @type int|bool $width Default: false. 1480 1487 * @type int|bool $height Default: false. 1481 1488 * } … … 1555 1562 * 1556 1563 * @param int $user_id ID of the user. Default: displayed user ID. 1564 * 1557 1565 * @return string 1558 1566 */ … … 1585 1593 * Simply takes all the characters before the first space in a name. 1586 1594 * 1587 * @param string $name Full name to use when generating first name.1588 * Defaults to displayed user's first name, or to logged-in1589 * user's first name if it's unavailable.1595 * @param string|bool $name Full name to use when generating first name. 1596 * Defaults to displayed user's first name, or to 1597 * logged-in user's first name if it's unavailable. 1590 1598 * @return string 1591 1599 */ … … 2193 2201 * @see bp_get_signup_avatar() for description of arguments. 2194 2202 * 2195 * @param array $args See {@link bp_get_signup_avatar(}.2203 * @param array|string $args See {@link bp_get_signup_avatar(}. 2196 2204 */ 2197 2205 function bp_signup_avatar( $args = '' ) { … … 2203 2211 * @see bp_core_fetch_avatar() for description of arguments. 2204 2212 * 2205 * @param array $args {2213 * @param array|string $args { 2206 2214 * Array of optional arguments. 2207 * @type int $sizeHeight/weight in pixels. Default: value of2208 * bp_core_avatar_full_width().2215 * @type int $size Height/weight in pixels. Default: value of 2216 * bp_core_avatar_full_width(). 2209 2217 * @type string $class CSS class. Default: 'avatar'. 2210 * @type string $alt HTML 'alt' attribute. Default: 'Your Avatar'.2218 * @type string $alt HTML 'alt' attribute. Default: 'Your Avatar'. 2211 2219 * } 2212 2220 * @return string … … 2332 2340 * @see bp_get_members_component_link() for description of parameters. 2333 2341 * 2334 * @param string $component See {@bp_get_members_component_link()}.2335 * @param string $action See {@bp_get_members_component_link()}.2336 * @param string $query_args See {@bp_get_members_component_link()}.2337 * @param string $nonce See {@bp_get_members_component_link()}.2342 * @param string $component See {@bp_get_members_component_link()}. 2343 * @param string $action See {@bp_get_members_component_link()}. 2344 * @param string $query_args See {@bp_get_members_component_link()}. 2345 * @param string|bool $nonce See {@bp_get_members_component_link()}. 2338 2346 */ 2339 2347 function bp_members_component_link( $component, $action = '', $query_args = '', $nonce = false ) { … … 2343 2351 * Generate a link to a members component subpage. 2344 2352 * 2345 * @param string $component ID of the component (eg 'friends'). 2346 * @param string $action Optional. 'action' slug (eg 'invites'). 2347 * @param array $query_args Optional. Array of URL params to add to the 2348 * URL. See {@link add_query_arg()} for format. 2349 * @param array $nonce Optional. If provided, the URL will be passed 2350 * through wp_nonce_url() with $nonce as the action string. 2353 * @param string $component ID of the component (eg 'friends'). 2354 * @param string $action Optional. 'action' slug (eg 'invites'). 2355 * @param array|string $query_args Optional. Array of URL params to add to the 2356 * URL. See {@link add_query_arg()} for format. 2357 * @param array|bool $nonce Optional. If provided, the URL will be passed 2358 * through wp_nonce_url() with $nonce as the 2359 * action string. 2351 2360 * @return string 2352 2361 */ -
trunk/src/bp-members/bp-members-widgets.php
r9819 r9877 1 1 <?php 2 2 /** 3 * BuddyPress Members Widgets 3 * BuddyPress Members Widgets. 4 4 * 5 5 * @package BuddyPress … … 31 31 32 32 /** 33 * Constructor method 33 * Constructor method. 34 34 */ 35 35 public function __construct() { … … 153 153 * Update the Members widget options. 154 154 * 155 * @param array $new_instance The new instance options. 156 * @param array $old_instance The old instance options. 155 * @param array $new_instance The new instance options. 156 * @param array $old_instance The old instance options. 157 * 157 158 * @return array $instance The parsed options to be saved. 158 159 */ … … 171 172 * Output the Members widget options form. 172 173 * 173 * @param $instance Settings for this widget. 174 * @param array $instance Widget instance settings. 175 * 176 * @return string 174 177 */ 175 178 public function form( $instance ) { … … 221 224 * @since BuddyPress (2.3.0) 222 225 * 223 * @param $instance Instance 224 * @uses bp_parse_args() To merge widget settings into defaults 226 * @param array $instance Widget instance settings. 227 * 228 * @uses bp_parse_args() To merge widget settings into defaults. 229 * 230 * @return array 225 231 */ 226 232 public function parse_settings( $instance = array() ) { … … 321 327 * Update the Who's Online widget options. 322 328 * 323 * @param array $new_instance The new instance options. 324 * @param array $old_instance The old instance options. 329 * @param array $new_instance The new instance options. 330 * @param array $old_instance The old instance options. 331 * 325 332 * @return array $instance The parsed options to be saved. 326 333 */ … … 336 343 * Output the Who's Online widget options form. 337 344 * 338 * @param $instance Settings for this widget. 345 * @param array $instance Widget instance settings. 346 * 347 * @return string 339 348 */ 340 349 public function form( $instance ) { … … 367 376 * @since BuddyPress (2.3.0) 368 377 * 369 * @param $instance Instance 370 * @uses bp_parse_args() To merge widget settings into defaults 378 * @param array $instance Widget instance settings. 379 * 380 * @uses bp_parse_args() To merge widget settings into defaults. 381 * 382 * @return array 371 383 */ 372 384 public function parse_settings( $instance = array() ) { … … 467 479 * @param array $new_instance The new instance options. 468 480 * @param array $old_instance The old instance options. 481 * 469 482 * @return array $instance The parsed options to be saved. 470 483 */ … … 480 493 * Output the Recently Active widget options form. 481 494 * 482 * @param $instance Settings for this widget. 495 * @param array $instance Widget instance settings. 496 * 497 * @return string 483 498 */ 484 499 public function form( $instance ) { … … 511 526 * @since BuddyPress (2.3.0) 512 527 * 513 * @param $instance Instance 514 * @uses bp_parse_args() To merge widget settings into defaults 528 * @param array $instance Widget instance settings. 529 * 530 * @uses bp_parse_args() To merge widget settings into defaults. 531 * 532 * @return array 515 533 */ 516 534 public function parse_settings( $instance = array() ) { -
trunk/src/bp-members/classes/class-bp-signup.php
r9819 r9877 111 111 * @since BuddyPress (2.0.0) 112 112 * 113 * @param array $args the argument to retrieve desired signups 113 * @param array $args the argument to retrieve desired signups. 114 * 114 115 * @return array { 115 116 * @type array $signups Located signups. 116 * @type int $totalTotal number of signups matching params.117 * @type int $total Total number of signups matching params. 117 118 * } 118 119 */ … … 258 259 * 259 260 * @param array $args 261 * 260 262 * @return int|bool ID of newly created signup on success, false on 261 * failure.263 * failure. 262 264 */ 263 265 public static function add( $args = array() ) { … … 314 316 * @since BuddyPress (2.0.0) 315 317 * 316 * @param string $user_login User login string.318 * @param string $user_login User login string. 317 319 * @param string $user_password User password. 318 * @param string $user_email User email address. 319 * @param array $usermeta Metadata associated with the signup. 320 * @param string $user_email User email address. 321 * @param array $usermeta Metadata associated with the signup. 322 * 320 323 * @return int User id. 321 324 */ … … 380 383 * 381 384 * @param int $user_id ID of the user being checked. 385 * 382 386 * @return int|bool The status if found, otherwise false. 383 387 */ … … 407 411 * 408 412 * @param string $key Activation key. 413 * 409 414 * @return bool True on success, false on failure. 410 415 */ … … 452 457 * @since BuddyPress (2.0.0) 453 458 * 454 * @return int the number of signups459 * @return int The number of signups. 455 460 */ 456 461 public static function count_signups() { … … 478 483 * @since BuddyPress (2.0.0) 479 484 * 480 * @param array $args 481 * @return int the signup id 485 * @param array $args 486 * 487 * @return int The signup id 482 488 */ 483 489 public static function update( $args = array() ) { … … 533 539 * 534 540 * @param array $signup_ids Single ID or list of IDs to resend. 541 * 535 542 * @return array 536 543 */ … … 622 629 * 623 630 * @param array $signup_ids Single ID or list of IDs to activate. 631 * 624 632 * @return array 625 633 */ … … 704 712 * 705 713 * @param array $signup_ids Single ID or list of IDs to delete. 714 * 706 715 * @return array 707 716 */
Note: See TracChangeset
for help on using the changeset viewer.