Skip to:
Content

BuddyPress.org


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

Second documentation cleanup pass for the BP Groups component.

See #@6401.

File:
1 edited

Legend:

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

    r9906 r9907  
    11<?php
    22/**
    3  * BuddyPress Groups component admin screen
     3 * BuddyPress Groups component admin screen.
    44 *
    55 * Props to WordPress core for the Comments admin screen, and its contextual
     
    5252 *
    5353 * @param array $custom_menus Array of BP top-level menu items.
     54 *
    5455 * @return array Menu item array, with Groups added.
    5556 */
     
    247248        $status         = ( in_array( $_POST['group-status'], (array) $allowed_status ) ) ? $_POST['group-status'] : 'public';
    248249
    249         // Invite status
    250250        /**
    251251         * Filters the allowed invite status values for the group.
     
    434434 * @since BuddyPress (1.7.0)
    435435 *
    436  * @param string $value Will always be false unless another plugin filters it first.
    437  * @param string $option Screen option name.
     436 * @param string $value     Will always be false unless another plugin filters it first.
     437 * @param string $option    Screen option name.
    438438 * @param string $new_value Screen option form value.
     439 *
    439440 * @return string Option value. False to abandon update.
    440441 */
     
    814815 * @since BuddyPress (1.7.0)
    815816 *
    816  * @param BP_Groups_Group $item The BP_Groups_Group object for the current
    817  *        group.
     817 * @param BP_Groups_Group $item The BP_Groups_Group object for the current group.
    818818 */
    819819function bp_groups_admin_edit_metabox_members( $item ) {
     
    10051005 * @since BuddyPress (1.8.0)
    10061006 *
    1007  * @param BP_Group_Member_Query $query A BP_Group_Member_Query object.
    1008  * @param string $member_type member|mod|admin|banned.
     1007 * @param BP_Group_Member_Query $query       A BP_Group_Member_Query object.
     1008 * @param string                $member_type member|mod|admin|banned.
     1009 *
    10091010 * @return string Pagination links HTML.
    10101011 */
     
    10631064 *
    10641065 * @param array $user_ids Array of user IDs.
     1066 *
    10651067 * @return array Array of user_logins corresponding to $user_ids.
    10661068 */
     
    11331135     *
    11341136     * @since BuddyPress (1.7.0)
     1137     *
    11351138     * @access public
    11361139     * @var string
     
    11421145     *
    11431146     * @since BuddyPress (1.7.0)
     1147     *
    11441148     * @access public
    11451149     * @var int
     
    14491453
    14501454    /**
    1451      * Get the column names for sortable columns
     1455     * Get the column names for sortable columns.
    14521456     *
    14531457     * Note: It's not documented in WP, but the second item in the
     
    16831687     * @since BuddyPress (2.0.0)
    16841688     *
    1685      * @param array  $item Information about the current row.
     1689     * @param array  $item        Information about the current row.
    16861690     * @param string $column_name The column name.
    16871691     *
Note: See TracChangeset for help on using the changeset viewer.