Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
06/02/2015 05:21:07 AM (10 years ago)
Author:
tw2113
Message:

Initial documentation cleanup for the BP Groups component.

See #6401.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-groups/classes/class-bp-groups-member.php

    r9901 r9906  
    138138     * @param int $group_id Optional. Along with $user_id, can be used to
    139139     *        look up a membership.
    140      * @param int $id Optional. The unique ID of the membership object.
     140     * @param int|bool $id Optional. The unique ID of the membership object.
    141141     * @param bool $populate Whether to populate the properties of the
    142142     *        located membership. Default: true.
    … …  
    227227         * @since BuddyPress (1.0.0)
    228228         *
    229          * @param BP_Groups_Member Current instance of the group membership item being saved. Passed by reference.
     229         * @param BP_Groups_Member $this Current instance of the group membership item being saved. Passed by reference.
    230230         */
    231231        do_action_ref_array( 'groups_member_before_save', array( &$this ) );
    … …  
    260260         * @since BuddyPress (1.0.0)
    261261         *
    262          * @param BP_Groups_Member Current instance of the group membership item has been saved. Passed by reference.
     262         * @param BP_Groups_Member $this Current instance of the group membership item has been saved. Passed by reference.
    263263         */
    264264        do_action_ref_array( 'groups_member_after_save', array( &$this ) );
    … …  
    361361         * @since BuddyPress (2.3.0)
    362362         *
    363          * @param BP_Groups_Member Current group membership object.
     363         * @param BP_Groups_Member $this Current group membership object.
    364364         */
    365365        do_action_ref_array( 'groups_member_before_remove', array( $this ) );
    … …  
    382382         * @since BuddyPress (2.3.0)
    383383         *
    384          * @param BP_Groups_Member Current group membership object.
     384         * @param BP_Groups_Member $this Current group membership object.
    385385         */
    386386        do_action_ref_array( 'groups_member_after_remove', array( $this ) );
    … …  
    461461     *
    462462     * @param int $user_id ID of the user.
    463      * @param int $limit Optional. Max number of results to return.
     463     * @param int|bool $limit Optional. Max number of results to return.
    464464     *        Default: false (no limit).
    465      * @param int $page Optional. Page offset of results to return.
     465     * @param int|bool $page Optional. Page offset of results to return.
    466466     *        Default: false (no limit).
    467467     * @return array {
    … …  
    497497     *
    498498     * @param int $user_id ID of the user.
    499      * @param int $limit Optional. Max number of results to return.
     499     * @param int|bool $limit Optional. Max number of results to return.
    500500     *        Default: false (no limit).
    501      * @param int $page Optional. Page offset of results to return.
     501     * @param int|bool $page Optional. Page offset of results to return.
    502502     *        Default: false (no limit).
    503      * @param string $filter Optional. Limit results to groups whose name or
     503     * @param string|bool $filter Optional. Limit results to groups whose name or
    504504     *        description field matches search terms.
    505505     * @return array {
    … …  
    538538     *
    539539     * @param int $user_id ID of the user.
    540      * @param int $limit Optional. Max number of results to return.
     540     * @param int|bool $limit Optional. Max number of results to return.
    541541     *        Default: false (no limit).
    542      * @param int $page Optional. Page offset of results to return.
     542     * @param int|bool $page Optional. Page offset of results to return.
    543543     *        Default: false (no limit).
    544      * @param string $filter Optional. Limit results to groups whose name or
     544     * @param string|bool $filter Optional. Limit results to groups whose name or
    545545     *        description field matches search terms.
    546546     * @return array {
    … …  
    579579     *
    580580     * @param int $user_id ID of the user.
    581      * @param int $limit Optional. Max number of results to return.
     581     * @param int|bool $limit Optional. Max number of results to return.
    582582     *        Default: false (no limit).
    583      * @param int $page Optional. Page offset of results to return.
     583     * @param int|bool $page Optional. Page offset of results to return.
    584584     *        Default: false (no limit).
    585      * @param string $filter Optional. Limit results to groups whose name or
     585     * @param string|bool $filter Optional. Limit results to groups whose name or
    586586     *        description field matches search terms.
    587587     * @return array {
    … …  
    641641     *
    642642     * @param int $user_id ID of the invitee.
    643      * @param int $limit Optional. Max number of results to return.
     643     * @param int|bool $limit Optional. Max number of results to return.
    644644     *        Default: false (no limit).
    645      * @param int $page Optional. Page offset of results to return.
     645     * @param int|bool $page Optional. Page offset of results to return.
    646646     *        Default: false (no limit).
    647      * @param string|array $exclude Optional. Array or comma-separated list
     647     * @param string|array|bool $exclude Optional. Array or comma-separated list
    648648     *        of group IDs to exclude from results.
    649649     * @return array {
    … …  
    773773     * @param int|null ID of the membership if the user is an admin,
    774774     *        otherwise null.
     775     *
     776     * @return mixed
    775777     */
    776778    public static function check_is_admin( $user_id, $group_id ) {
    … …  
    792794     * @param int|null ID of the membership if the user is a mod,
    793795     *        otherwise null.
     796     *
     797     * @return mixed
    794798     */
    795799    public static function check_is_mod( $user_id, $group_id ) {
    … …  
    811815     * @param int|null ID of the membership if the user is a member,
    812816     *        otherwise null.
     817     *
     818     * @return mixed
    813819     */
    814820    public static function check_is_member( $user_id, $group_id ) {
    … …  
    830836     * @param int|null ID of the membership if the user is banned,
    831837     *        otherwise null.
     838     *
     839     * @return mixed
    832840     */
    833841    public static function check_is_banned( $user_id, $group_id ) {
    … …  
    968976     *
    969977     * @deprecated BuddyPress (1.8.0)
     978     *
     979     * @param $group_id
     980     * @param $limit
     981     * @param $page
     982     * @param $exclude_admins_mods
     983     * @param $exclude_banned
     984     * @param $exclude
     985     *
     986     * @return mixed
    970987     */
    971988    public static function get_all_for_group( $group_id, $limit = false, $page = false, $exclude_admins_mods = true, $exclude_banned = true, $exclude = false ) {
    … …  
    10681085     *
    10691086     * @param int $user_id ID of the user.
     1087     *
     1088     * @return mixed
    10701089     */
    10711090    public static function delete_all_for_user( $user_id ) {
Note: See TracChangeset for help on using the changeset viewer.