Changeset 10148 for trunk/src/bpgroups/bpgroupsfunctions.php
 Timestamp:
 09/27/2015 05:25:02 AM (9 years ago)
 File:

 1 edited
Legend:
 Unmodified
 Added
 Removed

trunk/src/bpgroups/bpgroupsfunctions.php
r9907 r10148 1 1 <?php 2 3 2 /** 4 3 * BuddyPress Groups Functions. … … 13 12 */ 14 13 15 // Exit if accessed directly 14 // Exit if accessed directly. 16 15 defined( 'ABSPATH' )  exit; 17 16 … … 19 18 * Check whether there is a Groups directory page in the $bp global. 20 19 * 21 * @since BuddyPress (1.5.0)20 * @since 1.5.0 22 21 * 23 22 * @return bool True if set, False if empty. … … 62 61 * Filters a single group object. 63 62 * 64 * @since BuddyPress (1.2.0)63 * @since 1.2.0 65 64 * 66 65 * @param BP_Groups_Group $group Single group object. … … 74 73 * Create a group. 75 74 * 76 * @since BuddyPress (1.0.0)75 * @since 1.0.0 77 76 * 78 77 * @param arraystring $args { … … 172 171 * Fires after the creation of a new group and a group creator needs to be made. 173 172 * 174 * @since BuddyPress (1.5.0)173 * @since 1.5.0 175 174 * 176 175 * @param int $id ID of the newly created group. … … 186 185 * Fires after the update of a group. 187 186 * 188 * @since BuddyPress (1.5.0)187 * @since 1.5.0 189 188 * 190 189 * @param int $id ID of the updated group. … … 197 196 * Fires after the creation or update of a group. 198 197 * 199 * @since BuddyPress (1.0.0)198 * @since 1.0.0 200 199 * 201 200 * @param int $id ID of the newly created group. … … 242 241 * Fired after a group's details are updated. 243 242 * 244 * @since BuddyPress (2.2.0)243 * @since 2.2.0 245 244 * 246 245 * @param int $value ID of the group. … … 301 300 * Fires after the update of a groups settings. 302 301 * 303 * @since BuddyPress (1.0.0)302 * @since 1.0.0 304 303 * 305 304 * @param int $id ID of the group that was updated. … … 313 312 * Delete a group and all of its associated metadata. 314 313 * 315 * @since BuddyPress (1.0.0)314 * @since 1.0.0 316 315 * 317 316 * @param int $group_id ID of the group to delete. … … 324 323 * Fires before the deletion of a group. 325 324 * 326 * @since BuddyPress (1.5.0)325 * @since 1.5.0 327 326 * 328 327 * @param int $group_id ID of the group to be deleted. … … 344 343 * Fires after the deletion of a group. 345 344 * 346 * @since BuddyPress (1.0.0)345 * @since 1.0.0 347 346 * 348 347 * @param int $group_id ID of the group that was deleted. … … 407 406 * Get a group ID by its slug. 408 407 * 409 * @since BuddyPress (1.6.0)408 * @since 1.6.0 410 409 * 411 410 * @param string $group_slug The group's slug. … … 450 449 * Fires after a user leaves a group. 451 450 * 452 * @since BuddyPress (1.0.0)451 * @since 1.0.0 453 452 * 454 453 * @param int $group_id ID of the group. … … 515 514 * Fires after a user joins a group. 516 515 * 517 * @since BuddyPress (1.0.0)516 * @since 1.0.0 518 517 * 519 518 * @param int $group_id ID of the group. … … 719 718 * Filters the collection of groups based on parsed parameters. 720 719 * 721 * @since BuddyPress (1.2.0)720 * @since 1.2.0 722 721 * 723 722 * @param BP_Groups_Group $groups Object of found groups based on parameters. … … 791 790 * Get the BP_Groups_Group object corresponding to the current group. 792 791 * 793 * @since BuddyPress (1.5.0)792 * @since 1.5.0 794 793 * 795 794 * @return BP_Groups_Group The current group object. … … 805 804 * Filters the BP_Groups_Group object corresponding to the current group. 806 805 * 807 * @since BuddyPress (1.5.0)806 * @since 1.5.0 808 807 * 809 808 * @param BP_Groups_Group $current_group Current BP_Groups_Group object. … … 837 836 * Filters the avatar upload directory path for a given group. 838 837 * 839 * @since BuddyPress (1.1.0)838 * @since 1.1.0 840 839 * 841 840 * @param array $value Array of parts related to the groups avatar upload directory. … … 896 895 * Is the specified user the creator of the group? 897 896 * 898 * @since BuddyPress (1.2.6)897 * @since 1.2.6 899 898 * 900 899 * @param int $user_id ID of the user. … … 955 954 * Filters the action for the new group activity update. 956 955 * 957 * @since BuddyPress (1.2.0)956 * @since 1.2.0 958 957 * 959 958 * @param string $activity_action The new group activity update. … … 964 963 * Filters the content for the new group activity update. 965 964 * 966 * @since BuddyPress (1.2.0)965 * @since 1.2.0 967 966 * 968 967 * @param string $activity_content The content of the update. … … 983 982 * Fires after posting of an Activity status update affiliated with a group. 984 983 * 985 * @since BuddyPress (1.2.0)984 * @since 1.2.0 986 985 * 987 986 * @param string $content The content of the update. … … 1019 1018 * Get the total group invite count for a user. 1020 1019 * 1021 * @since BuddyPress (2.0.0)1020 * @since 2.0.0 1022 1021 * 1023 1022 * @param int $user_id The user ID. … … 1084 1083 * Fires after the creation of a new group invite. 1085 1084 * 1086 * @since BuddyPress (1.0.0)1085 * @since 1.0.0 1087 1086 * 1088 1087 * @param array $args Array of parsed arguments for the group invite. … … 1112 1111 * Fires after uninviting a user from a group. 1113 1112 * 1114 * @since BuddyPress (1.0.0)1113 * @since 1.0.0 1115 1114 * 1116 1115 * @param int $group_id ID of the group being uninvited from. … … 1166 1165 * Fires after a user has accepted a group invite. 1167 1166 * 1168 * @since BuddyPress (1.0.0)1167 * @since 1.0.0 1169 1168 * 1170 1169 * @param int $user_id ID of the user who accepted the group invite. … … 1191 1190 * Fires after a user rejects a group invitation. 1192 1191 * 1193 * @since BuddyPress (1.0.0)1192 * @since 1.0.0 1194 1193 * 1195 1194 * @param int $user_id ID of the user rejecting the invite. … … 1216 1215 * Fires after the deletion of a group invitation. 1217 1216 * 1218 * @since BuddyPress (1.9.0)1217 * @since 1.9.0 1219 1218 * 1220 1219 * @param int $user_id ID of the user whose invitation is being deleted. … … 1254 1253 * Fires after the sending of invites for a group. 1255 1254 * 1256 * @since BuddyPress (1.0.0)1255 * @since 1.0.0 1257 1256 * 1258 1257 * @param int $group_id ID of the group who's being invited to. … … 1328 1327 * Fires before the promotion of a user to a new status. 1329 1328 * 1330 * @since BuddyPress (1.6.0)1329 * @since 1.6.0 1331 1330 * 1332 1331 * @param int $group_id ID of the group being promoted in. … … 1357 1356 * Fires before the demotion of a user to 'member'. 1358 1357 * 1359 * @since BuddyPress (1.0.0)1358 * @since 1.0.0 1360 1359 * 1361 1360 * @param int $group_id ID of the group being demoted in. … … 1385 1384 * Fires before the banning of a member from a group. 1386 1385 * 1387 * @since BuddyPress (1.0.0)1386 * @since 1.0.0 1388 1387 * 1389 1388 * @param int $group_id ID of the group being banned from. … … 1413 1412 * Fires before the unbanning of a member from a group. 1414 1413 * 1415 * @since BuddyPress (1.0.0)1414 * @since 1.0.0 1416 1415 * 1417 1416 * @param int $group_id ID of the group being unbanned from. … … 1451 1450 * Fires before the removal of a member from a group. 1452 1451 * 1453 * @since BuddyPress (1.2.6)1452 * @since 1.2.6 1454 1453 * 1455 1454 * @param int $group_id ID of the group being removed from. … … 1507 1506 * Fires after the creation of a new membership request. 1508 1507 * 1509 * @since BuddyPress (1.0.0)1508 * @since 1.0.0 1510 1509 * 1511 1510 * @param int $requesting_user_id ID of the user requesting membership. … … 1557 1556 * Fires after a group membership request has been accepted. 1558 1557 * 1559 * @since BuddyPress (1.0.0)1558 * @since 1.0.0 1560 1559 * 1561 1560 * @param int $user_id ID of the user who accepted membership. … … 1589 1588 * Fires after a group membership request has been rejected. 1590 1589 * 1591 * @since BuddyPress (1.0.0)1590 * @since 1.0.0 1592 1591 * 1593 1592 * @param int $user_id ID of the user who rejected membership. … … 1656 1655 * Fires after the acceptance of all pending membership requests to a group. 1657 1656 * 1658 * @since BuddyPress (1.0.2)1657 * @since 1.0.2 1659 1658 * 1660 1659 * @param int $group_id ID of the group whose pending memberships were accepted. … … 1750 1749 * Add a piece of group metadata. 1751 1750 * 1752 * @since BuddyPress (2.0.0)1751 * @since 2.0.0 1753 1752 * 1754 1753 * @param int $group_id ID of the group. 1755 1754 * @param string $meta_key Metadata key. 1756 1755 * @param mixed $meta_value Metadata value. 1757 * @param bool $unique .Optional. Whether to enforce a single metadata value1756 * @param bool $unique Optional. Whether to enforce a single metadata value 1758 1757 * for the given key. If true, and the object already 1759 1758 * has a value for the key, no change will be made. … … 1775 1774 * Delete all group membership information for the specified user. 1776 1775 * 1777 * @since BuddyPress (1.0.0)1776 * @since 1.0.0 1778 1777 * 1779 1778 * @param int $user_id ID of the user. … … 1785 1784 * Fires after the deletion of all data for a user. 1786 1785 * 1787 * @since BuddyPress (1.1.0)1786 * @since 1.1.0 1788 1787 * 1789 1788 * @param int $user_id ID of the user whose data is being deleted.
Note: See TracChangeset
for help on using the changeset viewer.