Changeset 10587 for trunk/src/bp-friends/bp-friends-functions.php
- Timestamp:
- 02/13/2016 07:32:53 PM (9 years ago)
- File:
-
- 1 edited
-
trunk/src/bp-friends/bp-friends-functions.php (modified) (24 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/bp-friends/bp-friends-functions.php
r10417 r10587 18 18 /** 19 19 * Create a new friendship. 20 * 21 * @since 1.0.0 20 22 * 21 23 * @param int $initiator_userid ID of the "initiator" user (the user who is … … 91 93 * Will also delete the related "friendship_accepted" activity item. 92 94 * 95 * @since 1.0.0 96 * 93 97 * @param int $initiator_userid ID of the friendship initiator. 94 98 * @param int $friend_userid ID of the friend user. … … 152 156 * 153 157 * Also initiates a "friendship_accepted" activity item. 158 * 159 * @since 1.0.0 154 160 * 155 161 * @param int $friendship_id ID of the pending friendship object. … … 188 194 * Mark a friendship request as rejected. 189 195 * 196 * @since 1.0.0 197 * 190 198 * @param int $friendship_id ID of the pending friendship object. 191 199 * @return bool True on success, false on failure. … … 214 222 * Withdraw a friendship request. 215 223 * 224 * @since 1.6.0 225 * 216 226 * @param int $initiator_userid ID of the friendship initiator - this is the 217 227 * user who requested the friendship, and is doing the withdrawing. … … 247 257 * Check whether two users are friends. 248 258 * 259 * @since 1.0.0 260 * 249 261 * @param int $user_id ID of the first user. 250 262 * @param int $possible_friend_id ID of the other user. … … 263 275 * 264 276 * Will return 'is_friends', 'not_friends', 'pending' or 'awaiting_response'. 277 * 278 * @since 1.2.0 265 279 * 266 280 * @param int $user_id ID of the first user. … … 285 299 * Get the friend count of a given user. 286 300 * 301 * @since 1.2.0 302 * 287 303 * @param int $user_id ID of the user whose friends are being counted. 288 304 * @return int Friend count of the user. … … 309 325 * Check whether a given user has any friends. 310 326 * 327 * @since 1.0.0 328 * 311 329 * @param int $user_id ID of the user whose friends are being checked. 312 330 * @return bool True if the user has friends, otherwise false. … … 326 344 /** 327 345 * Get the ID of two users' friendship, if it exists. 346 * 347 * @since 1.2.0 328 348 * 329 349 * @param int $initiator_user_id ID of the first user. … … 337 357 /** 338 358 * Get the IDs of a given user's friends. 359 * 360 * @since 1.0.0 339 361 * 340 362 * @param int $user_id ID of the user whose friends are being retrieved. … … 352 374 /** 353 375 * Search the friends of a user by a search string. 376 * 377 * @since 1.0.0 354 378 * 355 379 * @param string $search_terms The search string, matched against xprofile fields (if … … 372 396 * Get a list of IDs of users who have requested friendship of a given user. 373 397 * 398 * @since 1.2.0 399 * 374 400 * @param int $user_id The ID of the user who has received the friendship requests. 375 401 * @return array|bool An array of user IDs, or false if none are found. … … 381 407 /** 382 408 * Get a user's most recently active friends. 409 * 410 * @since 1.0.0 383 411 * 384 412 * @see BP_Core_User::get_users() for a description of return value. … … 411 439 * Get a user's friends, in alphabetical order. 412 440 * 441 * @since 1.0.0 442 * 413 443 * @see BP_Core_User::get_users() for a description of return value. 414 444 * … … 440 470 * Get a user's friends, in the order in which they joined the site. 441 471 * 472 * @since 1.0.0 473 * 442 474 * @see BP_Core_User::get_users() for a description of return value. 443 475 * … … 469 501 * Get the last active date of many users at once. 470 502 * 503 * @since 1.0.0 504 * 471 505 * @see BP_Friends_Friendship::get_bulk_last_active() for a description of 472 506 * arguments and return value. … … 578 612 * - users who have been banned from the group 579 613 * 614 * @since 1.0.0 615 * 580 616 * @param int $user_id ID of the user whose friends are being counted. 581 617 * @param int $group_id ID of the group friends are being invited to. … … 589 625 * Get a total friend count for a given user. 590 626 * 627 * @since 1.0.0 628 * 591 629 * @param int $user_id Optional. ID of the user whose friendships you are 592 630 * counting. Default: displayed user (if any), otherwise logged-in user. … … 599 637 /** 600 638 * Return a list of a user's friends, filtered by a search term. 639 * 640 * @since 1.0.0 601 641 * 602 642 * @param string $search_terms Search term to filter on. … … 625 665 * Has a friendship been confirmed (accepted)? 626 666 * 667 * @since 1.0.0 668 * 627 669 * @param int $friendship_id The ID of the friendship being checked. 628 670 * @return bool True if the friendship is confirmed, otherwise false. … … 639 681 * friendship event (acceptance, deletion), call this function to regenerate 640 682 * the cached values. 683 * 684 * @since 1.0.0 641 685 * 642 686 * @param int $initiator_user_id ID of the first user. … … 666 710 * - Notifications of friendship requests sent by the user. 667 711 * 712 * @since 1.0.0 713 * 668 714 * @param int $user_id ID of the user whose friend data is being removed. 669 715 */ … … 701 747 * 702 748 * This is intended to speed up @mentions lookups for a majority of use cases. 749 * 750 * @since 2.1.0 703 751 * 704 752 * @see bp_activity_mentions_script()
Note: See TracChangeset
for help on using the changeset viewer.