Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
07/04/2015 10:23:19 PM (5 years ago)
Author:
tw2113
Message:

Docs cleanup for Friends component.

See #6400.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-friends/bp-friends-template.php

    r9819 r9995  
    263263     *
    264264     * @param int $user_id Optional. If provided, the function will simply
    265      *        return this value.
     265     *                     return this value.
     266     *
    266267     * @return int ID of potential friend.
    267268     */
     
    290291 *
    291292 * @param int $user_id ID of the potential friend. Default: the value of
    292  *        {@link bp_get_potential_friend_id()}.
     293 *                     {@link bp_get_potential_friend_id()}.
     294 *
    293295 * @return string 'is_friend', 'not_friends', or 'pending'.
    294296 */
     
    319321 * @see bp_get_add_friend_button() for information on arguments.
    320322 *
    321  * @param int $potential_friend_id See {@link bp_get_add_friend_button()}.
    322  * @param int $friend_status See {@link bp_get_add_friend_button()}.
     323 * @param int      $potential_friend_id See {@link bp_get_add_friend_button()}.
     324 * @param int|bool $friend_status      See {@link bp_get_add_friend_button()}.
    323325 */
    324326function bp_add_friend_button( $potential_friend_id = 0, $friend_status = false ) {
     
    328330     * Create the Add Friend button.
    329331     *
    330      * @param int $potential_friend_id ID of the user to whom the button
    331      *        applies. Default: value of {@link bp_get_potential_friend_id()}.
    332      * @param bool $friend_status Not currently used.
     332     * @param int  $potential_friend_id ID of the user to whom the button
     333     *                                  applies. Default: value of {@link bp_get_potential_friend_id()}.
     334     * @param bool $friend_status       Not currently used.
     335     *
    333336     * @return string HTML for the Add Friend button.
    334337     */
     
    427430 *
    428431 * @param int $user_id Optional. Default: the displayed user's ID, or the
    429  *        logged-in user's ID.
     432 *                     logged-in user's ID.
     433 *
    430434 * @return string|bool A comma-separated list of friend IDs if any are found,
    431  *         otherwise false.
     435 *                     otherwise false.
    432436 */
    433437function bp_get_friend_ids( $user_id = 0 ) {
     
    451455 *
    452456 * @param int $user_id ID of the user whose requests are being retrieved.
    453  *        Defaults to displayed user.
     457 *                     Defaults to displayed user.
     458 *
    454459 * @return array|int An array of user IDs if found, or a 0 if none are found.
    455460 */
     
    580585     *
    581586     * @param int $user_id See {@link friends_get_total_friend_count()}.
     587     *
    582588     * @return int Total friend count.
    583589     */
     
    609615     *
    610616     * @param int $user_id ID of the user whose requests are being counted.
    611      *        Default: ID of the logged-in user.
     617     *                     Default: ID of the logged-in user.
     618     *
    612619     * @return int Friend count.
    613620     */
     
    633640 * @since BuddyPress (2.0.0)
    634641 *
    635  * @param array $args before|after|user_id
    636  * @uses bp_friends_get_profile_stats() to get the stats
     642 * @uses bp_friends_get_profile_stats() to get the stats.
     643 *
     644 * @param array|string $args before|after|user_id
    637645 */
    638646function bp_friends_profile_stats( $args = '' ) {
     
    646654 * @since BuddyPress (2.0.0)
    647655 *
    648  * @param array $args before|after|user_id
     656 * @param array|string $args before|after|user_id
     657 *
    649658 * @return string HTML for stats output.
    650659 */
     
    682691     *
    683692     * @param string $value Formatted string displaying total friends count.
    684      * @param array  $r Array of arguments for string formatting and output.
     693     * @param array  $r     Array of arguments for string formatting and output.
    685694     */
    686695    return apply_filters( 'bp_friends_get_profile_stats', $r['output'], $r );
Note: See TracChangeset for help on using the changeset viewer.