Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
03/04/2017 06:26:55 PM (7 years ago)
Author:
tw2113
Message:

Cleanup from recent Scrutinizer review around documentation and param/return types.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-friends/classes/class-bp-friends-friendship.php

    r11366 r11447  
    589589     * @param int $possible_friend_userid The ID of the user who is the
    590590     *                                    recipient of the potential friendship/request.
    591      * @return string $value The friendship status, from among 'not_friends',
    592      *                       'is_friend', 'pending', and 'awaiting_response'.
     591     * @return string|false $value The friendship status, from among 'not_friends',
     592     *                             'is_friend', 'pending', and 'awaiting_response'.
    593593     */
    594594    public static function check_is_friend( $initiator_userid, $possible_friend_userid ) {
     
    826826     * @param int $total_friends Optional. Number of random friends to get.
    827827     *                           Default: 5.
    828      * @return array|bool An array of random friend user IDs on success;
    829      *                    false if none are found.
     828     * @return array|false An array of random friend user IDs on success;
     829     *                     false if none are found.
    830830     */
    831831    public static function get_random_friends( $user_id, $total_friends = 5 ) {
     
    917917     *
    918918     * @param int $friendship_id ID of the friendship.
    919      * @return object friend_user_id and initiator_user_id.
     919     * @return null|stdClass friend_user_id and initiator_user_id.
    920920     */
    921921    public static function get_user_ids_for_friendship( $friendship_id ) {
Note: See TracChangeset for help on using the changeset viewer.