Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/17/2014 12:39:27 AM (7 years ago)
Author:
boonebgorges
Message:

Improved inline documentation in bp-groups

See #5022

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-groups/bp-groups-classes.php

    r8950 r9026  
    159159     * @param int $id Optional. If the ID of an existing group is provided,
    160160     *        the object will be pre-populated with info about that group.
     161     * @param array $args {
     162     *     Array of optional arguments.
     163     *     @type bool $populate_extras Whether to fetch "extra" data about
     164     *           the group (group admins/mods, access for the current user).
     165     *           Default: false.
     166     * }
    161167     */
    162168    public function __construct( $id = null, $args = array() ) {
     
    14921498     *
    14931499     * @since BuddyPress (1.8.1)
     1500     * @access protected
    14941501     * @var null|array Null if not yet defined, otherwise an array of ints.
    14951502     */
     
    17381745     * @since BuddyPress (1.8.0)
    17391746     *
    1740      * @param object $query BP_User_Query object. Because we're filtering
    1741      *   the current object, we use $this inside of the method instead
     1747     * @param BP_User_Query $query BP_User_Query object. Because we're
     1748     *        filtering the current object, we use $this inside of the
     1749     *        method instead.
    17421750     * @param string $user_ids_sql Sanitized, comma-separated string of
    1743      *   the user ids returned by the main query
     1751     *        the user ids returned by the main query.
    17441752     */
    17451753    public function populate_group_member_extras( $query, $user_ids_sql ) {
     
    17731781     * Sort user IDs by how recently they have generated activity within a given group.
    17741782     *
    1775      * @since  BuddyPress (2.1.0)
     1783     * @since BuddyPress (2.1.0)
    17761784     *
    17771785     * @param BP_User_Query $query BP_User_Query object.
     
    18151823
    18161824/**
    1817  * BuddyPress Group Membership objects.
     1825 * BuddyPress Group Membership object.
    18181826 */
    18191827class BP_Groups_Member {
     
    28412849     *
    28422850     * @since BuddyPress (1.8.0)
     2851     * @access public
    28432852     * @var array
    28442853     */
     
    28492858     *
    28502859     * @since BuddyPress (1.8.0)
     2860     * @access public
    28512861     * @var string
    28522862     */
     
    28572867     *
    28582868     * @since BuddyPress (1.8.0)
     2869     * @access public
    28592870     * @var ReflectionClass
    28602871     */
     
    28652876     *
    28662877     * @since BuddyPress (1.8.0)
     2878     * @access public
    28672879     * @var array
    28682880     */
     
    28732885     *
    28742886     * @since BuddyPress (2.1.0)
     2887     * @access public
    28752888     * @var array
    28762889     */
     
    28812894     *
    28822895     * @since BuddyPress (1.8.0)
     2896     * @access public
    28832897     * @var int
    28842898     */
     
    28882902     * The slug of the current extension.
    28892903     *
     2904     * @access public
    28902905     * @var string
    28912906     */
     
    28952910     * The translatable name of the current extension.
    28962911     *
     2912     * @access public
    28972913     * @var string
    28982914     */
     
    29022918     * The visibility of the extension tab. 'public' or 'private'.
    29032919     *
     2920     * @access public
    29042921     * @var string
    29052922     */
     
    29092926     * The numeric position of the main nav item.
    29102927     *
     2928     * @access public
    29112929     * @var int
    29122930     */
     
    29162934     * Whether to show the nav item.
    29172935     *
     2936     * @access public
    29182937     * @var bool
    29192938     */
     
    29242943     *
    29252944     * @since BuddyPress (2.1.0)
     2945     * @access public
    29262946     * @var bool
    29272947     */
     
    29322952     *
    29332953     * @since BuddyPress (2.1.0)
     2954     * @access public
    29342955     * @var bool
    29352956     */
     
    29392960     * The text of the nav item. Defaults to self::name.
    29402961     *
     2962     * @access public
    29412963     * @var string
    29422964     */
     
    29482970     * Default: 'groups_custom_group_boxes'.
    29492971     *
     2972     * @access public
    29502973     * @var string
    29512974     */
     
    29572980     * Default: 'groups/single/plugins'.
    29582981     *
     2982     * @access public
    29592983     * @var string
    29602984     */
     
    29672991     *
    29682992     * @since BuddyPress (1.8.0)
     2993     * @access protected
    29692994     * @var bool
    29702995     */
     
    29753000     *
    29763001     * @since BuddyPress (1.8.0)
     3002     * @access protected
    29773003     * @var array
    29783004     */
     
    29863012     *
    29873013     * @since BuddyPress (1.8.0)
     3014     * @access protected
    29883015     * @var array
    29893016     */
     
    29943021     *
    29953022     * @since BuddyPress (2.1.0)
     3023     * @access protected
    29963024     * @var string
    29973025     */
     
    30023030     *
    30033031     * @since BuddyPress (1.8.0)
     3032     * @access protected
    30043033     * @var array
    30053034     */
     
    31913220     *
    31923221     * @since BuddyPress (1.8.0)
     3222     *
     3223     * @return int
    31933224     */
    31943225    public static function get_group_id() {
     
    32223253     *
    32233254     * @since BuddyPress (1.8.0)
     3255     *
     3256     * @return array
    32243257     */
    32253258    protected function get_default_screens() {
     
    38593892     * @since BuddyPress (1.8.0)
    38603893     *
    3861      * @uses wp_nonce_field()
    3862      *
    38633894     * @param string $context Screen context. 'create', 'edit', or 'admin'.
    38643895     */
     
    38713902     *
    38723903     * @since BuddyPress (1.8.0)
    3873      *
    3874      * @uses check_admin_referer()
    38753904     *
    38763905     * @param string $context Screen context. 'create', 'edit', or 'admin'.
     
    38903919     *
    38913920     * @param string $context Screen context. 'create', 'edit', or 'admin'.
    3892      *
    38933921     * @return bool True if the screen is enabled, otherwise false.
    38943922     */
     
    43614389     *
    43624390     * @since BuddyPress (2.1.0)
     4391     * @access protected
    43634392     * @var array $args {
    43644393     *     @type int $group_id Positive integers will restrict the search to members in that group.
Note: See TracChangeset for help on using the changeset viewer.