Changeset 9906 for trunk/src/bp-groups/bp-groups-functions.php

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:

• trunk/src/bp-groups/bp-groups-functions.php (modified) (13 diffs)

trunk/src/bp-groups/bp-groups-functions.php

@@ -36 +36 @@
  * support and pass through the groups_get_group filter.
  *
- * @param array $args {
+ * @param array|string $args {
  *  Array of al arguments.
  *  @type int $group_id ID of the group.
@@ -74 +74 @@
  * @since BuddyPress (1.0.0)
  *
- * @param array $args {
+ * @param array|string $args {
  *     An array of arguments.
  *     @type int|bool $group_id Pass a group ID to update an existing item, or
@@ -258 +258 @@
  * @param bool $enable_forum Whether to enable a forum for the group.
  * @param string $status Group status. 'public', 'private', 'hidden'.
- * @param string $invite_status Optional. Who is allowed to send invitations
+ * @param string|bool $invite_status Optional. Who is allowed to send invitations
  *        to the group. 'members', 'mods', or 'admins'.
  * @return bool True on success, false on failure.
@@ -363 +363 @@
  *
  * @param string $slug Group slug to check.
- * @return A unique and sanitized slug.
+ * @return string $slug A unique and sanitized slug.
  */
 function groups_check_slug( $slug ) {
@@ -656 +656 @@
  * Get a collection of groups, based on the parameters passed.
  *
- * @param array $args {
+ * @param array|string $args {
  *     Array of arguments. Supports all arguments of
  *     {@link BP_Groups_Group::get()}. Where the default values differ, they
@@ -735 +735 @@
  *
  * @param int $user_id ID of the user.
- * @param int $limit Optional. Max number of results to return.
+ * @param int $pag_num Optional. Max number of results to return.
  *        Default: false (no limit).
- * @param int $page Optional. Page offset of results to return.
+ * @param int $pag_page Optional. Page offset of results to return.
  *        Default: false (no limit).
  * @return array {
@@ -844 +844 @@
  * @param int $group_id ID of the group.
  * @param int|null ID of the membership if the user is an admin, otherwise null.
+ *
+ * @return bool
  */
 function groups_is_user_admin( $user_id, $group_id ) {
@@ -855 +857 @@
  * @param int $group_id ID of the group.
  * @param int|null ID of the membership if the user is a mod, otherwise null.
+ *
+ * @return bool
  */
 function groups_is_user_mod( $user_id, $group_id ) {
@@ -866 +870 @@
  * @param int $group_id ID of the group.
  * @param int|null ID of the membership if the user is a member, otherwise null.
+ *
+ * @return bool
  */
 function groups_is_user_member( $user_id, $group_id ) {
@@ -895 +901 @@
  * @todo Should bail out when the Activity component is not active.
  *
- * @param array {
+ * @param array|string $args {
  *     Array of arguments.
  *     @type string $content The content of the update.
@@ -982 +988 @@
  *
  * @param int $user_id ID of the inviting user.
- * @param int $group_id ID of the group.
+ * @param int|bool $limit Limit to restrict to.
+ * @param int|bool $page
+ * @param string|array|bool $exclude
+ *
  * @return array IDs of users who have been invited to the group by the
  *         user but have not yet accepted.
@@ -1013 +1022 @@
  * Invite a user to a group.
  *
- * @param array $args {
+ * @param array|string $args {
  *     Array of arguments.
  *     @type int $user_id ID of the user being invited.
@@ -1627 +1636 @@
  *
  * @param int $group_id ID of the group.
- * @param string $meta_key The key of the row to delete.
- * @param string $meta_value Optional. Metadata value. If specified, only delete
+ * @param string|bool $meta_key The key of the row to delete.
+ * @param string|bool $meta_value Optional. Metadata value. If specified, only delete
  *        metadata entries with this value.
  * @param bool $delete_all Optional. If true, delete matching metadata entries