Skip to:
Content

BuddyPress.org

Changeset 9028


Ignore:
Timestamp:
09/17/2014 02:15:25 PM (10 years ago)
Author:
boonebgorges
Message:

Inline documentation improvements for part of bp-groups-template.php

It's a big file

See #5022

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-groups/bp-groups-template.php

    r8931 r9028  
    22
    33/**
    4  * BuddyPress Groups Template Functions
    5  *
    6  * @package BuddyPress
    7  * @subpackage GroupsTemplate
     4 * BuddyPress Groups Template Functions.
    85 */
    96
    … …  
    129
    1310/**
    14  * Output the groups component slug
    15  *
    16  * @package BuddyPress
    17  * @subpackage Groups Template
    18  * @since BuddyPress (1.5)
    19  *
    20  * @uses bp_get_groups_slug()
     11 * Output the groups component slug.
     12 *
     13 * @since BuddyPress (1.5.0)
    2114 */
    2215function bp_groups_slug() {
    … …  
    2417}
    2518    /**
    26      * Return the groups component slug
    27      *
    28      * @package BuddyPress
    29      * @subpackage Groups Template
    30      * @since BuddyPress (1.5)
     19     * Return the groups component slug.
     20     *
     21     * @since BuddyPress (1.5.0)
     22     *
     23     * @return string
    3124     */
    3225    function bp_get_groups_slug() {
    … …  
    3730 * Output the groups component root slug
    3831 *
    39  * @package BuddyPress
    40  * @subpackage Groups Template
    41  * @since BuddyPress (1.5)
    42  *
    43  * @uses bp_get_groups_root_slug()
     32 * @since BuddyPress (1.5.0)
    4433 */
    4534function bp_groups_root_slug() {
    … …  
    4938     * Return the groups component root slug
    5039     *
    51      * @package BuddyPress
    52      * @subpackage Groups Template
    53      * @since BuddyPress (1.5)
     40     * @since BuddyPress (1.5.0)
     41     *
     42     * @return string
    5443     */
    5544    function bp_get_groups_root_slug() {
    … …  
    6049 * Output group directory permalink
    6150 *
    62  * @package BuddyPress
    63  * @subpackage Groups Template
    64  * @since BuddyPress (1.5)
    65  * @uses bp_get_groups_directory_permalink()
     51 * @since BuddyPress (1.5.0)
    6652 */
    6753function bp_groups_directory_permalink() {
    … …  
    7157     * Return group directory permalink
    7258     *
    73      * @package BuddyPress
    74      * @subpackage Groups Template
    75      * @since BuddyPress (1.5)
    76      * @uses apply_filters()
    77      * @uses traisingslashit()
    78      * @uses bp_get_root_domain()
    79      * @uses bp_get_groups_root_slug()
     59     * @since BuddyPress (1.5.0)
     60     *
    8061     * @return string
    8162     */
    … …  
    8465    }
    8566
    86 /*****************************************************************************
    87  * Groups Template Class/Tags
    88  **/
    89 
     67/**
     68 * The main Groups template loop class.
     69 *
     70 * Responsible for loading a group of groups into a loop for display.
     71 */
    9072class BP_Groups_Template {
     73
     74    /**
     75     * The loop iterator.
     76     *
     77     * @access public
     78     * @var int
     79     */
    9180    var $current_group = -1;
     81
     82    /**
     83     * The number of groups returned by the paged query.
     84     *
     85     * @access public
     86     * @var int
     87     */
    9288    var $group_count;
     89
     90    /**
     91     * Array of groups located by the query.
     92     *
     93     * @access public
     94     * @var array
     95     */
    9396    var $groups;
     97
     98    /**
     99     * The group object currently being iterated on.
     100     *
     101     * @access public
     102     * @var object
     103     */
    94104    var $group;
    95105
     106    /**
     107     * A flag for whether the loop is currently being iterated.
     108     *
     109     * @access public
     110     * @var bool
     111     */
    96112    var $in_the_loop;
    97113
     114    /**
     115     * The page number being requested.
     116     *
     117     * @access public
     118     * @var public
     119     */
    98120    var $pag_page;
     121
     122    /**
     123     * The number of items being requested per page.
     124     *
     125     * @access public
     126     * @var public
     127     */
    99128    var $pag_num;
     129
     130    /**
     131     * An HTML string containing pagination links.
     132     *
     133     * @access public
     134     * @var string
     135     */
    100136    var $pag_links;
     137
     138    /**
     139     * The total number of groups matching the query parameters.
     140     *
     141     * @access public
     142     * @var int
     143     */
    101144    var $total_group_count;
    102145
     146    /**
     147     * Whether the template loop is for a single group page.
     148     *
     149     * @access public
     150     * @var bool
     151     */
    103152    var $single_group = false;
    104153
     154    /**
     155     * Field to sort by.
     156     *
     157     * @access public
     158     * @var string
     159     */
    105160    var $sort_by;
     161
     162    /**
     163     * Sort order.
     164     *
     165     * @access public
     166     * @var string
     167     */
    106168    var $order;
    107169
     170    /**
     171     * Constructor method.
     172     *
     173     * @see BP_Groups_Group::get() for an in-depth description of arguments.
     174     *
     175     * @param array $args {
     176     *     Array of arguments. Accepts all arguments accepted by
     177     *     {@link BP_Groups_Group::get()}. In cases where the default
     178     *     values of the params differ, they have been discussed below.
     179     *     @type int $per_page Default: 20.
     180     *     @type int $page Default: 1.
     181     * }
     182     */
    108183    function __construct( $args = array() ){
    109184
    … …  
    264339    }
    265340
     341    /**
     342     * Whether there are groups available in the loop.
     343     *
     344     * @see bp_has_groups()
     345     *
     346     * @return bool True if there are items in the loop, otherwise false.
     347     */
    266348    function has_groups() {
    267349        if ( $this->group_count )
    … …  
    271353    }
    272354
     355    /**
     356     * Set up the next group and iterate index.
     357     *
     358     * @return object The next group to iterate over.
     359     */
    273360    function next_group() {
    274361        $this->current_group++;
    … …  
    278365    }
    279366
     367    /**
     368     * Rewind the groups and reset member index.
     369     */
    280370    function rewind_groups() {
    281371        $this->current_group = -1;
    … …  
    285375    }
    286376
     377    /**
     378     * Whether there are groups left in the loop to iterate over.
     379     *
     380     * This method is used by {@link bp_groups()} as part of the while loop
     381     * that controls iteration inside the groups loop, eg:
     382     *     while ( bp_groups() ) { ...
     383     *
     384     * @see bp_groups()
     385     *
     386     * @return bool True if there are more groups to show, otherwise false.
     387     */
    287388    function groups() {
    288389        if ( $this->current_group + 1 < $this->group_count ) {
    … …  
    298399    }
    299400
     401    /**
     402     * Set up the current group inside the loop.
     403     *
     404     * Used by {@link bp_the_group()} to set up the current group data
     405     * while looping, so that template tags used during that iteration make
     406     * reference to the current member.
     407     *
     408     * @see bp_the_group()
     409     */
    300410    function the_group() {
    301411        $this->in_the_loop = true;
    … …  
    308418
    309419/**
    310  * Start the Groups Template Loop
     420 * Start the Groups Template Loop.
    311421 *
    312422 * @since BuddyPress (1.0.0)
    … …  
    348458 *           results. Default: false.
    349459 * }
    350  *
    351460 * @return bool True if there are groups to display that match the params
    352461 */
    … …  
    430539}
    431540
     541/**
     542 * Check whether there are more groups to iterate over.
     543 *
     544 * @return bool
     545 */
    432546function bp_groups() {
    433547    global $groups_template;
    … …  
    435549}
    436550
     551/**
     552 * Set up the current group inside the loop.
     553 *
     554 * @return object
     555 */
    437556function bp_the_group() {
    438557    global $groups_template;
    … …  
    440559}
    441560
     561/**
     562 * Is the group visible to the currently logged-in user?
     563 *
     564 * @param object $group Optional. Group object. Default: current group in loop.
     565 * @return bool
     566 */
    442567function bp_group_is_visible( $group = false ) {
    443568    global $groups_template;
    … …  
    460585}
    461586
     587/**
     588 * Output the ID of the current group in the loop.
     589 *
     590 * @param object $group Optional. Group object. Default: current group in loop.
     591 */
    462592function bp_group_id( $group = false ) {
    463593    echo bp_get_group_id( $group );
    464594}
     595    /**
     596     * Get the ID of the current group in the loop.
     597     *
     598     * @param object $group Optional. Group object. Default: current
     599     *        group in loop.
     600     * @return int
     601     */
    465602    function bp_get_group_id( $group = false ) {
    466603        global $groups_template;
    … …  
    473610
    474611/**
    475  * Output the row class of a group
    476  *
    477  * @since BuddyPress (1.7)
     612 * Output the row class of the current group in the loop.
     613 *
     614 * @since BuddyPress (1.7.0)
    478615 */
    479616function bp_group_class() {
    … …  
    481618}
    482619    /**
    483      * Return the row class of a group
    484      *
    485      * @global BP_Groups_Template $groups_template
    486      * @return string Row class of the group
    487      * @since BuddyPress (1.7)
     620     * Get the row class of the current group in the loop.
     621     *
     622     * @since BuddyPress (1.7.0)
     623     *
     624     * @return string Row class of the group.
    488625     */
    489626    function bp_get_group_class() {
    … …  
    521658    }
    522659
     660/**
     661 * Output the name of the current group in the loop.
     662 *
     663 * @param object $group Optional. Group object. Default: current
     664 *        group in loop.
     665 */
    523666function bp_group_name( $group = false ) {
    524667    echo bp_get_group_name( $group );
    525668}
     669    /**
     670     * Get the name of the current group in the loop.
     671     *
     672     * @param object $group Optional. Group object. Default: current
     673     *        group in loop.
     674     * @return string
     675     */
    526676    function bp_get_group_name( $group = false ) {
    527677        global $groups_template;
    … …  
    533683    }
    534684
     685/**
     686 * Output the type of the current group in the loop.
     687 *
     688 * @param object $group Optional. Group object. Default: current
     689 *        group in loop.
     690 */
    535691function bp_group_type( $group = false ) {
    536692    echo bp_get_group_type( $group );
    537693}
     694    /**
     695     * Get the type of the current group in the loop.
     696     *
     697     * @param object $group Optional. Group object. Default: current
     698     *        group in loop.
     699     * @return string
     700     */
    538701    function bp_get_group_type( $group = false ) {
    539702        global $groups_template;
    … …  
    555718    }
    556719
     720/**
     721 * Output the status of the current group in the loop.
     722 *
     723 * @param object $group Optional. Group object. Default: current
     724 *        group in loop.
     725 */
    557726function bp_group_status( $group = false ) {
    558727    echo bp_get_group_status( $group );
    559728}
     729    /**
     730     * Get the status of the current group in the loop.
     731     *
     732     * @param object $group Optional. Group object. Default: current
     733     *        group in loop.
     734     * @return string
     735     */
    560736    function bp_get_group_status( $group = false ) {
    561737        global $groups_template;
    … …  
    572748 * @since BuddyPress (1.0.0)
    573749 *
    574  * @param array $args {@see bp_core_fetch_avatar()}
     750 * @param array $args {
     751 *      See {@link bp_get_group_avatar()} for description of arguments.
     752 * }
    575753 */
    576754function bp_group_avatar( $args = '' ) {
    … …  
    582760     * @since BuddyPress (1.0.0)
    583761     *
    584      * @param array $args {@see bp_core_fetch_avatar()}
     762     * @param array $args {
     763     *     Array of arguments. See {@link bp_core_fetch_avatar()} for
     764     *     detailed description. Default values that differ from that
     765     *     function are described below.
     766     *     @type string $type Default: 'full'.
     767     *     @type string $id Passed to $css_id parameter.
     768     * }
     769     * @return string
    585770     */
    586771    function bp_get_group_avatar( $args = '' ) {
    … …  
    630815 * @since BuddyPress (1.0.0)
    631816 *
    632  * @param object $group Single group object
     817 * @param object $group Optional. Group object. Default: current
     818 *        group in loop.
    633819 */
    634820function bp_group_avatar_thumb( $group = false ) {
    … …  
    640826     * @since BuddyPress (1.0.0)
    641827     *
    642      * @param object $group Single group object
     828     * @param object $group Optional. Group object. Default: current
     829     *        group in loop.
     830     * @return string
    643831     */
    644832    function bp_get_group_avatar_thumb( $group = false ) {
    … …  
    654842 * @since BuddyPress (1.0.0)
    655843 *
    656  * @param object $group Single group object
     844 * @param object $group Optional. Group object. Default: current
     845 *        group in loop.
    657846 */
    658847function bp_group_avatar_mini( $group = false ) {
    … …  
    664853     * @since BuddyPress (1.0.0)
    665854     *
    666      * @param object $group Single group object
     855     * @param object $group Optional. Group object. Default: current
     856     *        group in loop.
    667857     */
    668858    function bp_get_group_avatar_mini( $group = false ) {
    … …  
    675865    }
    676866
     867/**
     868 * Output the 'last active' string for the current group in the loop.
     869 *
     870 * @param object $group Optional. Group object. Default: current
     871 *        group in loop.
     872 */
    677873function bp_group_last_active( $group = false ) {
    678874    echo bp_get_group_last_active( $group );
    679875}
     876    /**
     877     * Return the 'last active' string for the current group in the loop.
     878     *
     879     * @param object $group Optional. Group object. Default: current
     880     *        group in loop.
     881     * @return string
     882     */
    680883    function bp_get_group_last_active( $group = false ) {
    681884        global $groups_template;
    … …  
    696899    }
    697900
     901/**
     902 * Output the permalink for the current group in the loop.
     903 *
     904 * @param object $group Optional. Group object. Default: current
     905 *        group in loop.
     906 */
    698907function bp_group_permalink( $group = false ) {
    699908    echo bp_get_group_permalink( $group );
    700909}
     910    /**
     911     * Return the permalink for the current group in the loop.
     912     *
     913     * @param object $group Optional. Group object. Default: current
     914     *        group in loop.
     915     * @return string
     916     */
    701917    function bp_get_group_permalink( $group = false ) {
    702918        global $groups_template;
    … …  
    708924    }
    709925
     926/**
     927 * Output the permalink for the admin section of the current group in the loop.
     928 *
     929 * @param object $group Optional. Group object. Default: current
     930 *        group in loop.
     931 */
    710932function bp_group_admin_permalink( $group = false ) {
    711933    echo bp_get_group_admin_permalink( $group );
    712934}
     935    /**
     936     * Return the permalink for the admin section of the current group in the loop.
     937     *
     938     * @param object $group Optional. Group object. Default: current
     939     *        group in loop.
     940     * @return string
     941     */
    713942    function bp_get_group_admin_permalink( $group = false ) {
    714943        global $groups_template;
    … …  
    720949    }
    721950
     951/**
     952 * Return the slug for the current group in the loop.
     953 *
     954 * @param object $group Optional. Group object. Default: current
     955 *        group in loop.
     956 */
    722957function bp_group_slug( $group = false ) {
    723958    echo bp_get_group_slug( $group );
    724959}
     960    /**
     961     * Return the slug for the current group in the loop.
     962     *
     963     * @param object $group Optional. Group object. Default: current
     964     *        group in loop.
     965     * @return string
     966     */
    725967    function bp_get_group_slug( $group = false ) {
    726968        global $groups_template;
    … …  
    732974    }
    733975
     976/**
     977 * Output the description for the current group in the loop.
     978 *
     979 * @param object $group Optional. Group object. Default: current
     980 *        group in loop.
     981 */
    734982function bp_group_description( $group = false ) {
    735983    echo bp_get_group_description( $group );
    736984}
     985    /**
     986     * Return the description for the current group in the loop.
     987     *
     988     * @param object $group Optional. Group object. Default: current
     989     *        group in loop.
     990     * @return string
     991     */
    737992    function bp_get_group_description( $group = false ) {
    738993        global $groups_template;
    … …  
    744999    }
    7451000
     1001/**
     1002 * Output the description for the current group in the loop, for use in a textarea.
     1003 *
     1004 * @param object $group Optional. Group object. Default: current
     1005 *        group in loop.
     1006 */
    7461007function bp_group_description_editable( $group = false ) {
    7471008    echo bp_get_group_description_editable( $group );
    7481009}
     1010    /**
     1011     * Return the permalink for the current group in the loop, for use in a textarea.
     1012     *
     1013     * 'bp_get_group_description_editable' does not have the formatting
     1014     * filters that 'bp_get_group_description' has, which makes it
     1015     * appropriate for "raw" editing.
     1016     *
     1017     * @param object $group Optional. Group object. Default: current
     1018     *        group in loop.
     1019     * @return string
     1020     */
    7491021    function bp_get_group_description_editable( $group = false ) {
    7501022        global $groups_template;
    … …  
    7821054    }
    7831055
    784 
     1056/**
     1057 * Output the status of the current group in the loop.
     1058 *
     1059 * Either 'Public' or 'Private'.
     1060 *
     1061 * @param object $group Optional. Group object. Default: current
     1062 *        group in loop.
     1063 */
    7851064function bp_group_public_status( $group = false ) {
    7861065    echo bp_get_group_public_status( $group );
    7871066}
     1067    /**
     1068     * Return the status of the current group in the loop.
     1069     *
     1070     * Either 'Public' or 'Private'.
     1071     *
     1072     * @param object $group Optional. Group object. Default: current
     1073     *        group in loop.
     1074     * @return string
     1075     */
    7881076    function bp_get_group_public_status( $group = false ) {
    7891077        global $groups_template;
    … …  
    7991087    }
    8001088
     1089/**
     1090 * Output whether the current group in the loop is public.
     1091 *
     1092 * No longer used in BuddyPress.
     1093 *
     1094 * @param object $group Optional. Group object. Default: current
     1095 *        group in loop.
     1096 */
    8011097function bp_group_is_public( $group = false ) {
    8021098    echo bp_get_group_is_public( $group );
    8031099}
     1100    /**
     1101     * Return whether the current group in the loop is public.
     1102     *
     1103     * No longer used in BuddyPress.
     1104     *
     1105     * @param object $group Optional. Group object. Default: current
     1106     *        group in loop.
     1107     * @return unknown
     1108     */
    8041109    function bp_get_group_is_public( $group = false ) {
    8051110        global $groups_template;
    … …  
    8111116    }
    8121117
     1118/**
     1119 * Output the created date of the current group in the loop.
     1120 *
     1121 * @param object $group Optional. Group object. Default: current
     1122 *        group in loop.
     1123 */
    8131124function bp_group_date_created( $group = false ) {
    8141125    echo bp_get_group_date_created( $group );
    8151126}
     1127    /**
     1128     * Return the created date of the current group in the loop.
     1129     *
     1130     * @param object $group Optional. Group object. Default: current
     1131     *        group in loop.
     1132     * @return string
     1133     */
    8161134    function bp_get_group_date_created( $group = false ) {
    8171135        global $groups_template;
    … …  
    8231141    }
    8241142
     1143/**
     1144 * Output the username of the creator of the current group in the loop.
     1145 *
     1146 * @param object $group Optional. Group object. Default: current
     1147 *        group in loop.
     1148 */
    8251149function bp_group_creator_username( $group = false ) {
    8261150    echo bp_get_group_creator_username( $group );
    8271151}
     1152    /**
     1153     * Return the username of the creator of the current group in the loop.
     1154     *
     1155     * @param object $group Optional. Group object. Default: current
     1156     *        group in loop.
     1157     * @return string
     1158     */
    8281159    function bp_get_group_creator_username( $group = false ) {
    8291160        global $groups_template;
    … …  
    8351166    }
    8361167
     1168/**
     1169 * Output the user ID of the creator of the current group in the loop.
     1170 *
     1171 * @param object $group Optional. Group object. Default: current
     1172 *        group in loop.
     1173 */
    8371174function bp_group_creator_id( $group = false ) {
    8381175    echo bp_get_group_creator_id( $group );
    8391176}
     1177    /**
     1178     * Return the user ID of the creator of the current group in the loop.
     1179     *
     1180     * @param object $group Optional. Group object. Default: current
     1181     *        group in loop.
     1182     * @return int
     1183     */
    8401184    function bp_get_group_creator_id( $group = false ) {
    8411185        global $groups_template;
    … …  
    8471191    }
    8481192
     1193/**
     1194 * Output the permalink of the creator of the current group in the loop.
     1195 *
     1196 * @param object $group Optional. Group object. Default: current
     1197 *        group in loop.
     1198 */
    8491199function bp_group_creator_permalink( $group = false ) {
    8501200    echo bp_get_group_creator_permalink( $group );
    8511201}
     1202    /**
     1203     * Return the permalink of the creator of the current group in the loop.
     1204     *
     1205     * @param object $group Optional. Group object. Default: current
     1206     *        group in loop.
     1207     * @return string
     1208     */
    8521209    function bp_get_group_creator_permalink( $group = false ) {
    8531210        global $groups_template;
    … …  
    8591216    }
    8601217
     1218/**
     1219 * Determine whether a user is the creator of the current group in the loop.
     1220 *
     1221 * @param object $group Optional. Group object. Default: current
     1222 *        group in loop.
     1223 * @param int $user_id ID of the user.
     1224 * @return bool
     1225 */
    8611226function bp_is_group_creator( $group = false, $user_id = 0 ) {
    8621227    global $groups_template;
    … …  
    8711236}
    8721237
     1238/**
     1239 * Output the avatar of the creator of the current group in the loop.
     1240 *
     1241 * @param object $group Optional. Group object. Default: current
     1242 *        group in loop.
     1243 * @param array $args {
     1244 *     Array of optional arguments. See {@link bp_get_group_creator_avatar()}
     1245 *     for description.
     1246 * }
     1247 */
    8731248function bp_group_creator_avatar( $group = false, $args = array() ) {
    8741249    echo bp_get_group_creator_avatar( $group, $args );
    8751250}
     1251    /**
     1252     * Return the avatar of the creator of the current group in the loop.
     1253     *
     1254     * @param object $group Optional. Group object. Default: current
     1255     *        group in loop.
     1256     * @param array $args {
     1257     *     Array of optional arguments. See {@link bp_core_fetch_avatar()}
     1258     *     for detailed description of arguments.
     1259     *     @type string $type Default: 'full'.
     1260     *     @type int $width Default: false.
     1261     *     @type int $height Default: false.
     1262     *     @type int $class Default: 'avatar'.
     1263     *     @type string $id Passed to 'css_id'. Default: false.
     1264     *     @type string $alt Alt text. Default: 'Group creator profile
     1265     *           photo of [user display name]'.
     1266     * }
     1267     * @return string
     1268     */
    8761269    function bp_get_group_creator_avatar( $group = false, $args = array() ) {
    8771270        global $groups_template;
    … …  
    8971290    }
    8981291
    899 
     1292/**
     1293 * Determine whether the current user is the admin of the current group.
     1294 *
     1295 * Alias of {@link bp_is_item_admin()}.
     1296 *
     1297 * @return bool
     1298 */
    9001299function bp_group_is_admin() {
    9011300    return bp_is_item_admin();
    9021301}
    9031302
     1303/**
     1304 * Determine whether the current user is a mod of the current group.
     1305 *
     1306 * Alias of {@link bp_is_item_mod()}.
     1307 *
     1308 * @return bool
     1309 */
    9041310function bp_group_is_mod() {
    9051311    return bp_is_item_mod();
    9061312}
    9071313
     1314/**
     1315 * Output markup listing group admins.
     1316 *
     1317 * @param object $group Optional. Group object. Default: current
     1318 *        group in loop.
     1319 */
    9081320function bp_group_list_admins( $group = false ) {
    9091321    global $groups_template;
    … …  
    9401352}
    9411353
     1354/**
     1355 * Output markup listing group mod.
     1356 *
     1357 * @param object $group Optional. Group object. Default: current
     1358 *        group in loop.
     1359 */
    9421360function bp_group_list_mods( $group = false ) {
    9431361    global $groups_template;
    … …  
    9831401
    9841402/**
    985  * Return a list of user_ids for a group's admins
    986  *
    987  * @package BuddyPress
    988  * @since BuddyPress (1.5)
    989  *
    990  * @param BP_Groups_Group $group (optional) The group being queried. Defaults to the current group in the loop
    991  * @param string $format 'string' to get a comma-separated string, 'array' to get an array
    992  * @return mixed $admin_ids A string or array of user_ids
     1403 * Return a list of user IDs for a group's admins.
     1404 *
     1405 * @since BuddyPress (1.5.0)
     1406 *
     1407 * @param BP_Groups_Group $group Optional. The group being queried. Defaults
     1408 *        to the current group in the loop.
     1409 * @param string $format Optional. 'string' to get a comma-separated string,
     1410 *        'array' to get an array.
     1411 * @return mixed $admin_ids A string or array of user IDs.
    9931412 */
    9941413function bp_group_admin_ids( $group = false, $format = 'string' ) {
    … …  
    10131432
    10141433/**
    1015  * Return a list of user_ids for a group's moderators
    1016  *
    1017  * @package BuddyPress
    1018  * @since BuddyPress (1.5)
    1019  *
    1020  * @param BP_Groups_Group $group (optional) The group being queried. Defaults to the current group in the loop
    1021  * @param string $format 'string' to get a comma-separated string, 'array' to get an array
    1022  * @return mixed $mod_ids A string or array of user_ids
     1434 * Return a list of user IDs for a group's moderators.
     1435 *
     1436 * @since BuddyPress (1.5.0)
     1437 *
     1438 * @param BP_Groups_Group $group Optional. The group being queried. Defaults
     1439 *        to the current group in the loop.
     1440 * @param string $format Optional. 'string' to get a comma-separated string,
     1441 *        'array' to get an array.
     1442 * @return mixed $mod_ids A string or array of user IDs.
    10231443 */
    10241444function bp_group_mod_ids( $group = false, $format = 'string' ) {
    … …  
    10421462}
    10431463
     1464/**
     1465 * Output the permalink of the current group's Members page.
     1466 */
    10441467function bp_group_all_members_permalink() {
    10451468    echo bp_get_group_all_members_permalink();
    10461469}
     1470    /**
     1471     * Return the permalink of the Members page of the current group in the loop.
     1472     *
     1473     * @param object $group Optional. Group object. Default: current
     1474     *        group in loop.
     1475     * @return string
     1476     */
    10471477    function bp_get_group_all_members_permalink( $group = false ) {
    10481478        global $groups_template;
    … …  
    10541484    }
    10551485
     1486/**
     1487 * Display a Groups search form.
     1488 *
     1489 * No longer used in BuddyPress.
     1490 *
     1491 * @todo Deprecate
     1492 */
    10561493function bp_group_search_form() {
    10571494    global $bp;
    … …  
    12541691 * Get the 'checked' value, if needed, for a given invite_status on the group create/admin screens
    12551692 *
    1256  * @package BuddyPress
    1257  * @subpackage Groups Template
    1258  * @since BuddyPress (1.5)
     1693 * @since BuddyPress (1.5.0)
    12591694 *
    12601695 * @param string $setting The setting you want to check against ('members', 'mods', or 'admins')
    … …  
    12791714 * This function can be used either in or out of the loop.
    12801715 *
    1281  * @package BuddyPress
    1282  * @subpackage Groups Template
    1283  * @since BuddyPress (1.5)
     1716 * @since BuddyPress (1.5.0)
    12841717 *
    12851718 * @param int $group_id (optional) The id of the group whose status you want to check
    … …  
    13151748 * Can the logged-in user send invitations in the specified group?
    13161749 *
    1317  * @package BuddyPress
    1318  * @subpackage Groups Template
    1319  * @since BuddyPress (1.5)
     1750 * @since BuddyPress (1.5.0)
    13201751 *
    13211752 * @param int $group_id (optional) The id of the group whose status you want to check
    … …  
    13741805 * @deprecated 1.5
    13751806 * @deprecated No longer used.
    1376  * @since BuddyPress (1.0)
     1807 * @since BuddyPress (1.0.0)
    13771808 * @todo Remove in 1.4
    13781809 */
    … …  
    20962527 * @global BP_Groups_Template $groups_template Groups template object
    20972528 * @param object $group Group to get status message for. Optional; defaults to current group.
    2098  * @since BuddyPress (1.0)
     2529 * @since BuddyPress (1.0.0)
    20992530 */
    21002531function bp_group_status_message( $group = null ) {
    … …  
    26813112 * Determine if the current logged in user can create groups.
    26823113 *
    2683  * @package BuddyPress Groups
    2684  * @since BuddyPress (1.5)
     3114 * @since BuddyPress (1.5.0)
    26853115 *
    26863116 * @uses apply_filters() To call 'bp_user_can_create_groups'.
    … …  
    29213351 * Echoes the current group creation step
    29223352 *
    2923  * @since BuddyPress (1.6)
     3353 * @since BuddyPress (1.6.0)
    29243354 */
    29253355function bp_groups_current_create_step() {
    … …  
    29293359     * Returns the current group creation step. If none is found, returns an empty string
    29303360     *
    2931      * @since BuddyPress (1.6)
     3361     * @since BuddyPress (1.6.0)
    29323362     *
    29333363     * @uses apply_filters() Filter bp_get_groups_current_create_step to modify
    … …  
    30283458 * Displays group header tabs
    30293459 *
    3030  * @package BuddyPress
    30313460 * @todo Deprecate?
    30323461 */
    … …  
    30483477 * Displays group filter titles
    30493478 *
    3050  * @package BuddyPress
    30513479 * @todo Deprecate?
    30523480 */
    … …  
    30803508 * Is the current page a specific group admin screen?
    30813509 *
    3082  * @since BuddyPress (1.1)
     3510 * @since BuddyPress (1.1.0)
    30833511 *
    30843512 * @param string $slug
    … …  
    30923520 * Echoes the current group admin tab slug
    30933521 *
    3094  * @since BuddyPress (1.6)
     3522 * @since BuddyPress (1.6.0)
    30953523 */
    30963524function bp_group_current_admin_tab() {
    … …  
    31003528     * Returns the current group admin tab slug
    31013529     *
    3102      * @since BuddyPress (1.6)
     3530     * @since BuddyPress (1.6.0)
    31033531     *
    31043532     * @uses apply_filters() Filter bp_get_current_group_admin_tab to modify return value
    … …  
    31223550 * Outputs the current group avatar
    31233551 *
    3124  * @since BuddyPress (1.0)
     3552 * @since BuddyPress (1.0.0)
    31253553 * @param string $type thumb or full ?
    31263554 * @uses bp_get_group_current_avatar() to get the avatar of the current group
    … …  
    37894217 * Hook group activity feed to <head>
    37904218 *
    3791  * @since BuddyPress (1.5)
     4219 * @since BuddyPress (1.5.0)
    37924220 */
    37934221function bp_groups_activity_feed() {
    … …  
    38114239 * Echoes the output of bp_get_current_group_id()
    38124240 *
    3813  * @package BuddyPress
    3814  * @since BuddyPress (1.5)
     4241 * @since BuddyPress (1.5.0)
    38154242 */
    38164243function bp_current_group_id() {
    … …  
    38204247     * Returns the ID of the current group
    38214248     *
    3822      * @package BuddyPress
    3823      * @since BuddyPress (1.5)
     4249     * @since BuddyPress (1.5.0)
    38244250     * @uses apply_filters() Filter bp_get_current_group_id to modify this output
    38254251     *
    … …  
    38364262 * Echoes the output of bp_get_current_group_slug()
    38374263 *
    3838  * @package BuddyPress
    3839  * @since BuddyPress (1.5)
     4264 * @since BuddyPress (1.5.0)
    38404265 */
    38414266function bp_current_group_slug() {
    … …  
    38454270     * Returns the slug of the current group
    38464271     *
    3847      * @package BuddyPress
    3848      * @since BuddyPress (1.5)
     4272     * @since BuddyPress (1.5.0)
    38494273     * @uses apply_filters() Filter bp_get_current_group_slug to modify this output
    38504274     *
    … …  
    38614285 * Echoes the output of bp_get_current_group_name()
    38624286 *
    3863  * @package BuddyPress
    38644287 */
    38654288function bp_current_group_name() {
    … …  
    38694292     * Returns the name of the current group
    38704293     *
    3871      * @package BuddyPress
    3872      * @since BuddyPress (1.5)
     4294     * @since BuddyPress (1.5.0)
    38734295     * @uses apply_filters() Filter bp_get_current_group_name to modify this output
    38744296     *
    … …  
    38864308 * Echoes the output of bp_get_current_group_description()
    38874309 *
    3888  * @package BuddyPress
    38894310 * @since BuddyPress (2.1.0)
    38904311 */
    … …  
    38954316     * Returns the description of the current group
    38964317     *
    3897      * @package BuddyPress
    38984318     * @since BuddyPress (2.1.0)
    38994319     * @uses apply_filters() Filter bp_get_current_group_description to modify
    … …  
    39134333 * Output a URL for a group component action
    39144334 *
    3915  * @since BuddyPress (1.2)
     4335 * @since BuddyPress (1.2.0)
    39164336 *
    39174337 * @param string $action
    … …  
    39264346     * Get a URL for a group component action
    39274347     *
    3928      * @since BuddyPress (1.2)
     4348     * @since BuddyPress (1.2.0)
    39294349     *
    39304350     * @param string $action
Note: See TracChangeset for help on using the changeset viewer.