Changeset 10148
- Timestamp:
- 09/27/2015 05:25:02 AM (9 years ago)
- Location:
- trunk/src/bp-groups
- Files:
-
- 19 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/bp-groups/bp-groups-actions.php
r9982 r10148 1 1 <?php 2 3 2 /** 4 3 * BuddyPress Groups Actions. … … 12 11 */ 13 12 14 // Exit if accessed directly 13 // Exit if accessed directly. 15 14 defined( 'ABSPATH' ) || exit; 16 15 … … 18 17 * Protect access to single groups. 19 18 * 20 * @since BuddyPress (2.1.0)19 * @since 2.1.0 21 20 */ 22 21 function bp_groups_group_access_protection() { … … 61 60 * logged-in users being redirected to wp-login.php. 62 61 * 63 * @since BuddyPress (2.1.0)62 * @since 2.1.0 64 63 * 65 64 * @param bool $user_has_access True if the user has access to the … … 195 194 * Filters the allowed invite statuses. 196 195 * 197 * @since BuddyPress (1.5.0)196 * @since 1.5.0 198 197 * 199 198 * @param array $value Array of statuses allowed. … … 226 225 * in the creation process. 227 226 * 228 * @since BuddyPress (1.1.0)227 * @since 1.1.0 229 228 */ 230 229 do_action( 'groups_create_group_step_save_' . bp_get_groups_current_create_step() ); … … 235 234 * Mostly for clearing cache on a generic action name. 236 235 * 237 * @since BuddyPress (1.1.0)236 * @since 1.1.0 238 237 */ 239 238 do_action( 'groups_create_group_step_complete' ); … … 271 270 * Fires after the group has been successfully created. 272 271 * 273 * @since BuddyPress (1.1.0)272 * @since 1.1.0 274 273 * 275 274 * @param int $new_group_id ID of the newly created group. … … 349 348 * Filters the template to load for the group creation screen. 350 349 * 351 * @since BuddyPress (1.0.0)350 * @since 1.0.0 352 351 * 353 352 * @param string $value Path to the group creation template to load. … … 394 393 * Filters the template to load for the single group screen. 395 394 * 396 * @since BuddyPress (1.0.0)395 * @since 1.0.0 397 396 * 398 397 * @param string $value Path to the single group template to load. … … 411 410 * another function handles this. See {@link bp_legacy_theme_ajax_joinleave_group()}. 412 411 * 413 * @since BuddyPress (1.2.4)412 * @since 1.2.4 414 413 */ 415 414 function groups_action_leave_group() { … … 505 504 * Load the activity feed for the current group. 506 505 * 507 * @since BuddyPress (1.2.0)506 * @since 1.2.0 508 507 * 509 508 * @return false|null False on failure. -
trunk/src/bp-groups/bp-groups-activity.php
r9906 r10148 1 1 <?php 2 3 2 /** 4 3 * BuddyPress Groups Activity Functions. … … 11 10 */ 12 11 13 // Exit if accessed directly 12 // Exit if accessed directly. 14 13 defined( 'ABSPATH' ) || exit; 15 14 … … 79 78 * Fires at end of registration of the default activity actions for the Groups component. 80 79 * 81 * @since BuddyPress (1.1.0)80 * @since 1.1.0 82 81 */ 83 82 do_action( 'groups_register_activity_actions' ); … … 88 87 * Format 'created_group' activity actions. 89 88 * 90 * @since BuddyPress (2.0.0)89 * @since 2.0.0 91 90 * 92 91 * @param string $action Static activity action. … … 109 108 * Filters the 'created_group' activity actions. 110 109 * 111 * @since BuddyPress (1.2.0)110 * @since 1.2.0 112 111 * 113 112 * @param string $action The 'created_group' activity action. … … 120 119 * Format 'joined_group' activity actions. 121 120 * 122 * @since BuddyPress (2.0.0)121 * @since 2.0.0 123 122 * 124 123 * @param string $action Static activity action. … … 152 151 * Filters the 'joined_group' activity actions. 153 152 * 154 * @since BuddyPress (2.0.0)153 * @since 2.0.0 155 154 * 156 155 * @param string $action The 'joined_group' activity actions. … … 163 162 * Format 'group_details_updated' activity actions. 164 163 * 165 * @since BuddyPress (2.2.0)164 * @since 2.2.0 166 165 * 167 166 * @param string $action Static activity action. … … 206 205 * Filters the 'group_details_updated' activity actions. 207 206 * 208 * @since BuddyPress (2.0.0)207 * @since 2.0.0 209 208 * 210 209 * @param string $action The 'group_details_updated' activity actions. … … 219 218 * This reduces database overhead during the activity loop. 220 219 * 221 * @since BuddyPress (2.0.0)220 * @since 2.0.0 222 221 * 223 222 * @param array $activities Array of activity items. … … 270 269 * Set up activity arguments for use with the 'groups' scope. 271 270 * 272 * @since BuddyPress (2.2.0)271 * @since 2.2.0 273 272 * 274 273 * @param array $retval Empty array by default … … 416 415 * Add an activity stream item when a member joins a group. 417 416 * 418 * @since BuddyPress (1.9.0)417 * @since 1.9.0 419 418 * 420 419 * @param int $user_id ID of the user joining the group. … … 436 435 * Filters the 'membership_accepted' activity actions. 437 436 * 438 * @since BuddyPress (1.2.0)437 * @since 1.2.0 439 438 * 440 439 * @param string $value The 'membership_accepted' activity action. … … 457 456 * Add an activity item when a group's details are updated. 458 457 * 459 * @since BuddyPress (2.2.0)458 * @since 2.2.0 460 459 * 461 460 * @param int $group_id ID of the group. … … 530 529 * Delete all activity items related to a specific group. 531 530 * 532 * @since BuddyPress (1.9.0)531 * @since 1.9.0 533 532 * 534 533 * @param int $group_id ID of the group. … … 551 550 * joining/leaving the group in quick succession. 552 551 * 553 * @since BuddyPress (1.9.0)552 * @since 1.9.0 554 553 * 555 554 * @param int $group_id ID of the group. -
trunk/src/bp-groups/bp-groups-admin.php
r10131 r10148 6 6 * help text, on which this implementation is heavily based. 7 7 * 8 * @since 1.7.0 9 * 8 10 * @package BuddyPress 9 * @since BuddyPress (1.7.0)10 11 * @subpackage Groups 11 12 */ 12 13 13 // Exit if accessed directly 14 // Exit if accessed directly. 14 15 defined( 'ABSPATH' ) || exit; 15 16 16 // Include WP's list table class 17 // Include WP's list table class. 17 18 if ( !class_exists( 'WP_List_Table' ) ) require( ABSPATH . 'wp-admin/includes/class-wp-list-table.php' ); 18 19 … … 24 25 * Register the Groups component admin screen. 25 26 * 26 * @since BuddyPress (1.7.0)27 * @since 1.7.0 27 28 */ 28 29 function bp_groups_add_admin_menu() { … … 49 50 * main Dashboard menu. 50 51 * 51 * @since BuddyPress (1.7.0)52 * @since 1.7.0 52 53 * 53 54 * @param array $custom_menus Array of BP top-level menu items. … … 68 69 * setting up screen options. 69 70 * 70 * @since BuddyPress (1.7.0)71 * @since 1.7.0 71 72 * 72 73 * @global BP_Groups_List_Table $bp_groups_list_table Groups screen list table. … … 86 87 * Fires at top of groups admin page. 87 88 * 88 * @since BuddyPress (1.7.0)89 * @since 1.7.0 89 90 * 90 91 * @param string $doaction Current $_GET action being performed in admin screen. … … 137 138 * Fires after the registration of all of the default group meta boxes. 138 139 * 139 * @since BuddyPress (1.7.0)140 * @since 1.7.0 140 141 */ 141 142 do_action( 'bp_groups_admin_meta_boxes' ); … … 241 242 * Filters the allowed status values for the group. 242 243 * 243 * @since BuddyPress (1.0.2)244 * @since 1.0.2 244 245 * 245 246 * @param array $value Array of allowed group statuses. … … 251 252 * Filters the allowed invite status values for the group. 252 253 * 253 * @since BuddyPress (1.5.0)254 * @since 1.5.0 254 255 * 255 256 * @param array $value Array of allowed invite statuses. … … 375 376 * Fires before redirect so plugins can do something first on save action. 376 377 * 377 * @since BuddyPress (1.6.0)378 * @since 1.6.0 378 379 * 379 380 * @param int $group_id ID of the group being edited. … … 414 415 * Filters the URL to redirect to after successfully editing a group. 415 416 * 416 * @since BuddyPress (1.7.0)417 * @since 1.7.0 417 418 * 418 419 * @param string $redirect_to URL to redirect user to. … … 432 433 * Handle save/update of screen options for the Groups component admin screen. 433 434 * 434 * @since BuddyPress (1.7.0)435 * @since 1.7.0 435 436 * 436 437 * @param string $value Will always be false unless another plugin filters it first. … … 455 456 * Select the appropriate Groups admin screen, and output it. 456 457 * 457 * @since BuddyPress (1.7.0)458 * @since 1.7.0 458 459 */ 459 460 function bp_groups_admin() { … … 478 479 * Display the single groups edit screen. 479 480 * 480 * @since BuddyPress (1.7.0)481 * @since 1.7.0 481 482 */ 482 483 function bp_groups_admin_edit() { … … 560 561 * Useful for plugins to modify the group before display. 561 562 * 562 * @since BuddyPress (1.7.0)563 * @since 1.7.0 563 564 * 564 565 * @param BP_Groups_Group $this Instance of the current group being edited. Passed by reference. … … 636 637 * irreversible. 637 638 * 638 * @since BuddyPress (1.7.0)639 * @since 1.7.0 639 640 */ 640 641 function bp_groups_admin_delete() { … … 688 689 * This screen contains a list of all BuddyPress groups. 689 690 * 690 * @since BuddyPress (1.7.0)691 * @since 1.7.0 691 692 * 692 693 * @global BP_Groups_List_Table $bp_groups_list_table Group screen list table. … … 715 716 * Useful for plugins to modify the messages before display. 716 717 * 717 * @since BuddyPress (1.7.0)718 * @since 1.7.0 718 719 * 719 720 * @param array $messages Array of messages to be displayed. … … 757 758 * Markup for the single group's Settings metabox. 758 759 * 759 * @since BuddyPress (1.7.0)760 * @since 1.7.0 760 761 * 761 762 * @param object $item Information about the current group. … … 801 802 * Output the markup for a single group's Add New Members metabox. 802 803 * 803 * @since BuddyPress (1.7.0)804 * @since 1.7.0 804 805 */ 805 806 function bp_groups_admin_edit_metabox_add_new_members( $item ) { … … 815 816 * Renders the Members metabox on single group pages. 816 817 * 817 * @since BuddyPress (1.7.0)818 * @since 1.7.0 818 819 * 819 820 * @param BP_Groups_Group $item The BP_Groups_Group object for the current group. … … 938 939 * Fires after the listing of a single row for members in a group on the group edit screen. 939 940 * 940 * @since BuddyPress (1.8.0)941 * @since 1.8.0 941 942 * 942 943 * @param int $ID ID of the user being rendered. … … 971 972 * Renders the Status metabox for the Groups admin edit screen. 972 973 * 973 * @since BuddyPress (1.7.0)974 * @since 1.7.0 974 975 * 975 976 * @param object $item Information about the currently displayed group. … … 1006 1007 * deprecated soon. 1007 1008 * 1008 * @since BuddyPress (1.8.0)1009 * @since 1.8.0 1009 1010 * 1010 1011 * @param BP_Group_Member_Query $query A BP_Group_Member_Query object. … … 1064 1065 * Get a set of usernames corresponding to a set of user IDs. 1065 1066 * 1066 * @since BuddyPress (1.7.0)1067 * @since 1.7.0 1067 1068 * 1068 1069 * @param array $user_ids Array of user IDs. … … 1085 1086 * AJAX handler for group member autocomplete requests. 1086 1087 * 1087 * @since BuddyPress (1.7.0)1088 * @since 1.7.0 1088 1089 */ 1089 1090 function bp_groups_admin_autocomplete_handler() { … … 1128 1129 * List table class for the Groups component admin page. 1129 1130 * 1130 * @since BuddyPress (1.7.0)1131 * @since 1.7.0 1131 1132 */ 1132 1133 class BP_Groups_List_Table extends WP_List_Table { … … 1137 1138 * e.g. "All", "Pending", "Approved", "Spam"... 1138 1139 * 1139 * @since BuddyPress (1.7.0)1140 * @since 1.7.0 1140 1141 * 1141 1142 * @access public … … 1147 1148 * Group counts for each group type. 1148 1149 * 1149 * @since BuddyPress (1.7.0)1150 * @since 1.7.0 1150 1151 * 1151 1152 * @access public … … 1165 1166 * Constructor 1166 1167 * 1167 * @since BuddyPress (1.7.0)1168 * @since 1.7.0 1168 1169 */ 1169 1170 public function __construct() { … … 1183 1184 * manipulation required prior to rendering. 1184 1185 * 1185 * @since BuddyPress (1.7.0)1186 * @since 1.7.0 1186 1187 */ 1187 1188 public function prepare_items() { … … 1288 1289 * Get an array of all the columns on the page. 1289 1290 * 1290 * @since BuddyPress (1.7.0)1291 * @since 1.7.0 1291 1292 * 1292 1293 * @return array Array of column headers. … … 1306 1307 * Get name of default primary column 1307 1308 * 1308 * @since BuddyPress (2.3.3)1309 * @since 2.3.3 1309 1310 * @access protected 1310 1311 * … … 1319 1320 * Display a message on screen when no items are found ("No groups found"). 1320 1321 * 1321 * @since BuddyPress (1.7.0)1322 * @since 1.7.0 1322 1323 */ 1323 1324 public function no_items() { … … 1328 1329 * Output the Groups data table. 1329 1330 * 1330 * @since BuddyPress (1.7.0)1331 * @since 1.7.0 1331 1332 */ 1332 1333 public function display() { … … 1358 1359 * Generate content for a single row of the table. 1359 1360 * 1360 * @since BuddyPress (1.7.0)1361 * @since 1.7.0 1361 1362 * 1362 1363 * @param object|array $item The current group item in the loop. … … 1376 1377 * Filters the classes applied to a single row in the groups list table. 1377 1378 * 1378 * @since BuddyPress (1.9.0)1379 * @since 1.9.0 1379 1380 * 1380 1381 * @param array $row_classes Array of classes to apply to the row. … … 1394 1395 * Get the list of views available on this table (e.g. "all", "public"). 1395 1396 * 1396 * @since BuddyPress (1.7.0)1397 * @since 1.7.0 1397 1398 */ 1398 1399 public function get_views() { … … 1410 1411 * Fires inside listing of views so plugins can add their own. 1411 1412 * 1412 * @since BuddyPress (1.7.0)1413 * @since 1.7.0 1413 1414 * 1414 1415 * @param string $url_base Current URL base for view. … … 1423 1424 * Get bulk actions for single group row. 1424 1425 * 1425 * @since BuddyPress (1.7.0)1426 * @since 1.7.0 1426 1427 * 1427 1428 * @return array Key/value pairs for the bulk actions dropdown. … … 1432 1433 * Filters the list of bulk actions to display on a single group row. 1433 1434 * 1434 * @since BuddyPress (1.7.0)1435 * @since 1.7.0 1435 1436 * 1436 1437 * @param array $value Array of bulk actions to display. … … 1444 1445 * Get the table column titles. 1445 1446 * 1446 * @since BuddyPress (1.7.0)1447 * @since 1.7.0 1447 1448 * 1448 1449 * @see WP_List_Table::single_row_columns() … … 1455 1456 * Filters the titles for the columns for the groups list table. 1456 1457 * 1457 * @since BuddyPress (2.0.0)1458 * @since 2.0.0 1458 1459 * 1459 1460 * @param array $value Array of slugs and titles for the columns. … … 1481 1482 * $desc_first = false. 1482 1483 * 1483 * @since BuddyPress (1.7.0)1484 * @since 1.7.0 1484 1485 * 1485 1486 * @return array Array of sortable column names. … … 1528 1529 * Markup for the Checkbox column. 1529 1530 * 1530 * @since BuddyPress (1.7.0)1531 * @since 1.7.0 1531 1532 * 1532 1533 * @see WP_List_Table::single_row_columns() … … 1541 1542 * Markup for the Group ID column. 1542 1543 * 1543 * @since BuddyPress (1.7.0)1544 * @since 1.7.0 1544 1545 * 1545 1546 * @see WP_List_Table::single_row_columns() … … 1556 1557 * Called "comment" in the CSS so we can re-use some WP core CSS. 1557 1558 * 1558 * @since BuddyPress (1.7.0)1559 * @since 1.7.0 1559 1560 * 1560 1561 * @see WP_List_Table::single_row_columns() … … 1583 1584 * Filters the group name for a group's column content. 1584 1585 * 1585 * @since BuddyPress (1.7.0)1586 * @since 1.7.0 1586 1587 * 1587 1588 * @param string $value Name of the group being rendered. … … 1604 1605 * Filters the actions that will be shown for the column content. 1605 1606 * 1606 * @since BuddyPress (1.7.0)1607 * @since 1.7.0 1607 1608 * 1608 1609 * @param array $value Array of actions to be displayed for the column content. … … 1635 1636 * Markup for the Description column. 1636 1637 * 1637 * @since BuddyPress (1.7.0)1638 * @since 1.7.0 1638 1639 * 1639 1640 * @param array $item Information about the current row. … … 1644 1645 * Filters the markup for the Description column. 1645 1646 * 1646 * @since BuddyPress (1.0.0)1647 * @since 1.0.0 1647 1648 * 1648 1649 * @param string $value Markup for the Description column. … … 1655 1656 * Markup for the Status column. 1656 1657 * 1657 * @since BuddyPress (1.7.0)1658 * @since 1.7.0 1658 1659 * 1659 1660 * @param array $item Information about the current row. … … 1680 1681 * Filters the markup for the Status column. 1681 1682 * 1682 * @since BuddyPress (1.7.0)1683 * @since 1.7.0 1683 1684 * 1684 1685 * @param string $status_desc Markup for the Status column. … … 1691 1692 * Markup for the Number of Members column. 1692 1693 * 1693 * @since BuddyPress (1.7.0)1694 * @since 1.7.0 1694 1695 * 1695 1696 * @param array $item Information about the current row. … … 1701 1702 * Filters the markup for the number of Members column. 1702 1703 * 1703 * @since BuddyPress (1.7.0)1704 * @since 1.7.0 1704 1705 * 1705 1706 * @param int $count Markup for the number of Members column. … … 1712 1713 * Markup for the Last Active column. 1713 1714 * 1714 * @since BuddyPress (1.7.0)1715 * @since 1.7.0 1715 1716 * 1716 1717 * @param array $item Information about the current row. … … 1722 1723 * Filters the markup for the Last Active column. 1723 1724 * 1724 * @since BuddyPress (1.7.0)1725 * @since 1.7.0 1725 1726 * 1726 1727 * @param string $last_active Markup for the Last Active column. … … 1733 1734 * Allow plugins to add their custom column. 1734 1735 * 1735 * @since BuddyPress (2.0.0)1736 * @since 2.0.0 1736 1737 * 1737 1738 * @param array $item Information about the current row. … … 1745 1746 * Filters a string to allow plugins to add custom column content. 1746 1747 * 1747 * @since BuddyPress (2.0.0)1748 * @since 2.0.0 1748 1749 * 1749 1750 * @param string $value Empty string. -
trunk/src/bp-groups/bp-groups-adminbar.php
r9906 r10148 1 1 <?php 2 3 2 /** 4 3 * BuddyPress Groups Toolbar. … … 10 9 */ 11 10 12 // Exit if accessed directly 11 // Exit if accessed directly. 13 12 defined( 'ABSPATH' ) || exit; 14 13 … … 16 15 * Add the Group Admin top-level menu when viewing group pages. 17 16 * 18 * @since BuddyPress (1.5.0)17 * @since 1.5.0 19 18 * 20 19 * @todo Add dynamic menu items for group extensions. … … 86 85 * Remove rogue WP core Edit menu when viewing a single group. 87 86 * 88 * @since BuddyPress (1.6.0)87 * @since 1.6.0 89 88 */ 90 89 function bp_groups_remove_edit_page_menu() { -
trunk/src/bp-groups/bp-groups-cache.php
r9906 r10148 1 1 <?php 2 3 2 /** 4 3 * BuddyPress Groups Caching. … … 11 10 */ 12 11 13 // Exit if accessed directly 12 // Exit if accessed directly. 14 13 defined( 'ABSPATH' ) || exit; 15 14 … … 62 61 * Bust group caches when editing or deleting. 63 62 * 64 * @since BuddyPress (1.7.0)63 * @since 1.7.0 65 64 * 66 65 * @param int $group_id The group being edited. … … 77 76 * Bust group cache when modifying metadata. 78 77 * 79 * @since BuddyPress (2.0.0)78 * @since 2.0.0 80 79 * 81 80 * @param int $meta_id … … 91 90 * Clear caches for the group creator when a group is created. 92 91 * 93 * @since BuddyPress (1.6.0)92 * @since 1.6.0 94 93 * 95 94 * @param int $group_id ID of the group. … … 105 104 * Clears caches for all members in a group when a group is deleted. 106 105 * 107 * @since BuddyPress (1.6.0)106 * @since 1.6.0 108 107 * 109 108 * @param BP_Groups_Group $group_obj Group object. … … 122 121 * Count is cleared when an invite is accepted, rejected or deleted. 123 122 * 124 * @since BuddyPress (2.0.0)123 * @since 2.0.0 125 124 * 126 125 * @param int $user_id The user ID. … … 138 137 * Groan. Our API functions are not consistent. 139 138 * 140 * @since BuddyPress (2.0.0)139 * @since 2.0.0 141 140 * 142 141 * @param int $group_id The group ID. Not used in this function. … … 151 150 * Clear a user's cached total group invite count when a new invite is sent. 152 151 * 153 * @since BuddyPress (2.0.0)152 * @since 2.0.0 154 153 * 155 154 * @param int $group_id The group ID. Not used in this function. … … 182 181 * Clear group administrator cache. 183 182 * 184 * @since BuddyPress (2.1.0)183 * @since 2.1.0 185 184 * 186 185 * @param int $group_id The group ID. … … 199 198 * using {@link BP_Groups_Member::save()}. Usually via a plugin. 200 199 * 201 * @since BuddyPress (2.1.0)200 * @since 2.1.0 202 201 * 203 202 * @param BP_Groups_Member $member -
trunk/src/bp-groups/bp-groups-classes.php
r9819 r10148 7 7 */ 8 8 9 // Exit if accessed directly 9 // Exit if accessed directly. 10 10 defined( 'ABSPATH' ) || exit; 11 11 -
trunk/src/bp-groups/bp-groups-filters.php
r9975 r10148 1 1 <?php 2 3 2 /** 4 3 * BuddyPress Groups Filters. … … 8 7 */ 9 8 10 // Exit if accessed directly 9 // Exit if accessed directly. 11 10 defined( 'ABSPATH' ) || exit; 12 11 … … 70 69 * Filter output of Group Description through WordPress's KSES API. 71 70 * 72 * @since BuddyPress (1.1.0)71 * @since 1.1.0 73 72 * 74 73 * @param string $content … … 102 101 * Filters the HTML elements allowed for a given context. 103 102 * 104 * @since BuddyPress (1.2.0)103 * @since 1.2.0 105 104 * 106 105 * @param string $allowed_tags Allowed tags, attributes, and/or entities. … … 236 235 * This speeds up the query. 237 236 * 238 * @since BuddyPress (1.5.0)237 * @since 1.5.0 239 238 * 240 239 * @see BB_Query::_filter_sql() … … 247 246 * This filter is used to prevent fetching information that is not used. 248 247 * 249 * @since BuddyPress (1.5.0)248 * @since 1.5.0 250 249 * 251 250 * @param string $value SQL string to specify fetching just topic_id. … … 259 258 * mentions suggestions? 260 259 * 261 * @since BuddyPress (2.2.0)260 * @since 2.2.0 262 261 * 263 262 * @param bool $load_mentions True to load mentions assets, false otherwise. -
trunk/src/bp-groups/bp-groups-forums.php
r9906 r10148 1 1 <?php 2 3 2 /** 4 3 * BuddyPress Groups Forums. … … 15 14 */ 16 15 17 // Exit if accessed directly 16 // Exit if accessed directly. 18 17 defined( 'ABSPATH' ) || exit; 19 18 … … 23 22 * Uses the bundled version of bbPress packaged with BuddyPress. 24 23 * 25 * @since BuddyPress (1.0.0)24 * @since 1.0.0 26 25 * 27 26 * @param int $group_id The group ID that the new forum should be attached to. … … 53 52 * Fires after the creation of a new forum inside a specific BuddyPress group. 54 53 * 55 * @since BuddyPress (1.0.0)54 * @since 1.0.0 56 55 * 57 56 * @param int $forum_id ID of the newly created forum. … … 64 63 * Update group forum metadata (title, description, slug) when the group's details are edited. 65 64 * 66 * @since BuddyPress (1.1.0)65 * @since 1.1.0 67 66 * 68 67 * @param int $group_id Group id, passed from groups_details_updated. … … 88 87 * Filters the group forum metadata value argument. 89 88 * 90 * @since BuddyPress (1.2.5)89 * @since 1.2.5 91 90 * 92 91 * @param array $value Array of metadata values to update the group forum with. … … 106 105 * Uses the bundled version of bbPress packaged with BuddyPress. 107 106 * 108 * @since BuddyPress (1.0.0)107 * @since 1.0.0 109 108 * 110 109 * @param string $post_text The text for the forum post. … … 124 123 * Filters the text for the forum post before save. 125 124 * 126 * @since BuddyPress (1.2.0)125 * @since 1.2.0 127 126 * 128 127 * @param string $post_text Text for the forum post. … … 133 132 * Filters the ID for the forum post before save. 134 133 * 135 * @since BuddyPress (1.2.0)134 * @since 1.2.0 136 135 * 137 136 * @param int $topic_id ID of the topic the post will be associated with. … … 159 158 * Filters the new groups activity forum post action. 160 159 * 161 * @since BuddyPress (1.2.0)160 * @since 1.2.0 162 161 * 163 162 * @param string $activity_action Formatted action related to group activity posting. … … 171 170 * Filters the new groups activity forum post content. 172 171 * 173 * @since BuddyPress (1.2.0)172 * @since 1.2.0 174 173 * 175 174 * @param string $activity_content Excerpt-length activity content to be posted. … … 183 182 * Filters the new groups activity forum post primary link. 184 183 * 185 * @since BuddyPress (1.1.0)184 * @since 1.1.0 186 185 * 187 186 * @param string $value URL to the newly posted forum post. … … 201 200 * Fires after the creation of a new group forum topic post. 202 201 * 203 * @since BuddyPress (1.0.0)202 * @since 1.0.0 204 203 * 205 204 * @param int $value ID of the current group. … … 216 215 * Uses the bundled version of bbPress packaged with BuddyPress. 217 216 * 218 * @since BuddyPress (1.0.0)217 * @since 1.0.0 219 218 * 220 219 * @param string $topic_title The title for the forum topic. … … 232 231 * Filters the new groups forum topic title before saving. 233 232 * 234 * @since BuddyPress (1.2.0)233 * @since 1.2.0 235 234 * 236 235 * @param string $topic_title The title for the forum topic. … … 241 240 * Filters the new groups forum topic text before saving. 242 241 * 243 * @since BuddyPress (1.2.0)242 * @since 1.2.0 244 243 * 245 244 * @param string $topic_text The text for the forum topic. … … 250 249 * Filters the new groups forum topic tags before saving. 251 250 * 252 * @since BuddyPress (1.2.0)251 * @since 1.2.0 253 252 * 254 253 * @param string $topic_tags A comma-delimited string of topic tags. … … 259 258 * Filters the forum ID this forum topic resides in. 260 259 * 261 * @since BuddyPress (1.2.0)260 * @since 1.2.0 262 261 * 263 262 * @param string $forum_id The forum ID this forum topic resides in. … … 282 281 * Filters the new groups activity forum topic action. 283 282 * 284 * @since BuddyPress (1.2.0)283 * @since 1.2.0 285 284 * 286 285 * @param string $activity_action Formatted action related to forum topic. … … 293 292 * Filters the new groups activity forum topic content. 294 293 * 295 * @since BuddyPress (1.2.0)294 * @since 1.2.0 296 295 * 297 296 * @param string $activity_content Excerpt-length activity content to be posted. … … 304 303 * Filters the new groups activity forum topic primary link. 305 304 * 306 * @since BuddyPress (1.1.0)305 * @since 1.1.0 307 306 * 308 307 * @param string $value Concatenated primary link. … … 322 321 * Fires after the creation of a new group forum topic. 323 322 * 324 * @since BuddyPress (1.0.0)323 * @since 1.0.0 325 324 * 326 325 * @param int $value ID of the current group. … … 337 336 * Uses the bundled version of bbPress packaged with BuddyPress. 338 337 * 339 * @since BuddyPress (1.1.0)338 * @since 1.1.0 340 339 * 341 340 * @param int $topic_id The topic ID of the existing forum topic. … … 402 401 * Fires after the update of a group forum topic. 403 402 * 404 * @since BuddyPress (1.1.0)403 * @since 1.1.0 405 404 * 406 405 * @param object $topic Object holding current topic being updated. Passed by reference. … … 416 415 * Uses the bundled version of bbPress packaged with BuddyPress. 417 416 * 418 * @since BuddyPress (1.1.0)417 * @since 1.1.0 419 418 * 420 419 * @param int $post_id The post ID of the existing forum post. … … 490 489 * Fires after the update of a group forum post. 491 490 * 492 * @since BuddyPress (1.1.0)491 * @since 1.1.0 493 492 * 494 493 * @param object $post Object holding current post being updated. … … 505 504 * Uses the bundled version of bbPress packaged with BuddyPress. 506 505 * 507 * @since BuddyPress (1.1.0)506 * @since 1.1.0 508 507 * 509 508 * @param int $topic_id The ID of the topic to be deleted. … … 523 522 * Fires before the deletion of a group forum topic. 524 523 * 525 * @since BuddyPress (1.2.9)524 * @since 1.2.9 526 525 * 527 526 * @param int $topic_id ID of the topic to be deleted. … … 554 553 * Fires after the deletion of a group forum topic. 555 554 * 556 * @since BuddyPress (1.1.0)555 * @since 1.1.0 557 556 * 558 557 * @param int $topic_id ID of the topic that was deleted. … … 569 568 * Uses the bundled version of bbPress packaged with BuddyPress. 570 569 * 571 * @since BuddyPress (1.1.0)570 * @since 1.1.0 572 571 * 573 572 * @param int $post_id The ID of the post you want to delete. … … 587 586 * Fires before the deletion of a group forum post. 588 587 * 589 * @since BuddyPress (1.5.0)588 * @since 1.5.0 590 589 * 591 590 * @param int $post_id ID of the post to be deleted. … … 607 606 * Fires after the deletion of a group forum post. 608 607 * 609 * @since BuddyPress (1.1.0)608 * @since 1.1.0 610 609 * 611 610 * @param int $post_id ID of the post that was deleted. … … 621 620 * Get a total count of all public topics of a given type, across groups/forums. 622 621 * 623 * @since BuddyPress (1.5.0)622 * @since 1.5.0 624 623 * 625 624 * @param string $type Either 'newest', 'popular', 'unreplied', 'tags'. … … 633 632 * Filters the total count of all public topics of a given type, across groups/forums. 634 633 * 635 * @since BuddyPress (1.1.0)634 * @since 1.1.0 636 635 * 637 636 * @param int $value Total count of all public topics. … … 643 642 * Get a total count of all topics of a given status, across groups/forums. 644 643 * 645 * @since BuddyPress (1.5.0)644 * @since 1.5.0 646 645 * 647 646 * @param string $status Which groups to count. 'public', 'private', 'hidden', … … 656 655 * Filters the total count of all topics of a given status, across groups/forums. 657 656 * 658 * @since BuddyPress (1.5.0)657 * @since 1.5.0 659 658 * 660 659 * @param int $value Total count of all topics. -
trunk/src/bp-groups/bp-groups-functions.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 array|string $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. -
trunk/src/bp-groups/bp-groups-loader.php
r10110 r10148 1 1 <?php 2 3 2 /** 4 3 * BuddyPress Groups Loader. … … 12 11 */ 13 12 14 // Exit if accessed directly 13 // Exit if accessed directly. 15 14 defined( 'ABSPATH' ) || exit; 16 15 … … 20 19 * Auto-join group when non group member performs group activity. 21 20 * 22 * @since BuddyPress (1.5.0)21 * @since 1.5.0 23 22 * @access public 24 23 * @var bool … … 29 28 * The group being currently accessed. 30 29 * 31 * @since BuddyPress (1.5.0)30 * @since 1.5.0 32 31 * @access public 33 32 * @var BP_Groups_Group … … 38 37 * Default group extension. 39 38 * 40 * @since BuddyPress (1.6.0)39 * @since 1.6.0 41 40 * @access public 42 41 * @todo Is this used anywhere? Is this a duplicate of $default_extension? … … 47 46 * Default group extension. 48 47 * 49 * @since BuddyPress (1.6.0)48 * @since 1.6.0 50 49 * @access public 51 50 * @var string … … 56 55 * Illegal group names/slugs. 57 56 * 58 * @since BuddyPress (1.5.0)57 * @since 1.5.0 59 58 * @access public 60 59 * @var array … … 65 64 * Group creation/edit steps (e.g. Details, Settings, Avatar, Invites). 66 65 * 67 * @since BuddyPress (1.5.0)66 * @since 1.5.0 68 67 * @access public 69 68 * @var array … … 74 73 * Types of group statuses (Public, Private, Hidden). 75 74 * 76 * @since BuddyPress (1.5.0)75 * @since 1.5.0 77 76 * @access public 78 77 * @var array … … 83 82 * Start the groups component creation process. 84 83 * 85 * @since BuddyPress (1.5.0)84 * @since 1.5.0 86 85 */ 87 86 public function __construct() { … … 100 99 * Include Groups component files. 101 100 * 102 * @since BuddyPress (1.5.0)101 * @since 1.5.0 103 102 * 104 103 * @see BP_Component::includes() for a description of arguments. … … 135 134 * backwards compatibility. 136 135 * 137 * @since BuddyPress (1.5.0)136 * @since 1.5.0 138 137 * 139 138 * @see BP_Component::setup_globals() for a description of arguments. … … 186 185 * Filters the current PHP Class being used. 187 186 * 188 * @since BuddyPress (1.5.0)187 * @since 1.5.0 189 188 * 190 189 * @param string $value Name of the class being used. … … 203 202 * Filters the current group object being instantiated from previous filter. 204 203 * 205 * @since BuddyPress (1.5.0)204 * @since 1.5.0 206 205 * 207 206 * @param object $value Newly instantiated object for the group. … … 261 260 * Filters the list of illegal groups names/slugs. 262 261 * 263 * @since BuddyPress (1.0.0)262 * @since 1.0.0 264 263 * 265 264 * @param array $value Array of illegal group names/slugs. … … 291 290 * Filters the preconfigured groups creation steps. 292 291 * 293 * @since BuddyPress (1.1.0)292 * @since 1.1.0 294 293 * 295 294 * @param array $value Array of preconfigured group creation steps. … … 326 325 * Filters the list of valid groups statuses. 327 326 * 328 * @since BuddyPress (1.1.0)327 * @since 1.1.0 329 328 * 330 329 * @param array $value Array of valid group statuses. … … 343 342 * Set up canonical stack for this component. 344 343 * 345 * @since BuddyPress (2.1.0)344 * @since 2.1.0 346 345 */ 347 346 public function setup_canonical_stack() { … … 357 356 * Filters the default groups extension. 358 357 * 359 * @since BuddyPress (1.6.0)358 * @since 1.6.0 360 359 * 361 360 * @param string $value BP_GROUPS_DEFAULT_EXTENSION constant if defined, … … 392 391 * Set up component navigation. 393 392 * 394 * @since BuddyPress (1.5.0)393 * @since 1.5.0 395 394 * 396 395 * @see BP_Component::setup_nav() for a description of arguments. … … 622 621 * Fires at the end of the groups navigation setup if user has access. 623 622 * 624 * @since BuddyPress (1.0.2)623 * @since 1.0.2 625 624 * 626 625 * @param bool $user_has_access Whether or not user has access. … … 741 740 * Setup cache groups 742 741 * 743 * @since BuddyPress (2.2.0)742 * @since 2.2.0 744 743 */ 745 744 public function setup_cache_groups() { … … 760 759 * Bootstrap the Notifications component. 761 760 * 762 * @since BuddyPress (1.5.0)761 * @since 1.5.0 763 762 */ 764 763 function bp_setup_groups() { -
trunk/src/bp-groups/bp-groups-notifications.php
r9970 r10148 1 1 <?php 2 3 2 /** 4 3 * BuddyPress Groups Notification Functions. … … 11 10 */ 12 11 13 // Exit if accessed directly 12 // Exit if accessed directly. 14 13 defined( 'ABSPATH' ) || exit; 15 14 … … 19 18 * Notify all group members when a group is updated. 20 19 * 21 * @since BuddyPress (1.0.0)20 * @since 1.0.0 22 21 * 23 22 * @param int $group_id ID of the group. … … 51 50 * Filters the bullet points listing updated items in the email notification after a group is updated. 52 51 * 53 * @since BuddyPress (2.2.0)52 * @since 2.2.0 54 53 * 55 54 * @param array $changed Array of bullet points. … … 94 93 * Filters the user email that the group update notification will be sent to. 95 94 * 96 * @since BuddyPress (1.2.0)95 * @since 1.2.0 97 96 * 98 97 * @param string $to User email the notification is being sent to. … … 103 102 * Filters the group update notification subject that will be sent to user. 104 103 * 105 * @since BuddyPress (1.2.0)104 * @since 1.2.0 106 105 * 107 106 * @param string $subject Email notification subject text. … … 113 112 * Filters the group update notification message that will be sent to user. 114 113 * 115 * @since BuddyPress (1.2.0)114 * @since 1.2.0 116 115 * 117 116 * @param string $message Email notification message text. … … 132 131 * See https://buddypress.trac.wordpress.org/ticket/3644 for blank message parameter. 133 132 * 134 * @since BuddyPress (1.5.0)133 * @since 1.5.0 135 134 * 136 135 * @param array $user_ids Array of user IDs to notify about the update. … … 145 144 * Notify group admin about new membership request. 146 145 * 147 * @since BuddyPress (1.0.0)146 * @since 1.0.0 148 147 * 149 148 * @param int $requesting_user_id ID of the user requesting group membership. … … 234 233 * Filters the user email that the group membership request will be sent to. 235 234 * 236 * @since BuddyPress (1.2.0)235 * @since 1.2.0 237 236 * 238 237 * @param string $to User email the request is being sent to. … … 243 242 * Filters the group membership request subject that will be sent to user. 244 243 * 245 * @since BuddyPress (1.2.0)244 * @since 1.2.0 246 245 * 247 246 * @param string $subject Membership request email subject text. … … 253 252 * Filters the group membership request message that will be sent to user. 254 253 * 255 * @since BuddyPress (1.2.0)254 * @since 1.2.0 256 255 * 257 256 * @param string $message Membership request email message text. … … 269 268 * Fires after the notification is sent that a member has requested group membership. 270 269 * 271 * @since BuddyPress (1.5.0)270 * @since 1.5.0 272 271 * 273 272 * @param int $admin_id ID of the group administrator. … … 284 283 * Notify member about their group membership request. 285 284 * 286 * @since BuddyPress (1.0.0)285 * @since 1.0.0 287 286 * 288 287 * @param int $requesting_user_id ID of the user requesting group membership. … … 353 352 * Filters the user email that the group membership request result will be sent to. 354 353 * 355 * @since BuddyPress (1.2.0)354 * @since 1.2.0 356 355 * 357 356 * @param string $to User email the request result is being sent to. … … 362 361 * Filters the group membership request result subject that will be sent to user. 363 362 * 364 * @since BuddyPress (1.2.0)363 * @since 1.2.0 365 364 * 366 365 * @param string $subject Membership request result email subject text. … … 372 371 * Filters the group membership request result message that will be sent to user. 373 372 * 374 * @since BuddyPress (1.2.0)373 * @since 1.2.0 375 374 * 376 375 * @param string $message Membership request result email message text. … … 386 385 * Fires after the notification is sent that a membership has been approved. 387 386 * 388 * @since BuddyPress (1.5.0)387 * @since 1.5.0 389 388 * 390 389 * @param int $requesting_user_id ID of the user whose membership was approved. … … 401 400 * Notify group member they have been promoted. 402 401 * 403 * @since BuddyPress (1.0.0)402 * @since 1.0.0 404 403 * 405 404 * @param int $user_id ID of the user. … … 459 458 * Filters the user email that the group promotion notification will be sent to. 460 459 * 461 * @since BuddyPress (1.2.0)460 * @since 1.2.0 462 461 * 463 462 * @param string $to User email the promotion notification is being sent to. … … 468 467 * Filters the group promotion notification subject that will be sent to user. 469 468 * 470 * @since BuddyPress (1.2.0)469 * @since 1.2.0 471 470 * 472 471 * @param string $subject Promotion notification email subject text. … … 478 477 * Filters the group promotion notification message that will be sent to user. 479 478 * 480 * @since BuddyPress (1.2.0)479 * @since 1.2.0 481 480 * 482 481 * @param string $message Promotion notification email message text. … … 493 492 * Fires after the notification is sent that a member has been promoted. 494 493 * 495 * @since BuddyPress (1.5.0)494 * @since 1.5.0 496 495 * 497 496 * @param int $user_id ID of the user who was promoted. … … 507 506 * Notify a member they have been invited to a group. 508 507 * 509 * @since BuddyPress (1.0.0)508 * @since 1.0.0 510 509 * 511 510 * @param BP_Groups_Group $group Group object. … … 575 574 * Filters the user email that the group invite notification will be sent to. 576 575 * 577 * @since BuddyPress (1.2.0)576 * @since 1.2.0 578 577 * 579 578 * @param string $to User email the invite notification is being sent to. … … 584 583 * Filters the group invite notification subject that will be sent to user. 585 584 * 586 * @since BuddyPress (1.2.0)585 * @since 1.2.0 587 586 * 588 587 * @param string $subject Invite notification email subject text. … … 594 593 * Filters the group invite notification message that will be sent to user. 595 594 * 596 * @since BuddyPress (1.2.0)595 * @since 1.2.0 597 596 * 598 597 * @param string $message Invite notification email message text. … … 611 610 * Fires after the notification is sent that a member has been invited to a group. 612 611 * 613 * @since BuddyPress (1.5.0)612 * @since 1.5.0 614 613 * 615 614 * @param int $invited_user_id ID of the user who was invited. … … 626 625 * Format notifications for the Groups component. 627 626 * 628 * @since BuddyPress (1.0.0)627 * @since 1.0.0 629 628 * 630 629 * @param string $action The kind of notification being rendered. … … 665 664 * Complete filter - bp_groups_multiple_new_membership_requests_notification. 666 665 * 667 * @since BuddyPress (1.0.0)666 * @since 1.0.0 668 667 * 669 668 * @param string $string HTML anchor tag for request. … … 683 682 * Complete filter - bp_groups_multiple_new_membership_requests_notification. 684 683 * 685 * @since BuddyPress (1.0.0)684 * @since 1.0.0 686 685 * 687 686 * @param array $array Array holding permalink and content for notification. … … 710 709 * Complete filter - bp_groups_single_new_membership_request_notification. 711 710 * 712 * @since BuddyPress (1.0.0)711 * @since 1.0.0 713 712 * 714 713 * @param string $string HTML anchor tag for request. … … 728 727 * Complete filter - bp_groups_single_new_membership_request_notification. 729 728 * 730 * @since BuddyPress (1.0.0)729 * @since 1.0.0 731 730 * 732 731 * @param array $array Array holding permalink and content for notification. … … 764 763 * Complete filter - bp_groups_multiple_membership_request_accepted_notification. 765 764 * 766 * @since BuddyPress (1.0.0)765 * @since 1.0.0 767 766 * 768 767 * @param string $string HTML anchor tag for notification. … … 779 778 * Complete filter - bp_groups_multiple_membership_request_accepted_notification. 780 779 * 781 * @since BuddyPress (1.0.0)780 * @since 1.0.0 782 781 * 783 782 * @param array $array Array holding permalink and content for notification … … 803 802 * Complete filter - bp_groups_single_membership_request_accepted_notification. 804 803 * 805 * @since BuddyPress (1.0.0)804 * @since 1.0.0 806 805 * 807 806 * @param string $string HTML anchor tag for notification. … … 818 817 * Complete filter - bp_groups_single_membership_request_accepted_notification. 819 818 * 820 * @since BuddyPress (1.0.0)819 * @since 1.0.0 821 820 * 822 821 * @param array $array Array holding permalink and content for notification. … … 853 852 * Complete filter - bp_groups_multiple_membership_request_rejected_notification. 854 853 * 855 * @since BuddyPress (1.0.0)854 * @since 1.0.0 856 855 * 857 856 * @param string $string HTML anchor tag for notification. … … 868 867 * Complete filter - bp_groups_multiple_membership_request_rejected_notification. 869 868 * 870 * @since BuddyPress (1.0.0)869 * @since 1.0.0 871 870 * 872 871 * @param array $array Array holding permalink and content for notification. … … 891 890 * Complete filter - bp_groups_single_membership_request_rejected_notification. 892 891 * 893 * @since BuddyPress (1.0.0)892 * @since 1.0.0 894 893 * 895 894 * @param string $string HTML anchor tag for notification. … … 906 905 * Complete filter - bp_groups_single_membership_request_rejected_notification. 907 906 * 908 * @since BuddyPress (1.0.0)907 * @since 1.0.0 909 908 * 910 909 * @param array $array Array holding permalink and content for notification. … … 940 939 * Complete filter - bp_groups_multiple_member_promoted_to_admin_notification. 941 940 * 942 * @since BuddyPress (1.0.0)941 * @since 1.0.0 943 942 * 944 943 * @param string $string HTML anchor tag for notification. … … 953 952 * Complete filter - bp_groups_multiple_member_promoted_to_admin_notification. 954 953 * 955 * @since BuddyPress (1.0.0)954 * @since 1.0.0 956 955 * 957 956 * @param array $array Array holding permalink and content for notification. … … 974 973 * Complete filter - bp_groups_single_member_promoted_to_admin_notification. 975 974 * 976 * @since BuddyPress (1.0.0)975 * @since 1.0.0 977 976 * 978 977 * @param string $string HTML anchor tag for notification. … … 988 987 * Complete filter - bp_groups_single_member_promoted_to_admin_notification. 989 988 * 990 * @since BuddyPress (1.0.0)989 * @since 1.0.0 991 990 * 992 991 * @param array $array Array holding permalink and content for notification. … … 1022 1021 * Complete filter - bp_groups_multiple_member_promoted_to_mod_notification. 1023 1022 * 1024 * @since BuddyPress (1.0.0)1023 * @since 1.0.0 1025 1024 * 1026 1025 * @param string $string HTML anchor tag for notification. … … 1056 1055 * Complete filter - bp_groups_single_member_promoted_to_mod_notification. 1057 1056 * 1058 * @since BuddyPress (1.0.0)1057 * @since 1.0.0 1059 1058 * 1060 1059 * @param string $string HTML anchor tag for notification. … … 1070 1069 * Complete filter - bp_groups_single_member_promoted_to_mod_notification. 1071 1070 * 1072 * @since BuddyPress (1.0.0)1071 * @since 1.0.0 1073 1072 * 1074 1073 * @param array $array Array holding permalink and content for notification. … … 1104 1103 * Complete filter - bp_groups_multiple_group_invite_notification. 1105 1104 * 1106 * @since BuddyPress (1.0.0)1105 * @since 1.0.0 1107 1106 * 1108 1107 * @param string $string HTML anchor tag for notification. … … 1117 1116 * Complete filter - bp_groups_multiple_group_invite_notification. 1118 1117 * 1119 * @since BuddyPress (1.0.0)1118 * @since 1.0.0 1120 1119 * 1121 1120 * @param array $array Array holding permalink and content for notification. … … 1138 1137 * Complete filter - bp_groups_single_group_invite_notification. 1139 1138 * 1140 * @since BuddyPress (1.0.0)1139 * @since 1.0.0 1141 1140 * 1142 1141 * @param string $string HTML anchor tag for notification. … … 1152 1151 * Complete filter - bp_groups_single_group_invite_notification. 1153 1152 * 1154 * @since BuddyPress (1.0.0)1153 * @since 1.0.0 1155 1154 * 1156 1155 * @param array $array Array holding permalink and content for notification. … … 1174 1173 * Filters plugin-added group-related custom component_actions. 1175 1174 * 1176 * @since BuddyPress (2.4.0)1175 * @since 2.4.0 1177 1176 * 1178 1177 * @param string $notification Null value. … … 1196 1195 * Fires right before returning the formatted group notifications. 1197 1196 * 1198 * @since BuddyPress (1.0.0)1197 * @since 1.0.0 1199 1198 * 1200 1199 * @param string $action The type of notification being rendered. … … 1211 1210 * Remove all notifications for any member belonging to a specific group. 1212 1211 * 1213 * @since BuddyPress (1.9.0)1212 * @since 1.9.0 1214 1213 * 1215 1214 * @param int $group_id ID of the group. … … 1225 1224 * When a demotion takes place, delete any corresponding promotion notifications. 1226 1225 * 1227 * @since BuddyPress (2.0.0)1226 * @since 2.0.0 1228 1227 * 1229 1228 * @param int $user_id ID of the user. … … 1241 1240 * Mark notifications read when a member accepts a group invitation. 1242 1241 * 1243 * @since BuddyPress (1.9.0)1242 * @since 1.9.0 1244 1243 * 1245 1244 * @param int $user_id ID of the user. … … 1258 1257 * Mark notifications read when a member views their group memberships. 1259 1258 * 1260 * @since BuddyPress (1.9.0)1259 * @since 1.9.0 1261 1260 */ 1262 1261 function bp_groups_screen_my_groups_mark_notifications() { … … 1282 1281 * Mark group invitation notifications read when a member views their invitations. 1283 1282 * 1284 * @since BuddyPress (1.9.0)1283 * @since 1.9.0 1285 1284 */ 1286 1285 function bp_groups_screen_invites_mark_notifications() { … … 1294 1293 * Mark group join requests read when an admin or moderator visits the group administration area. 1295 1294 * 1296 * @since BuddyPress (1.9.0)1295 * @since 1.9.0 1297 1296 */ 1298 1297 function bp_groups_screen_group_admin_requests_mark_notifications() { … … 1306 1305 * Delete new group membership notifications when a user is being deleted. 1307 1306 * 1308 * @since BuddyPress (1.9.0)1307 * @since 1.9.0 1309 1308 * 1310 1309 * @param int $user_id ID of the user. -
trunk/src/bp-groups/bp-groups-screens.php
r10081 r10148 1 1 <?php 2 3 2 /** 4 3 * BuddyPress Groups Screen Functions … … 12 11 */ 13 12 14 // Exit if accessed directly 13 // Exit if accessed directly. 15 14 defined( 'ABSPATH' ) || exit; 16 15 … … 25 24 * Fires before the loading of the Groups directory index. 26 25 * 27 * @since BuddyPress (1.1.0)26 * @since 1.1.0 28 27 */ 29 28 do_action( 'groups_directory_groups_setup' ); … … 32 31 * Filters the template to load for the Groups directory index. 33 32 * 34 * @since BuddyPress (1.0.0)33 * @since 1.0.0 35 34 * 36 35 * @param string $value Path to the groups directory index template to load. … … 49 48 * Fires before the loading of the My Groups page. 50 49 * 51 * @since BuddyPress (1.1.0)50 * @since 1.1.0 52 51 */ 53 52 do_action( 'groups_screen_my_groups' ); … … 56 55 * Filters the template to load for the My Groups page. 57 56 * 58 * @since BuddyPress (1.0.0)57 * @since 1.0.0 59 58 * 60 59 * @param string $value Path to the My Groups page template to load. … … 119 118 * Fires before the loading of a users Groups > Invites template. 120 119 * 121 * @since BuddyPress (1.0.0)120 * @since 1.0.0 122 121 * 123 122 * @param int $group_id ID of the group being displayed … … 128 127 * Filters the template to load for a users Groups > Invites page. 129 128 * 130 * @since BuddyPress (1.0.0)129 * @since 1.0.0 131 130 * 132 131 * @param string $value Path to a users Groups > Invites page template. … … 147 146 * Fires before the loading of a single group's page. 148 147 * 149 * @since BuddyPress (1.0.0)148 * @since 1.0.0 150 149 */ 151 150 do_action( 'groups_screen_group_home' ); … … 154 153 * Filters the template to load for a single group's page. 155 154 * 156 * @since BuddyPress (1.0.0)155 * @since 1.0.0 157 156 * 158 157 * @param string $value Path to a single group's template to load. … … 243 242 * Fires after a group forum topic has been stickied. 244 243 * 245 * @since BuddyPress (1.1.0)244 * @since 1.1.0 246 245 * 247 246 * @param int $topic_id ID of the topic being stickied. … … 265 264 * Fires after a group forum topic has been un-stickied. 266 265 * 267 * @since BuddyPress (1.1.0)266 * @since 1.1.0 268 267 * 269 268 * @param int $topic_id ID of the topic being un-stickied. … … 287 286 * Fires after a group forum topic has been closed. 288 287 * 289 * @since BuddyPress (1.1.0)288 * @since 1.1.0 290 289 * 291 290 * @param int $topic_id ID of the topic being closed. … … 309 308 * Fires after a group forum topic has been opened. 310 309 * 311 * @since BuddyPress (1.1.0)310 * @since 1.1.0 312 311 * 313 312 * @param int $topic_id ID of the topic being opened. … … 333 332 * Fires before a group forum topic is deleted. 334 333 * 335 * @since BuddyPress (1.5.0)334 * @since 1.5.0 336 335 * 337 336 * @param int $topic_id ID of the topic being deleted. … … 348 347 * Fires after a group forum topic has been deleted. 349 348 * 350 * @since BuddyPress (1.5.0)349 * @since 1.5.0 351 350 * 352 351 * @param int $topic_id ID of the topic being deleted. … … 381 380 * Fires after a group forum topic has been edited. 382 381 * 383 * @since BuddyPress (1.1.0)382 * @since 1.1.0 384 383 * 385 384 * @param int $topic_id ID of the topic being edited. … … 392 391 * Filters the template to load for a topic edit page. 393 392 * 394 * @since BuddyPress (1.1.0)393 * @since 1.1.0 395 394 * 396 395 * @param string $value Path to a topic edit template. … … 414 413 * Fires before the deletion of a group forum post. 415 414 * 416 * @since BuddyPress (1.5.0)415 * @since 1.5.0 417 416 * 418 417 * @param int $post_id ID of the forum post being deleted. … … 429 428 * Fires after the deletion of a group forum post. 430 429 * 431 * @since BuddyPress (1.1.0)430 * @since 1.1.0 432 431 * 433 432 * @param int $post_id ID of the forum post being deleted. … … 466 465 * Fires after the editing of a group forum post. 467 466 * 468 * @since BuddyPress (1.1.0)467 * @since 1.1.0 469 468 * 470 469 * @param int $post_id ID of the forum post being edited. … … 486 485 * Filters the template to load for a topic page. 487 486 * 488 * @since BuddyPress (1.1.0)487 * @since 1.1.0 489 488 * 490 489 * @param string $value Path to a topic template. … … 542 541 * Fires at the end of the group forum screen loading process. 543 542 * 544 * @since BuddyPress (1.0.0)543 * @since 1.0.0 545 544 * 546 545 * @param int $topic_id ID of the topic being displayed. … … 552 551 * Filters the template to load for a group forum page. 553 552 * 554 * @since BuddyPress (1.0.0)553 * @since 1.0.0 555 554 * 556 555 * @param string $value Path to a group forum template. … … 576 575 * Fires before the loading of a group's Members page. 577 576 * 578 * @since BuddyPress (1.0.0)577 * @since 1.0.0 579 578 * 580 579 * @param int $id ID of the group whose members are being displayed. … … 585 584 * Filters the template to load for a group's Members page. 586 585 * 587 * @since BuddyPress (1.0.0)586 * @since 1.0.0 588 587 * 589 588 * @param string $value Path to a group's Members template. … … 620 619 * Fires after the sending of a group invite inside the group's Send Invites page. 621 620 * 622 * @since BuddyPress (1.0.0)621 * @since 1.0.0 623 622 * 624 623 * @param int $id ID of the group whose members are being displayed. … … 632 631 * Filters the template to load for a group's Send Invites page. 633 632 * 634 * @since BuddyPress (1.0.0)633 * @since 1.0.0 635 634 * 636 635 * @param string $value Path to a group's Send Invites template. … … 649 648 * Remove Invite removes the invitation via AJAX. 650 649 * 651 * @since BuddyPress (2.0.0)650 * @since 2.0.0 652 651 */ 653 652 function groups_remove_group_invite() { … … 726 725 * Fires before the loading of a group's Request Memebership page. 727 726 * 728 * @since BuddyPress (1.0.0)727 * @since 1.0.0 729 728 * 730 729 * @param int $id ID of the group currently being displayed. … … 735 734 * Filters the template to load for a group's Request Membership page. 736 735 * 737 * @since BuddyPress (1.0.0)736 * @since 1.0.0 738 737 * 739 738 * @param string $value Path to a group's Request Membership template. … … 799 798 * Fires before the redirect if a group details has been edited and saved. 800 799 * 801 * @since BuddyPress (1.0.0)800 * @since 1.0.0 802 801 * 803 802 * @param int $id ID of the group that was edited. … … 811 810 * Fires before the loading of the group admin/edit-details page template. 812 811 * 813 * @since BuddyPress (1.0.0)812 * @since 1.0.0 814 813 * 815 814 * @param int $id ID of the group that is being displayed. … … 820 819 * Filters the template to load for a group's admin/edit-details page. 821 820 * 822 * @since BuddyPress (1.0.0)821 * @since 1.0.0 823 822 * 824 823 * @param string $value Path to a group's admin/edit-details template. … … 869 868 * Fires before the redirect if a group settings has been edited and saved. 870 869 * 871 * @since BuddyPress (1.0.0)870 * @since 1.0.0 872 871 * 873 872 * @param int $id ID of the group that was edited. … … 881 880 * Fires before the loading of the group admin/group-settings page template. 882 881 * 883 * @since BuddyPress (1.0.0)882 * @since 1.0.0 884 883 * 885 884 * @param int $id ID of the group that is being displayed. … … 890 889 * Filters the template to load for a group's admin/group-settings page. 891 890 * 892 * @since BuddyPress (1.0.0)891 * @since 1.0.0 893 892 * 894 893 * @param string $value Path to a group's admin/group-settings template. … … 973 972 * Fires before the loading of the group Change Avatar page template. 974 973 * 975 * @since BuddyPress (1.0.0)974 * @since 1.0.0 976 975 * 977 976 * @param int $id ID of the group that is being displayed. … … 982 981 * Filters the template to load for a group's Change Avatar page. 983 982 * 984 * @since BuddyPress (1.0.0)983 * @since 1.0.0 985 984 * 986 985 * @param string $value Path to a group's Change Avatar template. … … 1021 1020 * Fires before the redirect after a group member has been promoted. 1022 1021 * 1023 * @since BuddyPress (1.0.0)1022 * @since 1.0.0 1024 1023 * 1025 1024 * @param int $user_id ID of the user being promoted. … … 1054 1053 * Fires before the redirect after a group member has been demoted. 1055 1054 * 1056 * @since BuddyPress (1.0.0)1055 * @since 1.0.0 1057 1056 * 1058 1057 * @param int $user_id ID of the user being demoted. … … 1080 1079 * Fires before the redirect after a group member has been banned. 1081 1080 * 1082 * @since BuddyPress (1.0.0)1081 * @since 1.0.0 1083 1082 * 1084 1083 * @param int $user_id ID of the user being banned. … … 1106 1105 * Fires before the redirect after a group member has been unbanned. 1107 1106 * 1108 * @since BuddyPress (1.0.0)1107 * @since 1.0.0 1109 1108 * 1110 1109 * @param int $user_id ID of the user being unbanned. … … 1132 1131 * Fires before the redirect after a group member has been removed. 1133 1132 * 1134 * @since BuddyPress (1.2.6)1133 * @since 1.2.6 1135 1134 * 1136 1135 * @param int $user_id ID of the user being removed. … … 1146 1145 * Fires before the loading of a group's manage members template. 1147 1146 * 1148 * @since BuddyPress (1.0.0)1147 * @since 1.0.0 1149 1148 * 1150 1149 * @param int $id ID of the group whose manage members page is being displayed. … … 1155 1154 * Filters the template to load for a group's manage members page. 1156 1155 * 1157 * @since BuddyPress (1.0.0)1156 * @since 1.0.0 1158 1157 * 1159 1158 * @param string $value Path to a group's manage members template. … … 1208 1207 * Fires before the redirect if a group membership request has been handled. 1209 1208 * 1210 * @since BuddyPress (1.0.0)1209 * @since 1.0.0 1211 1210 * 1212 1211 * @param int $id ID of the group that was edited. … … 1221 1220 * Fires before the loading of the group membership request page template. 1222 1221 * 1223 * @since BuddyPress (1.0.0)1222 * @since 1.0.0 1224 1223 * 1225 1224 * @param int $id ID of the group that is being displayed. … … 1230 1229 * Filters the template to load for a group's membership request page. 1231 1230 * 1232 * @since BuddyPress (1.0.0)1231 * @since 1.0.0 1233 1232 * 1234 1233 * @param string $value Path to a group's membership request template. … … 1261 1260 * Fires before the deletion of a group from the Delete Group page. 1262 1261 * 1263 * @since BuddyPress (1.5.0)1262 * @since 1.5.0 1264 1263 * 1265 1264 * @param int $id ID of the group being deleted. … … 1276 1275 * Fires after the deletion of a group from the Delete Group page. 1277 1276 * 1278 * @since BuddyPress (1.0.0)1277 * @since 1.0.0 1279 1278 * 1280 1279 * @param int $id ID of the group being deleted. … … 1291 1290 * Fires before the loading of the Delete Group page template. 1292 1291 * 1293 * @since BuddyPress (1.0.0)1292 * @since 1.0.0 1294 1293 * 1295 1294 * @param int $id ID of the group that is being displayed. … … 1300 1299 * Filters the template to load for the Delete Group page. 1301 1300 * 1302 * @since BuddyPress (1.0.0)1301 * @since 1.0.0 1303 1302 * 1304 1303 * @param string $value Path to the Delete Group template. … … 1366 1365 * Fires at the end of the available group settings fields on Notification Settings page. 1367 1366 * 1368 * @since BuddyPress (1.0.0)1367 * @since 1.0.0 1369 1368 */ 1370 1369 do_action( 'groups_screen_notification_settings' ); ?> … … 1385 1384 * group template parts to the_title and the_content areas of a theme. 1386 1385 * 1387 * @since BuddyPress (1.7.0)1386 * @since 1.7.0 1388 1387 */ 1389 1388 class BP_Groups_Theme_Compat { … … 1392 1391 * Set up theme compatibility for the Groups component. 1393 1392 * 1394 * @since BuddyPress (1.7.0)1393 * @since 1.7.0 1395 1394 */ 1396 1395 public function __construct() { … … 1401 1400 * Are we looking at something that needs group theme compatibility? 1402 1401 * 1403 * @since BuddyPress (1.7.0)1402 * @since 1.7.0 1404 1403 */ 1405 1404 public function is_group() { … … 1416 1415 * Fires at the start of the group theme compatibility setup. 1417 1416 * 1418 * @since BuddyPress (1.1.0)1417 * @since 1.1.0 1419 1418 */ 1420 1419 do_action( 'groups_directory_groups_setup' ); … … 1447 1446 * {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}. 1448 1447 * 1449 * @since BuddyPress (1.8.0)1448 * @since 1.8.0 1450 1449 * 1451 1450 * @param string $templates The templates from bp_get_theme_compat_templates(). … … 1457 1456 * Filters the Groups directory page template hierarchy based on priority. 1458 1457 * 1459 * @since BuddyPress (1.8.0)1458 * @since 1.8.0 1460 1459 * 1461 1460 * @param array $value Array of default template files to use. … … 1475 1474 * Update the global $post with directory data. 1476 1475 * 1477 * @since BuddyPress (1.7.0)1476 * @since 1.7.0 1478 1477 */ 1479 1478 public function directory_dummy_post() { … … 1494 1493 * Filter the_content with the groups index template part. 1495 1494 * 1496 * @since BuddyPress (1.7.0)1495 * @since 1.7.0 1497 1496 */ 1498 1497 public function directory_content() { … … 1508 1507 * {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}. 1509 1508 * 1510 * @since BuddyPress (1.8.0)1509 * @since 1.8.0 1511 1510 * 1512 1511 * @param string $templates The templates from bp_get_theme_compat_templates(). … … 1519 1518 * Filters the Groups create page template hierarchy based on priority. 1520 1519 * 1521 * @since BuddyPress (1.8.0)1520 * @since 1.8.0 1522 1521 * 1523 1522 * @param array $value Array of default template files to use. … … 1537 1536 * Update the global $post with create screen data. 1538 1537 * 1539 * @since BuddyPress (1.7.0)1538 * @since 1.7.0 1540 1539 */ 1541 1540 public function create_dummy_post() { … … 1559 1558 * Filter the_content with the create screen template part. 1560 1559 * 1561 * @since BuddyPress (1.7.0)1560 * @since 1.7.0 1562 1561 */ 1563 1562 public function create_content() { … … 1573 1572 * {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}. 1574 1573 * 1575 * @since BuddyPress (1.8.0)1574 * @since 1.8.0 1576 1575 * 1577 1576 * @param string $templates The templates from bp_get_theme_compat_templates(). … … 1585 1584 * Filters the Groups single pages template hierarchy based on priority. 1586 1585 * 1587 * @since BuddyPress (1.8.0)1586 * @since 1.8.0 1588 1587 * 1589 1588 * @param array $value Array of default template files to use. … … 1607 1606 * Update the global $post with single group data. 1608 1607 * 1609 * @since BuddyPress (1.7.0)1608 * @since 1.7.0 1610 1609 */ 1611 1610 public function single_dummy_post() { … … 1626 1625 * Filter the_content with the single group template part. 1627 1626 * 1628 * @since BuddyPress (1.7.0)1627 * @since 1.7.0 1629 1628 */ 1630 1629 public function single_content() { -
trunk/src/bp-groups/bp-groups-template.php
r10126 r10148 1 1 <?php 2 3 2 /** 4 3 * BuddyPress Groups Template Functions. 5 */ 6 7 // Exit if accessed directly 4 * 5 * @package BuddyPress 6 * @subpackage GroupsTemplates 7 */ 8 9 // Exit if accessed directly. 8 10 defined( 'ABSPATH' ) || exit; 9 11 … … 11 13 * Output the groups component slug. 12 14 * 13 * @since BuddyPress (1.5.0)15 * @since 1.5.0 14 16 */ 15 17 function bp_groups_slug() { … … 19 21 * Return the groups component slug. 20 22 * 21 * @since BuddyPress (1.5.0)23 * @since 1.5.0 22 24 * 23 25 * @return string … … 28 30 * Filters the groups component slug. 29 31 * 30 * @since BuddyPress (1.5.0)32 * @since 1.5.0 31 33 * 32 34 * @param string $slug Groups component slug. … … 38 40 * Output the groups component root slug. 39 41 * 40 * @since BuddyPress (1.5.0)42 * @since 1.5.0 41 43 */ 42 44 function bp_groups_root_slug() { … … 46 48 * Return the groups component root slug. 47 49 * 48 * @since BuddyPress (1.5.0)50 * @since 1.5.0 49 51 * 50 52 * @return string … … 55 57 * Filters the groups component root slug. 56 58 * 57 * @since BuddyPress (1.5.0)59 * @since 1.5.0 58 60 * 59 61 * @param string $root_slug Groups component root slug. … … 65 67 * Output group directory permalink. 66 68 * 67 * @since BuddyPress (1.5.0)69 * @since 1.5.0 68 70 */ 69 71 function bp_groups_directory_permalink() { … … 73 75 * Return group directory permalink. 74 76 * 75 * @since BuddyPress (1.5.0)77 * @since 1.5.0 76 78 * 77 79 * @return string … … 82 84 * Filters the group directory permalink. 83 85 * 84 * @since BuddyPress (1.5.0)86 * @since 1.5.0 85 87 * 86 88 * @param string $value Permalink for the group directory. … … 427 429 * Fires right before the rewinding of groups list. 428 430 * 429 * @since BuddyPress (1.5.0)431 * @since 1.5.0 430 432 */ 431 433 do_action('group_loop_end'); … … 456 458 * Fires if the current group item is the first in the loop. 457 459 * 458 * @since BuddyPress (1.1.0)460 * @since 1.1.0 459 461 */ 460 462 do_action( 'group_loop_start' ); … … 466 468 * Start the Groups Template Loop. 467 469 * 468 * @since BuddyPress (1.0.0)470 * @since 1.0.0 469 471 * 470 472 * @param array|string $args { … … 587 589 * Filters whether or not there are groups to iterate over for the groups loop. 588 590 * 589 * @since BuddyPress (1.1.0)591 * @since 1.1.0 590 592 * 591 593 * @param bool $value Whether or not there are groups to iterate over. … … 671 673 * Filters the ID of the current group in the loop. 672 674 * 673 * @since BuddyPress (1.0.0)675 * @since 1.0.0 674 676 * 675 677 * @param int $id ID of the current group in the loop. … … 681 683 * Output the row class of the current group in the loop. 682 684 * 683 * @since BuddyPress (1.7.0)685 * @since 1.7.0 684 686 * 685 687 * @param array $classes Array of custom classes. … … 691 693 * Get the row class of the current group in the loop. 692 694 * 693 * @since BuddyPress (1.7.0)695 * @since 1.7.0 694 696 * 695 697 * @param array $classes Array of custom classes. … … 742 744 * Filters classes that will be applied to row class of the current group in the loop. 743 745 * 744 * @since BuddyPress (1.7.0)746 * @since 1.7.0 745 747 * 746 748 * @param array $classes Array of determined classes for the row. … … 780 782 * Filters the name of the current group in the loop. 781 783 * 782 * @since BuddyPress (1.0.0)784 * @since 1.0.0 783 785 * 784 786 * @param string $name Name of the current group in the loop. … … 825 827 * Filters the type for the current group in the loop. 826 828 * 827 * @since BuddyPress (1.0.0)829 * @since 1.0.0 828 830 * 829 831 * @param string $type Type for the current group in the loop. … … 858 860 * Filters the status of the current group in the loop. 859 861 * 860 * @since BuddyPress (1.0.0)862 * @since 1.0.0 861 863 * 862 864 * @param string $status Status of the current group in the loop. … … 868 870 * Output the group avatar while in the groups loop. 869 871 * 870 * @since BuddyPress (1.0.0)872 * @since 1.0.0 871 873 * 872 874 * @param array|string $args { … … 880 882 * Get a group's avatar. 881 883 * 882 * @since BuddyPress (1.0.0)884 * @since 1.0.0 883 885 * 884 886 * @see bp_core_fetch_avatar() For a description of arguments and return values. … … 937 939 * Filters the group avatar while in the groups loop. 938 940 * 939 * @since BuddyPress (1.0.0)941 * @since 1.0.0 940 942 * 941 943 * @param string $avatar HTML image element holding the group avatar. … … 948 950 * Output the group avatar thumbnail while in the groups loop. 949 951 * 950 * @since BuddyPress (1.0.0)952 * @since 1.0.0 951 953 * 952 954 * @param object|bool $group Optional. Group object. … … 959 961 * Return the group avatar thumbnail while in the groups loop. 960 962 * 961 * @since BuddyPress (1.0.0)963 * @since 1.0.0 962 964 * 963 965 * @param object|bool $group Optional. Group object. … … 976 978 * Output the miniature group avatar thumbnail while in the groups loop. 977 979 * 978 * @since BuddyPress (1.0.0)980 * @since 1.0.0 979 981 * 980 982 * @param object|bool $group Optional. Group object. … … 987 989 * Return the miniature group avatar thumbnail while in the groups loop. 988 990 * 989 * @since BuddyPress (1.0.0)991 * @since 1.0.0 990 992 * 991 993 * @param object|bool $group Optional. Group object. … … 1040 1042 * Filters the 'last active' string for the current gorup in the loop. 1041 1043 * 1042 * @since BuddyPress (1.0.0)1044 * @since 1.0.0 1043 1045 * 1044 1046 * @param string $value Determined last active value for the current group. … … 1075 1077 * Filters the permalink for the current group in the loop. 1076 1078 * 1077 * @since BuddyPress (1.0.0)1079 * @since 1.0.0 1078 1080 * 1079 1081 * @param string $value Permalink for the current group in the loop. … … 1109 1111 * Filters the permalink for the admin section of the current group in the loop. 1110 1112 * 1111 * @since BuddyPress (1.0.0)1113 * @since 1.0.0 1112 1114 * 1113 1115 * @param string $value Permalink for the admin section of the current group in the loop. … … 1143 1145 * Filters the slug for the current group in the loop. 1144 1146 * 1145 * @since BuddyPress (1.0.0)1147 * @since 1.0.0 1146 1148 * 1147 1149 * @param string $slug Slug for the current group in the loop. … … 1177 1179 * Filters the description for the current group in the loop. 1178 1180 * 1179 * @since BuddyPress (1.0.0)1181 * @since 1.0.0 1180 1182 * 1181 1183 * @param string $value Description for the current group. … … 1219 1221 * appropriate for "raw" editing. 1220 1222 * 1221 * @since BuddyPress (1.0.0)1223 * @since 1.0.0 1222 1224 * 1223 1225 * @param string $description Description for the current group in the loop. … … 1255 1257 * Filters the excerpt of a group description. 1256 1258 * 1257 * @since BuddyPress (1.0.0)1259 * @since 1.0.0 1258 1260 * 1259 1261 * @param string $value Excerpt of a group description. … … 1356 1358 * Filters the created date of the current group in the loop. 1357 1359 * 1358 * @since BuddyPress (1.0.0)1360 * @since 1.0.0 1359 1361 * 1360 1362 * @param string $value Created date for the current group. … … 1390 1392 * Filters the username of the creator of the current group in the loop. 1391 1393 * 1392 * @since BuddyPress (1.7.0)1394 * @since 1.7.0 1393 1395 * 1394 1396 * @param string $value Username of the group creator. … … 1424 1426 * Filters the user ID of the creator of the current group in the loop. 1425 1427 * 1426 * @since BuddyPress (1.7.0)1428 * @since 1.7.0 1427 1429 * 1428 1430 * @param int $creator_id User ID of the group creator. … … 1458 1460 * Filters the permalink of the creator of the current group in the loop. 1459 1461 * 1460 * @since BuddyPress (1.7.0)1462 * @since 1.7.0 1461 1463 * 1462 1464 * @param string $value Permalink of the group creator. … … 1543 1545 * Filters the avatar of the creator of the current group in the loop. 1544 1546 * 1545 * @since BuddyPress (1.7.0)1547 * @since 1.7.0 1546 1548 * 1547 1549 * @param string $avatar Avatar of the group creator. … … 1663 1665 * Return a list of user IDs for a group's admins. 1664 1666 * 1665 * @since BuddyPress (1.5.0)1667 * @since 1.5.0 1666 1668 * 1667 1669 * @param BP_Groups_Group|bool $group Optional. The group being queried. Defaults … … 1695 1697 * This filter may return either an array or a comma separated string. 1696 1698 * 1697 * @since BuddyPress (1.5.0)1699 * @since 1.5.0 1698 1700 * 1699 1701 * @param array|string $admin_ids List of user IDs for a group's admins. … … 1705 1707 * Return a list of user IDs for a group's moderators. 1706 1708 * 1707 * @since BuddyPress (1.5.0)1709 * @since 1.5.0 1708 1710 * 1709 1711 * @param BP_Groups_Group|bool $group Optional. The group being queried. … … 1737 1739 * This filter may return either an array or a comma separated string. 1738 1740 * 1739 * @since BuddyPress (1.5.0)1741 * @since 1.5.0 1740 1742 * 1741 1743 * @param array|string $admin_ids List of user IDs for a group's moderators. … … 1768 1770 * Filters the permalink of the Members page for the current group in the loop. 1769 1771 * 1770 * @since BuddyPress (1.0.0)1772 * @since 1.0.0 1771 1773 * 1772 1774 * @param string $value Permalink of the Members page for the current group. … … 1850 1852 * Filters the pagination HTML for a group loop. 1851 1853 * 1852 * @since BuddyPress (1.2.0)1854 * @since 1.2.0 1853 1855 * 1854 1856 * @param string $pag_links HTML markup for the pagination links. … … 1885 1887 * Filters the "Viewing x-y of z groups" pagination message. 1886 1888 * 1887 * @since BuddyPress (1.5.0)1889 * @since 1.5.0 1888 1890 * 1889 1891 * @param string $message "Viewing x-y of z groups" text. … … 1941 1943 * Filters the total member count for a group. 1942 1944 * 1943 * @since BuddyPress (1.0.0)1945 * @since 1.0.0 1944 1946 * 1945 1947 * @param int $total_member_count Total member count for a group. … … 1973 1975 * Filters the "x members" count string for a group. 1974 1976 * 1975 * @since BuddyPress (1.2.0)1977 * @since 1.2.0 1976 1978 * 1977 1979 * @param string $count_string The "x members" count string for a group. … … 2004 2006 * Filters the URL of the Forum page of a group. 2005 2007 * 2006 * @since BuddyPress (1.0.0)2008 * @since 1.0.0 2007 2009 * 2008 2010 * @param string $value URL permalink for the Forum Page. … … 2065 2067 * Filters the topic count string for a group forum. 2066 2068 * 2067 * @since BuddyPress (1.2.0)2069 * @since 1.2.0 2068 2070 * 2069 2071 * @param string $total_topics Total topic count string. … … 2127 2129 * Filters the post count string for a group forum. 2128 2130 * 2129 * @since BuddyPress (1.2.0)2131 * @since 1.2.0 2130 2132 * 2131 2133 * @param string $total_posts Total post count string. … … 2194 2196 * Output the 'checked' value, if needed, for a given invite_status on the group create/admin screens 2195 2197 * 2196 * @since BuddyPress (1.5.0)2198 * @since 1.5.0 2197 2199 * 2198 2200 * @param string $setting The setting you want to check against ('members', … … 2221 2223 * This function can be used either in or out of the loop. 2222 2224 * 2223 * @since BuddyPress (1.5.0)2225 * @since 1.5.0 2224 2226 * 2225 2227 * @param int|bool $group_id Optional. The ID of the group whose status you want to … … 2260 2262 * Invite status in this case means who from the group can send invites. 2261 2263 * 2262 * @since BuddyPress (1.5.0)2264 * @since 1.5.0 2263 2265 * 2264 2266 * @param string $invite_status Membership level needed to send an invite. … … 2271 2273 * Can a user send invitations in the specified group? 2272 2274 * 2273 * @since BuddyPress (1.5.0)2274 * @since BuddyPress (2.2.0)Added the $user_id parameter.2275 * @since 1.5.0 2276 * @since 2.2.0 Added the $user_id parameter. 2275 2277 * 2276 2278 * @param int $group_id The group ID to check. … … 2324 2326 * Filters whether a user can send invites in a group. 2325 2327 * 2326 * @since BuddyPress (1.5.0)2327 * @since BuddyPress (2.2.0)Added the $user_id parameter.2328 * @since 1.5.0 2329 * @since 2.2.0 Added the $user_id parameter. 2328 2330 * 2329 2331 * @param bool $can_send_invites Whether the user can send invites … … 2341 2343 * @deprecated 1.5 2342 2344 * @deprecated No longer used. 2343 * @since BuddyPress (1.0.0)2345 * @since 1.0.0 2344 2346 * @todo Remove in 1.4 2345 2347 * … … 2506 2508 * Filters whether a group has moderators. 2507 2509 * 2508 * @since BuddyPress (1.0.0)2510 * @since 1.0.0 2509 2511 * 2510 2512 * @param array $value Array of user IDs who are a moderator of the provided group. … … 2545 2547 * Filters a URL for promoting a user to moderator. 2546 2548 * 2547 * @since BuddyPress (1.1.0)2549 * @since 1.1.0 2548 2550 * 2549 2551 * @param string $value URL to use for promoting a user to moderator. … … 2584 2586 * Filters a URL for promoting a user to admin. 2585 2587 * 2586 * @since BuddyPress (1.1.0)2588 * @since 1.1.0 2587 2589 * 2588 2590 * @param string $value URL to use for promoting a user to admin. … … 2629 2631 * Filters a URL for demoting a user to member. 2630 2632 * 2631 * @since BuddyPress (1.0.0)2633 * @since 1.0.0 2632 2634 * 2633 2635 * @param string $value URL to use for demoting a user to member. … … 2670 2672 * Filters a URL for banning a member from a group. 2671 2673 * 2672 * @since BuddyPress (1.0.0)2674 * @since 1.0.0 2673 2675 * 2674 2676 * @param string $value URL to use for banning a member. … … 2715 2717 * Filters a URL for unbanning a member from a group. 2716 2718 * 2717 * @since BuddyPress (1.0.0)2719 * @since 1.0.0 2718 2720 * 2719 2721 * @param string $value URL to use for unbanning a member. … … 2756 2758 * Filters a URL for removing a member from a group. 2757 2759 * 2758 * @since BuddyPress (1.2.6)2760 * @since 1.2.6 2759 2761 * 2760 2762 * @param string $value URL to use for removing a member. … … 2837 2839 * FIlters the group count for a displayed user. 2838 2840 * 2839 * @since BuddyPress (1.1.0)2841 * @since 1.1.0 2840 2842 * 2841 2843 * @param int $value Total group count for a displayed user. … … 2871 2873 * Filters the 'action' attribute for a group form. 2872 2874 * 2873 * @since BuddyPress (1.0.0)2875 * @since 1.0.0 2874 2876 * 2875 2877 * @param string $value Action attribute for a group form. … … 2909 2911 * Filters the 'action' attribute for a group admin form. 2910 2912 * 2911 * @since BuddyPress (1.0.0)2913 * @since 1.0.0 2912 2914 * 2913 2915 * @param string $value Action attribute for a group admin form. … … 2963 2965 * Filters whether current user is member of a group. 2964 2966 * 2965 * @since BuddyPress (1.2.4)2967 * @since 1.2.4 2966 2968 * 2967 2969 * @param bool $is_member If user is a member of group or not. … … 2988 2990 * Filters whether current user has an outstanding invite to current group in loop. 2989 2991 * 2990 * @since BuddyPress (2.1.0)2992 * @since 2.1.0 2991 2993 * 2992 2994 * @param bool $is_invited If user has an outstanding group invite. … … 3008 3010 * capability, the return value would be boolean false. 3009 3011 * 3010 * @since BuddyPress (1.5.0)3012 * @since 1.5.0 3011 3013 * 3012 3014 * @global BP_Groups_Template $groups_template Group template loop object. … … 3051 3053 * Filters whether current user has been banned from current group in loop. 3052 3054 * 3053 * @since BuddyPress (1.5.0)3055 * @since 1.5.0 3054 3056 * 3055 3057 * @param bool $is_invited If user has been from current group. … … 3084 3086 * Filters the URL for accepting an invitation to a group. 3085 3087 * 3086 * @since BuddyPress (1.0.0)3088 * @since 1.0.0 3087 3089 * 3088 3090 * @param string $value URL for accepting an invitation to a group. … … 3117 3119 * Filters the URL for rejecting an invitation to a group. 3118 3120 * 3119 * @since BuddyPress (1.0.0)3121 * @since 1.0.0 3120 3122 * 3121 3123 * @param string $value URL for rejecting an invitation to a group. … … 3148 3150 * Filters the URL for confirming a request to leave a group. 3149 3151 * 3150 * @since BuddyPress (1.0.0)3152 * @since 1.0.0 3151 3153 * 3152 3154 * @param string $value URL for confirming a request to leave a group. … … 3179 3181 * Filters the URL for rejecting a request to leave a group. 3180 3182 * 3181 * @since BuddyPress (1.0.0)3183 * @since 1.0.0 3182 3184 * 3183 3185 * @param string $value URL for rejecting a request to leave a group. … … 3210 3212 * Filters the 'action' attribute for a group send invite form. 3211 3213 * 3212 * @since BuddyPress (1.0.0)3214 * @since 1.0.0 3213 3215 * 3214 3216 * @param string $value Action attribute for a group send invite form. … … 3246 3248 * Output a 'New Topic' button for a group. 3247 3249 * 3248 * @since BuddyPress (1.2.7)3250 * @since 1.2.7 3249 3251 * 3250 3252 * @param BP_Groups_Group|bool $group The BP Groups_Group object if passed, … … 3258 3260 * Returns a 'New Topic' button for a group. 3259 3261 * 3260 * @since BuddyPress (1.2.7)3262 * @since 1.2.7 3261 3263 * 3262 3264 * @param BP_Groups_Group|bool $group The BP Groups_Group object if … … 3292 3294 * Filters the HTML button for creating a new topic in a group. 3293 3295 * 3294 * @since BuddyPress (1.5.0)3296 * @since 1.5.0 3295 3297 * 3296 3298 * @param string $button HTML button for a new topic. … … 3302 3304 * Output button to join a group. 3303 3305 * 3304 * @since BuddyPress (1.0.0)3306 * @since 1.0.0 3305 3307 * 3306 3308 * @param object|bool $group Single group object. … … 3312 3314 * Return button to join a group. 3313 3315 * 3314 * @since BuddyPress (1.0.0)3316 * @since 1.0.0 3315 3317 * 3316 3318 * @param object|bool $group Single group object. … … 3440 3442 * Filters the HTML button for joining a group. 3441 3443 * 3442 * @since BuddyPress (1.2.6)3443 * @since BuddyPress (2.4.0)Added $group parameter to filter args.3444 * @since 1.2.6 3445 * @since 2.4.0 Added $group parameter to filter args. 3444 3446 * 3445 3447 * @param string $button HTML button for joining a group. … … 3452 3454 * Output the Create a Group button. 3453 3455 * 3454 * @since BuddyPress (2.0.0)3456 * @since 2.0.0 3455 3457 */ 3456 3458 function bp_group_create_button() { … … 3460 3462 * Get the Create a Group button. 3461 3463 * 3462 * @since BuddyPress (2.0.0)3464 * @since 2.0.0 3463 3465 * 3464 3466 * @return string … … 3487 3489 * Filters the HTML button for creating a group. 3488 3490 * 3489 * @since BuddyPress (2.0.0)3491 * @since 2.0.0 3490 3492 * 3491 3493 * @param string $button HTML button for creating a group. … … 3497 3499 * Output the Create a Group nav item. 3498 3500 * 3499 * @since BuddyPress (2.2.0)3501 * @since 2.2.0 3500 3502 */ 3501 3503 function bp_group_create_nav_item() { … … 3506 3508 * Get the Create a Group nav item. 3507 3509 * 3508 * @since BuddyPress (2.2.0)3510 * @since 2.2.0 3509 3511 * 3510 3512 * @return string … … 3524 3526 * Filters the Create a Group nav item. 3525 3527 * 3526 * @since BuddyPress (2.2.0)3528 * @since 2.2.0 3527 3529 * 3528 3530 * @param string $output HTML output for nav item. … … 3535 3537 * if so, transform the title button into a Groups directory nav item. 3536 3538 * 3537 * @since BuddyPress (2.2.0)3539 * @since 2.2.0 3538 3540 * 3539 3541 * @uses bp_group_create_nav_item() to output the create a Group nav item. … … 3559 3561 * hidden or private group, and the user does not have access). 3560 3562 * 3561 * @since BuddyPress (1.0.0)3563 * @since 1.0.0 3562 3564 * 3563 3565 * @global BP_Groups_Template $groups_template Groups template object. … … 3611 3613 * This will be true if it is a hidden or private group, and the user does not have access. 3612 3614 * 3613 * @since BuddyPress (1.6.0)3615 * @since 1.6.0 3614 3616 * 3615 3617 * @param string $message Message to display to the current user. … … 3624 3626 * This function is no longer used, but may still be used by older themes. 3625 3627 * 3626 * @since BuddyPress (1.0.0)3628 * @since 1.0.0 3627 3629 */ 3628 3630 function bp_group_hidden_fields() { … … 3643 3645 * Output the total number of groups. 3644 3646 * 3645 * @since BuddyPress (1.0.0)3647 * @since 1.0.0 3646 3648 */ 3647 3649 function bp_total_group_count() { … … 3651 3653 * Return the total number of groups. 3652 3654 * 3653 * @since BuddyPress (1.0.0)3655 * @since 1.0.0 3654 3656 * @return type 3655 3657 */ … … 3659 3661 * Filters the total number of groups. 3660 3662 * 3661 * @since BuddyPress (1.0.0)3663 * @since 1.0.0 3662 3664 * 3663 3665 * @param int $value Total number of groups found. … … 3669 3671 * Output the total number of groups a user belongs to. 3670 3672 * 3671 * @since BuddyPress (1.0.0)3673 * @since 1.0.0 3672 3674 * 3673 3675 * @param int $user_id User ID to get group membership count. … … 3681 3683 * Filtered by `bp_core_number_format()` by default 3682 3684 * 3683 * @since BuddyPress (1.0.0)3685 * @since 1.0.0 3684 3686 * 3685 3687 * @param int $user_id User ID to get group membership count. … … 3693 3695 * Filters the total number of groups a user belongs to. 3694 3696 * 3695 * @since BuddyPress (1.2.0)3697 * @since 1.2.0 3696 3698 * 3697 3699 * @param int $count Total number of groups for the user. … … 3855 3857 * Fires right before the rewinding of members list. 3856 3858 * 3857 * @since BuddyPress (1.0.0)3858 * @since BuddyPress (2.3.0)`$this` parameter added.3859 * @since 1.0.0 3860 * @since 2.3.0 `$this` parameter added. 3859 3861 * 3860 3862 * @param BP_Groups_Group_Members_Template $this Instance of the current Members template. … … 3880 3882 * Fires if the current member item is the first in the members list. 3881 3883 * 3882 * @since BuddyPress (1.0.0)3883 * @since BuddyPress (2.3.0)`$this` parameter added.3884 * @since 1.0.0 3885 * @since 2.3.0 `$this` parameter added. 3884 3886 * 3885 3887 * @param BP_Groups_Group_Members_Template $this Instance of the current Members template. … … 3948 3950 * Filters whether or not a group member query has members to display. 3949 3951 * 3950 * @since BuddyPress (1.1.0)3952 * @since 1.1.0 3951 3953 * 3952 3954 * @param bool $value Whether there are members to display. … … 3971 3973 * Output the group member avatar while in the groups members loop. 3972 3974 * 3973 * @since BuddyPress (1.0.0)3975 * @since 1.0.0 3974 3976 * 3975 3977 * @param array|string $args {@see bp_core_fetch_avatar()} … … 3981 3983 * Return the group member avatar while in the groups members loop. 3982 3984 * 3983 * @since BuddyPress (1.0.0)3985 * @since 1.0.0 3984 3986 * 3985 3987 * @param array|string $args {@see bp_core_fetch_avatar()} … … 4000 4002 * Filters the group member avatar while in the groups members loop. 4001 4003 * 4002 * @since BuddyPress (1.0.0)4004 * @since 1.0.0 4003 4005 * 4004 4006 * @param string $value HTML markup for group member avatar. … … 4011 4013 * Output the group member avatar while in the groups members loop. 4012 4014 * 4013 * @since BuddyPress (1.0.0)4015 * @since 1.0.0 4014 4016 * 4015 4017 * @param array|string $args {@see bp_core_fetch_avatar()} … … 4022 4024 * Return the group member avatar while in the groups members loop. 4023 4025 * 4024 * @since BuddyPress (1.0.0)4026 * @since 1.0.0 4025 4027 * 4026 4028 * @param array|string $args {@see bp_core_fetch_avatar()} … … 4041 4043 * Filters the group member avatar thumb while in the groups members loop. 4042 4044 * 4043 * @since BuddyPress (1.1.0)4045 * @since 1.1.0 4044 4046 * 4045 4047 * @param string $value HTML markup for group member avatar thumb. … … 4052 4054 * Output the group member avatar while in the groups members loop. 4053 4055 * 4054 * @since BuddyPress (1.0.0)4056 * @since 1.0.0 4055 4057 * 4056 4058 * @param int $width Width of avatar to fetch. … … 4063 4065 * Output the group member avatar while in the groups members loop. 4064 4066 * 4065 * @since BuddyPress (1.0.0)4067 * @since 1.0.0 4066 4068 * 4067 4069 * @param int $width Width of avatar to fetch. … … 4085 4087 * Filters the group member avatar mini while in the groups members loop. 4086 4088 * 4087 * @since BuddyPress (1.0.0)4089 * @since 1.0.0 4088 4090 * 4089 4091 * @param string $value HTML markup for group member avatar mini. … … 4102 4104 * Filters the group member display name of the current user in the loop. 4103 4105 * 4104 * @since BuddyPress (1.0.0)4106 * @since 1.0.0 4105 4107 * 4106 4108 * @param string $display_name Display name of the current user. … … 4118 4120 * Filters the group member url for the current user in the loop. 4119 4121 * 4120 * @since BuddyPress (1.0.0)4122 * @since 1.0.0 4121 4123 * 4122 4124 * @param string $value URL for the current user. … … 4134 4136 * Filters the group member HTML link for the current user in the loop. 4135 4137 * 4136 * @since BuddyPress (1.0.0)4138 * @since 1.0.0 4137 4139 * 4138 4140 * @param string $value HTML link for the current user. … … 4150 4152 * Filters the group member domain for the current user in the loop. 4151 4153 * 4152 * @since BuddyPress (1.2.0)4154 * @since 1.2.0 4153 4155 * 4154 4156 * @param string $value Domain for the current user. … … 4174 4176 * Filters the friendship status between current user and displayed user in group member loop. 4175 4177 * 4176 * @since BuddyPress (1.2.0)4178 * @since 1.2.0 4177 4179 * 4178 4180 * @param string $friend_status Current status of the friendship. … … 4190 4192 * Filters whether the member is banned from the current group. 4191 4193 * 4192 * @since BuddyPress (1.0.0)4194 * @since 1.0.0 4193 4195 * 4194 4196 * @param bool $is_banned Whether or not the member is banned. … … 4205 4207 * Filters the class to add to the HTML if member is banned. 4206 4208 * 4207 * @since BuddyPress (1.2.6)4209 * @since 1.2.6 4208 4210 * 4209 4211 * @param string $value HTML class to add. … … 4222 4224 * Filters the joined since time for the current member in the loop. 4223 4225 * 4224 * @since BuddyPress (1.0.0)4226 * @since 1.0.0 4225 4227 * 4226 4228 * @param string $value Joined since time. … … 4238 4240 * Filters the member's user ID for group members loop. 4239 4241 * 4240 * @since BuddyPress (1.0.0)4242 * @since 1.0.0 4241 4243 * 4242 4244 * @param int $user_id User ID of the member. … … 4263 4265 * Filters the string to be used as the group pag id. 4264 4266 * 4265 * @since BuddyPress (1.0.0)4267 * @since 1.0.0 4266 4268 * 4267 4269 * @param string $value Value to use for the pag id. … … 4280 4282 * Filters the HTML markup to be used for group member listing pagination. 4281 4283 * 4282 * @since BuddyPress (1.0.0)4284 * @since 1.0.0 4283 4285 * 4284 4286 * @param string $pag_links HTML markup for the pagination. … … 4307 4309 * Filters the "Viewing x-y of z members" pagination message. 4308 4310 * 4309 * @since BuddyPress (1.0.0)4311 * @since 1.0.0 4310 4312 * 4311 4313 * @param string $value "Viewing x-y of z members" text. … … 4330 4332 * Output the Group members template 4331 4333 * 4332 * @since BuddyPress (2.0.0)4334 * @since 2.0.0 4333 4335 * 4334 4336 * @return string html output … … 4350 4352 * Part of bp_groups_members_template_part(). 4351 4353 * 4352 * @since BuddyPress (1.5.0)4354 * @since 1.5.0 4353 4355 */ 4354 4356 do_action( 'bp_members_directory_member_sub_types' ); ?> … … 4368 4370 * Output the Group members filters 4369 4371 * 4370 * @since BuddyPress (2.0.0)4372 * @since 2.0.0 4371 4373 * 4372 4374 * @return string html output … … 4393 4395 * Useful for plugins to add more filter options. 4394 4396 * 4395 * @since BuddyPress (2.0.0)4397 * @since 2.0.0 4396 4398 */ 4397 4399 do_action( 'bp_groups_members_order_options' ); ?> … … 4409 4411 * Determine if the current logged in user can create groups. 4410 4412 * 4411 * @since BuddyPress (1.5.0)4413 * @since 1.5.0 4412 4414 * 4413 4415 * @uses apply_filters() To call 'bp_user_can_create_groups'. … … 4438 4440 * Filters if the current logged in user can create groups. 4439 4441 * 4440 * @since BuddyPress (1.5.0)4442 * @since 1.5.0 4441 4443 * 4442 4444 * @param bool $can_create Whether the person can create groups. … … 4472 4474 * Fires at the end of the creation of the group tabs. 4473 4475 * 4474 * @since BuddyPress (1.0.0)4476 * @since 1.0.0 4475 4477 */ 4476 4478 do_action( 'groups_creation_tabs' ); … … 4483 4485 * Filters the group creation stage title. 4484 4486 * 4485 * @since BuddyPress (1.1.0)4487 * @since 1.1.0 4486 4488 * 4487 4489 * @param string $value HTML markup for the group creation stage title. … … 4504 4506 * Filters the group creation form action. 4505 4507 * 4506 * @since BuddyPress (1.1.0)4508 * @since 1.1.0 4507 4509 * 4508 4510 * @param string $value Action to be used with group creation form. … … 4603 4605 * Filters the new group ID. 4604 4606 * 4605 * @since BuddyPress (1.1.0)4607 * @since 1.1.0 4606 4608 * 4607 4609 * @param int $new_group_id ID of the new group. … … 4622 4624 * Filters the new group name. 4623 4625 * 4624 * @since BuddyPress (1.1.0)4626 * @since 1.1.0 4625 4627 * 4626 4628 * @param string $name Name of the new group. … … 4641 4643 * Filters the new group description. 4642 4644 * 4643 * @since BuddyPress (1.1.0)4645 * @since 1.1.0 4644 4646 * 4645 4647 * @param string $name Description of the new group. … … 4660 4662 * Filters whether or not to enable forums for the new group. 4661 4663 * 4662 * @since BuddyPress (1.1.0)4664 * @since 1.1.0 4663 4665 * 4664 4666 * @param int $forum Whether or not to enable forums. … … 4679 4681 * Filters the new group status. 4680 4682 * 4681 * @since BuddyPress (1.1.0)4683 * @since 1.1.0 4682 4684 * 4683 4685 * @param string $status Status for the new group. … … 4689 4691 * Output the avatar for the group currently being created 4690 4692 * 4691 * @since BuddyPress (1.1.0)4693 * @since 1.1.0 4692 4694 * 4693 4695 * @see bp_core_fetch_avatar() For more information on accepted arguments … … 4701 4703 * Return the avatar for the group currently being created 4702 4704 * 4703 * @since BuddyPress (1.1.0)4705 * @since 1.1.0 4704 4706 * 4705 4707 * @see bp_core_fetch_avatar() For a description of arguments and return values. … … 4744 4746 * Filters the new group avatar. 4745 4747 * 4746 * @since BuddyPress (1.1.0)4748 * @since 1.1.0 4747 4749 * 4748 4750 * @param string $avatar HTML markup for the new group avatar. … … 4756 4758 * Escape & output the URL to the previous group creation step 4757 4759 * 4758 * @since BuddyPress (1.1.0)4760 * @since 1.1.0 4759 4761 */ 4760 4762 function bp_group_creation_previous_link() { … … 4764 4766 * Return the URL to the previous group creation step 4765 4767 * 4766 * @since BuddyPress (1.1.0)4768 * @since 1.1.0 4767 4769 * 4768 4770 * @return string … … 4793 4795 * Filters the permalink for the previous step with the group creation process. 4794 4796 * 4795 * @since BuddyPress (1.1.0)4797 * @since 1.1.0 4796 4798 * 4797 4799 * @param string $url Permalink for the previous step. … … 4803 4805 * Echoes the current group creation step. 4804 4806 * 4805 * @since BuddyPress (1.6.0)4807 * @since 1.6.0 4806 4808 */ 4807 4809 function bp_groups_current_create_step() { … … 4811 4813 * Returns the current group creation step. If none is found, returns an empty string. 4812 4814 * 4813 * @since BuddyPress (1.6.0)4815 * @since 1.6.0 4814 4816 * 4815 4817 * @uses apply_filters() Filter bp_get_groups_current_create_step to modify. … … 4831 4833 * If none is found, returns an empty string. 4832 4834 * 4833 * @since BuddyPress (1.6.0)4835 * @since 1.6.0 4834 4836 * 4835 4837 * @param string $current_create_step Current step in the group creation process. … … 4841 4843 * Is the user looking at the last step in the group creation process. 4842 4844 * 4843 * @since BuddyPress (1.1.0)4845 * @since 1.1.0 4844 4846 * 4845 4847 * @param string $step Step to compare … … 4864 4866 * Filters whether or not user is looking at last step in group creation process. 4865 4867 * 4866 * @since BuddyPress (2.4.0)4868 * @since 2.4.0 4867 4869 * 4868 4870 * @param bool $retval Whether or not we are looking at last step. … … 4876 4878 * Is the user looking at the first step in the group creation process 4877 4879 * 4878 * @since BuddyPress (1.1.0)4880 * @since 1.1.0 4879 4881 * 4880 4882 * @param string $step Step to compare … … 4899 4901 * Filters whether or not user is looking at first step in group creation process. 4900 4902 * 4901 * @since BuddyPress (2.4.0)4903 * @since 2.4.0 4902 4904 * 4903 4905 * @param bool $retval Whether or not we are looking at first step. … … 4911 4913 * Output a list of friends who can be invited to a group 4912 4914 * 4913 * @since BuddyPress (1.0.0)4915 * @since 1.0.0 4914 4916 */ 4915 4917 function bp_new_group_invite_friend_list( $args = array() ) { … … 4919 4921 * Return a list of friends who can be invited to a group 4920 4922 * 4921 * @since BuddyPress (1.0.0)4923 * @since 1.0.0 4922 4924 * 4923 4925 * @param array $args … … 4966 4968 * Filters the array of friends who can be invited to a group. 4967 4969 * 4968 * @since BuddyPress (1.0.0)4970 * @since 1.0.0 4969 4971 * 4970 4972 * @param array $items Array of friends. … … 4999 5001 * Filters the HTML markup for the groups search form. 5000 5002 * 5001 * @since BuddyPress (1.9.0)5003 * @since 1.9.0 5002 5004 * 5003 5005 * @param string $search_form_html HTML markup for the search form. … … 5060 5062 * Is the current page a specific group admin screen? 5061 5063 * 5062 * @since BuddyPress (1.1.0)5064 * @since 1.1.0 5063 5065 * 5064 5066 * @param string $slug … … 5073 5075 * Echoes the current group admin tab slug. 5074 5076 * 5075 * @since BuddyPress (1.6.0)5077 * @since 1.6.0 5076 5078 */ 5077 5079 function bp_group_current_admin_tab() { … … 5081 5083 * Returns the current group admin tab slug. 5082 5084 * 5083 * @since BuddyPress (1.6.0)5085 * @since 1.6.0 5084 5086 * 5085 5087 * @uses apply_filters() Filter bp_get_current_group_admin_tab to modify return value. … … 5097 5099 * Filters the current group admin tab slug. 5098 5100 * 5099 * @since BuddyPress (1.6.0)5101 * @since 1.6.0 5100 5102 * 5101 5103 * @param string $tab Current group admin tab slug. … … 5109 5111 * Outputs the current group avatar. 5110 5112 * 5111 * @since BuddyPress (1.0.0)5113 * @since 1.0.0 5112 5114 * @param string $type thumb or full ? 5113 5115 * @uses bp_get_group_current_avatar() to get the avatar of the current group. … … 5119 5121 * Returns the current group avatar. 5120 5122 * 5121 * @since BuddyPress (2.0.0)5123 * @since 2.0.0 5122 5124 * 5123 5125 * @param string $type thumb or full ? … … 5138 5140 * Filters the current group avatar. 5139 5141 * 5140 * @since BuddyPress (2.0.0)5142 * @since 2.0.0 5141 5143 * 5142 5144 * @param string $group_avatar HTML markup for current group avatar. … … 5148 5150 * Return whether a group has an avatar. 5149 5151 * 5150 * @since BuddyPress (1.1.0)5152 * @since 1.1.0 5151 5153 * 5152 5154 * @param int|bool $group_id … … 5183 5185 * Filters the URL to delete the group avatar. 5184 5186 * 5185 * @since BuddyPress (1.1.0)5187 * @since 1.1.0 5186 5188 * 5187 5189 * @param string $value URL to delete the group avatar. … … 5348 5350 * Fires right before the rewinding of group membership requests list. 5349 5351 * 5350 * @since BuddyPress (1.5.0)5352 * @since 1.5.0 5351 5353 */ 5352 5354 do_action( 'group_request_loop_end' ); … … 5369 5371 * Fires if the current group membership request item is the first in the loop. 5370 5372 * 5371 * @since BuddyPress (1.1.0)5373 * @since 1.1.0 5372 5374 */ 5373 5375 do_action( 'group_request_loop_start' ); … … 5404 5406 * Filters whether or not a group membership query has requests to display. 5405 5407 * 5406 * @since BuddyPress (1.1.0)5408 * @since 1.1.0 5407 5409 * 5408 5410 * @param bool $value Whether there are requests to display. … … 5430 5432 * Filters the requesting user's avatar thumbnail. 5431 5433 * 5432 * @since BuddyPress (1.0.0)5434 * @since 1.0.0 5433 5435 * 5434 5436 * @param string $value HTML markup for the user's avatar thumbnail. … … 5446 5448 * Filters the URL to use to reject a membership request. 5447 5449 * 5448 * @since BuddyPress (1.2.6)5450 * @since 1.2.6 5449 5451 * 5450 5452 * @param string $value URL to use to reject a membership request. … … 5462 5464 * Filters the URL to use to accept a membership request. 5463 5465 * 5464 * @since BuddyPress (1.2.6)5466 * @since 1.2.6 5465 5467 * 5466 5468 * @param string $value URL to use to accept a membership request. … … 5478 5480 * Filters the URL for the user requesting membership. 5479 5481 * 5480 * @since BuddyPress (1.2.6)5482 * @since 1.2.6 5481 5483 * 5482 5484 * @param string $value URL for the user requestion membership. … … 5491 5493 * Filters the formatted time since membership was requested. 5492 5494 * 5493 * @since BuddyPress (1.0.0)5495 * @since 1.0.0 5494 5496 * 5495 5497 * @param string $value Formatted time since membership was requested. … … 5504 5506 * Filters the membership request comment left by user. 5505 5507 * 5506 * @since BuddyPress (1.0.0)5508 * @since 1.0.0 5507 5509 * 5508 5510 * @param string $value Membership request comment left by user. … … 5514 5516 * Output pagination links for group membership requests. 5515 5517 * 5516 * @since BuddyPress (2.0.0)5518 * @since 2.0.0 5517 5519 */ 5518 5520 function bp_group_requests_pagination_links() { … … 5522 5524 * Get pagination links for group membership requests. 5523 5525 * 5524 * @since BuddyPress (2.0.0)5526 * @since 2.0.0 5525 5527 * 5526 5528 * @return string … … 5532 5534 * Filters pagination links for group membership requests. 5533 5535 * 5534 * @since BuddyPress (2.0.0)5536 * @since 2.0.0 5535 5537 * 5536 5538 * @param string $value Pagination links for group membership requests. … … 5542 5544 * Output pagination count text for group membership requests. 5543 5545 * 5544 * @since BuddyPress (2.0.0)5546 * @since 2.0.0 5545 5547 */ 5546 5548 function bp_group_requests_pagination_count() { … … 5550 5552 * Get pagination count text for group membership requests. 5551 5553 * 5552 * @since BuddyPress (2.0.0)5554 * @since 2.0.0 5553 5555 * 5554 5556 * @return string … … 5571 5573 * Filters pagination count text for group membership requests. 5572 5574 * 5573 * @since BuddyPress (2.0.0)5575 * @since 2.0.0 5574 5576 * 5575 5577 * @param string $message Pagination count text for group membership requests. … … 5688 5690 * Fires right before the rewinding of invites list. 5689 5691 * 5690 * @since BuddyPress (1.1.0)5691 * @since BuddyPress (2.3.0)`$this` parameter added.5692 * @since 1.1.0 5693 * @since 2.3.0 `$this` parameter added. 5692 5694 * 5693 5695 * @param BP_Groups_Invite_Template $this Instance of the current Invites template. … … 5747 5749 * Fires if the current invite item is the first in the loop. 5748 5750 * 5749 * @since BuddyPress (1.1.0)5750 * @since BuddyPress (2.3.0)`$this` parameter added.5751 * @since 1.1.0 5752 * @since 2.3.0 `$this` parameter added. 5751 5753 * 5752 5754 * @param BP_Groups_Invite_Template $this Instance of the current Invites template. … … 5789 5791 * Filters whether or not a group invites query has invites to display. 5790 5792 * 5791 * @since BuddyPress (1.1.0)5793 * @since 1.1.0 5792 5794 * 5793 5795 * @param bool $value Whether there are requests to display. … … 5818 5820 * Filters the group invite item ID. 5819 5821 * 5820 * @since BuddyPress (1.1.0)5822 * @since 1.1.0 5821 5823 * 5822 5824 * @param string $value Group invite item ID. … … 5834 5836 * Filters the group invite user avatar. 5835 5837 * 5836 * @since BuddyPress (1.1.0)5838 * @since 1.1.0 5837 5839 * 5838 5840 * @param string $value Group invite user avatar. … … 5850 5852 * Filters the group invite user link. 5851 5853 * 5852 * @since BuddyPress (1.1.0)5854 * @since 1.1.0 5853 5855 * 5854 5856 * @param string $value Group invite user link. … … 5866 5868 * Filters the group invite user's last active time. 5867 5869 * 5868 * @since BuddyPress (1.1.0)5870 * @since 1.1.0 5869 5871 * 5870 5872 * @param string $value Group invite user's last active time. … … 5893 5895 * Output pagination links for group invitations. 5894 5896 * 5895 * @since BuddyPress (2.0.0)5897 * @since 2.0.0 5896 5898 */ 5897 5899 function bp_group_invite_pagination_links() { … … 5901 5903 * Get pagination links for group invitations. 5902 5904 * 5903 * @since BuddyPress (2.0.0)5905 * @since 2.0.0 5904 5906 * 5905 5907 * @return string … … 5911 5913 * Filters the pagination links for group invitations. 5912 5914 * 5913 * @since BuddyPress (2.0.0)5915 * @since 2.0.0 5914 5916 * 5915 5917 * @param string $value Pagination links for group invitations. … … 5921 5923 * Output pagination count text for group invitations. 5922 5924 * 5923 * @since BuddyPress (2.0.0)5925 * @since 2.0.0 5924 5926 */ 5925 5927 function bp_group_invite_pagination_count() { … … 5929 5931 * Get pagination count text for group invitations. 5930 5932 * 5931 * @since BuddyPress (2.0.0)5933 * @since 2.0.0 5932 5934 * 5933 5935 * @return string … … 5956 5958 * Hook group activity feed to <head>. 5957 5959 * 5958 * @since BuddyPress (1.5.0)5960 * @since 1.5.0 5959 5961 */ 5960 5962 function bp_groups_activity_feed() { … … 5974 5976 * Output the current group activity-stream RSS URL. 5975 5977 * 5976 * @since BuddyPress (1.5.0)5978 * @since 1.5.0 5977 5979 */ 5978 5980 function bp_group_activity_feed_link() { … … 5982 5984 * Return the current group activity-stream RSS URL. 5983 5985 * 5984 * @since BuddyPress (1.5.0)5986 * @since 1.5.0 5985 5987 * @return string 5986 5988 */ … … 5993 5995 * Filters the current group activity-stream RSS URL. 5994 5996 * 5995 * @since BuddyPress (1.2.0)5997 * @since 1.2.0 5996 5998 * 5997 5999 * @param string $feed_link Current group activity-stream RSS URL. … … 6005 6007 * Echoes the output of bp_get_current_group_id(). 6006 6008 * 6007 * @since BuddyPress (1.5.0)6009 * @since 1.5.0 6008 6010 */ 6009 6011 function bp_current_group_id() { … … 6013 6015 * Returns the ID of the current group. 6014 6016 * 6015 * @since BuddyPress (1.5.0)6017 * @since 1.5.0 6016 6018 * @uses apply_filters() Filter bp_get_current_group_id to modify this output. 6017 6019 * … … 6025 6027 * Filters the ID of the current group. 6026 6028 * 6027 * @since BuddyPress (1.5.0)6029 * @since 1.5.0 6028 6030 * 6029 6031 * @param int $current_group_id ID of the current group. … … 6036 6038 * Echoes the output of bp_get_current_group_slug(). 6037 6039 * 6038 * @since BuddyPress (1.5.0)6040 * @since 1.5.0 6039 6041 */ 6040 6042 function bp_current_group_slug() { … … 6044 6046 * Returns the slug of the current group. 6045 6047 * 6046 * @since BuddyPress (1.5.0)6048 * @since 1.5.0 6047 6049 * @uses apply_filters() Filter bp_get_current_group_slug to modify this output. 6048 6050 * … … 6056 6058 * Filters the slug of the current group. 6057 6059 * 6058 * @since BuddyPress (1.5.0)6060 * @since 1.5.0 6059 6061 * 6060 6062 * @param string $current_group_slug Slug of the current group. … … 6067 6069 * Echoes the output of bp_get_current_group_name(). 6068 6070 * 6069 * @since BuddyPress (1.5.0)6071 * @since 1.5.0 6070 6072 */ 6071 6073 function bp_current_group_name() { … … 6075 6077 * Returns the name of the current group. 6076 6078 * 6077 * @since BuddyPress (1.5.0)6079 * @since 1.5.0 6078 6080 * @uses apply_filters() Filter bp_get_current_group_name to modify this output. 6079 6081 * … … 6090 6092 * Filters the name of the current group. 6091 6093 * 6092 * @since BuddyPress (1.2.0)6094 * @since 1.2.0 6093 6095 * 6094 6096 * @param string $name Name of the current group. … … 6101 6103 * Echoes the output of bp_get_current_group_description(). 6102 6104 * 6103 * @since BuddyPress (2.1.0)6105 * @since 2.1.0 6104 6106 */ 6105 6107 function bp_current_group_description() { … … 6109 6111 * Returns the description of the current group. 6110 6112 * 6111 * @since BuddyPress (2.1.0)6113 * @since 2.1.0 6112 6114 * @uses apply_filters() Filter bp_get_current_group_description to modify 6113 6115 * this output. … … 6124 6126 * This filter is used to apply extra filters related to formatting. 6125 6127 * 6126 * @since BuddyPress (1.0.0)6128 * @since 1.0.0 6127 6129 * 6128 6130 * @param string $current_group_desc Description of the current group. … … 6133 6135 * Filters the description of the current group. 6134 6136 * 6135 * @since BuddyPress (2.1.0)6137 * @since 2.1.0 6136 6138 * 6137 6139 * @param string $desc Description of the current group. … … 6143 6145 * Output a URL for a group component action. 6144 6146 * 6145 * @since BuddyPress (1.2.0)6147 * @since 1.2.0 6146 6148 * 6147 6149 * @param string $action … … 6157 6159 * Get a URL for a group component action. 6158 6160 * 6159 * @since BuddyPress (1.2.0)6161 * @since 1.2.0 6160 6162 * 6161 6163 * @param string $action … … 6199 6201 * Filters a URL for a group component action. 6200 6202 * 6201 * @since BuddyPress (2.1.0)6203 * @since 2.1.0 6202 6204 * 6203 6205 * @param string $url URL for a group component action. … … 6214 6216 * Display the number of groups in user's profile. 6215 6217 * 6216 * @since BuddyPress (2.0.0)6218 * @since 2.0.0 6217 6219 * 6218 6220 * @param array|string $args before|after|user_id … … 6228 6230 * Return the number of groups in user's profile. 6229 6231 * 6230 * @since BuddyPress (2.0.0)6232 * @since 2.0.0 6231 6233 * 6232 6234 * @param array|string $args before|after|user_id … … 6263 6265 * Filters the number of groups in user's profile. 6264 6266 * 6265 * @since BuddyPress (2.0.0)6267 * @since 2.0.0 6266 6268 * 6267 6269 * @param string $value HTML for stats output. -
trunk/src/bp-groups/bp-groups-widgets.php
r10117 r10148 1 1 <?php 2 3 2 /** 4 3 * BuddyPress Groups Widgets … … 8 7 */ 9 8 10 // Exit if accessed directly 9 // Exit if accessed directly. 11 10 defined( 'ABSPATH' ) || exit; 12 11 … … 47 46 * Filters the user ID to use with the widget instance. 48 47 * 49 * @since BuddyPress (1.5.0)48 * @since 1.5.0 50 49 * 51 50 * @param string $value Empty user ID. … … 64 63 * Filters the title of the Groups widget. 65 64 * 66 * @since BuddyPress (1.8.0)67 * @since BuddyPress (2.3.0)Added 'instance' and 'id_base' to arguments passed to filter.65 * @since 1.8.0 66 * @since 2.3.0 Added 'instance' and 'id_base' to arguments passed to filter. 68 67 * 69 68 * @param string $title The widget title. … … 76 75 * Filters the separator of the group widget links. 77 76 * 78 * @since BuddyPress (2.4.0)77 * @since 2.4.0 79 78 * 80 79 * @param string $separator Separator string. Default '|'. -
trunk/src/bp-groups/classes/class-bp-group-extension.php
r10021 r10148 7 7 */ 8 8 9 // Exit if accessed directly 9 // Exit if accessed directly. 10 10 defined( 'ABSPATH' ) || exit; 11 11 … … 86 86 * @package BuddyPress 87 87 * @subpackage Groups 88 * @since BuddyPress (1.1.0)88 * @since 1.1.0 89 89 */ 90 90 class BP_Group_Extension { … … 95 95 * Information about this extension's screens. 96 96 * 97 * @since BuddyPress (1.8.0)97 * @since 1.8.0 98 98 * @access public 99 99 * @var array … … 104 104 * The name of the extending class. 105 105 * 106 * @since BuddyPress (1.8.0)106 * @since 1.8.0 107 107 * @access public 108 108 * @var string … … 113 113 * A ReflectionClass object of the current extension. 114 114 * 115 * @since BuddyPress (1.8.0)115 * @since 1.8.0 116 116 * @access public 117 117 * @var ReflectionClass … … 122 122 * Parsed configuration parameters for the extension. 123 123 * 124 * @since BuddyPress (1.8.0)124 * @since 1.8.0 125 125 * @access public 126 126 * @var array … … 131 131 * Raw config params, as passed by the extending class. 132 132 * 133 * @since BuddyPress (2.1.0)133 * @since 2.1.0 134 134 * @access public 135 135 * @var array … … 140 140 * The ID of the current group. 141 141 * 142 * @since BuddyPress (1.8.0)142 * @since 1.8.0 143 143 * @access public 144 144 * @var int … … 189 189 * Whether the current user should see the navigation item. 190 190 * 191 * @since BuddyPress (2.1.0)191 * @since 2.1.0 192 192 * @access public 193 193 * @var bool … … 198 198 * Whether the current user can visit the tab. 199 199 * 200 * @since BuddyPress (2.1.0)200 * @since 2.1.0 201 201 * @access public 202 202 * @var bool … … 237 237 * Has the extension been initialized? 238 238 * 239 * @since BuddyPress (1.8.0)239 * @since 1.8.0 240 240 * @access protected 241 241 * @var bool … … 246 246 * Extension properties as set by legacy extensions. 247 247 * 248 * @since BuddyPress (1.8.0)248 * @since 1.8.0 249 249 * @access protected 250 250 * @var array … … 258 258 * then converted to match the new format for params. 259 259 * 260 * @since BuddyPress (1.8.0)260 * @since 1.8.0 261 261 * @access protected 262 262 * @var array … … 267 267 * Redirect location as defined by post-edit save callback. 268 268 * 269 * @since BuddyPress (2.1.0)269 * @since 2.1.0 270 270 * @access protected 271 271 * @var string … … 276 276 * Miscellaneous data as set by the __set() magic method. 277 277 * 278 * @since BuddyPress (1.8.0)278 * @since 1.8.0 279 279 * @access protected 280 280 * @var array … … 334 334 * } 335 335 * 336 * @since BuddyPress (1.8.0)337 * @since BuddyPress (2.1.0)Added 'access' and 'show_tab' arguments to `$args`.336 * @since 1.8.0 337 * @since 2.1.0 Added 'access' and 'show_tab' arguments to `$args`. 338 338 * 339 339 * @param array $args { … … 416 416 * bp_register_group_extension(). 417 417 * 418 * @since BuddyPress (1.1.0)418 * @since 1.1.0 419 419 */ 420 420 public function _register() { … … 463 463 * whether your extension overrides certain callback methods. 464 464 * 465 * @since BuddyPress (1.8.0)465 * @since 1.8.0 466 466 */ 467 467 protected function setup_class_info() { … … 483 483 * - group admin 484 484 * 485 * @since BuddyPress (1.8.0)485 * @since 1.8.0 486 486 * 487 487 * @return int … … 516 516 * Gather configuration data about your screens. 517 517 * 518 * @since BuddyPress (1.8.0)518 * @since 1.8.0 519 519 * 520 520 * @return array … … 551 551 * Set up screens array based on params. 552 552 * 553 * @since BuddyPress (1.8.0)553 * @since 1.8.0 554 554 */ 555 555 protected function setup_screens() { … … 570 570 * Set up access-related settings for this extension. 571 571 * 572 * @since BuddyPress (2.1.0)572 * @since 2.1.0 573 573 */ 574 574 protected function setup_access_settings() { … … 714 714 * Hook this extension's group tab into BuddyPress, if necessary. 715 715 * 716 * @since BuddyPress (1.8.0)716 * @since 1.8.0 717 717 */ 718 718 protected function setup_display_hooks() { … … 784 784 * Filters the template to load for the main display method. 785 785 * 786 * @since BuddyPress (1.0.0)786 * @since 1.0.0 787 787 * 788 788 * @param string $template_file Path to the template to load. … … 797 797 * display() callback. 798 798 * 799 * @since BuddyPress (2.1.1)799 * @since 2.1.1 800 800 */ 801 801 public function call_display() { … … 809 809 * Access to the tab is controlled by the user_can_visit() check. 810 810 * 811 * @since BuddyPress (2.1.0)811 * @since 2.1.0 812 812 * 813 813 * @param bool $user_can_see_nav_item … … 826 826 * Determine whether the current user has access to visit this tab. 827 827 * 828 * @since BuddyPress (2.1.0)828 * @since 2.1.0 829 829 * 830 830 * @param bool $user_can_visit … … 847 847 * modified before the redirect takes place. 848 848 * 849 * @since BuddyPress (2.1.0)849 * @since 2.1.0 850 850 * 851 851 * @param bool $user_can_visit … … 876 876 * Hook this extension's Create step into BuddyPress, if necessary. 877 877 * 878 * @since BuddyPress (1.8.0)878 * @since 1.8.0 879 879 */ 880 880 protected function setup_create_hooks() { … … 904 904 * Call the create_screen() method, if we're on the right page. 905 905 * 906 * @since BuddyPress (1.8.0)906 * @since 1.8.0 907 907 */ 908 908 public function maybe_create_screen() { … … 922 922 * Call the create_screen_save() method, if we're on the right page. 923 923 * 924 * @since BuddyPress (1.8.0)924 * @since 1.8.0 925 925 */ 926 926 public function maybe_create_screen_save() { … … 938 938 * Hook this extension's Edit panel into BuddyPress, if necessary. 939 939 * 940 * @since BuddyPress (1.8.0)940 * @since 1.8.0 941 941 */ 942 942 protected function setup_edit_hooks() { … … 1012 1012 * do not auto-add our own button. 1013 1013 * 1014 * @since BuddyPress (1.8.0)1014 * @since 1.8.0 1015 1015 */ 1016 1016 public function call_edit_screen() { … … 1028 1028 * Check the nonce, and call the edit_screen_save() method. 1029 1029 * 1030 * @since BuddyPress (1.8.0)1030 * @since 1.8.0 1031 1031 */ 1032 1032 public function call_edit_screen_save() { … … 1061 1061 * Only runs if a redirect has not already occurred. 1062 1062 * 1063 * @since BuddyPress (2.1.0)1063 * @since 2.1.0 1064 1064 * 1065 1065 * @param string $value URL to redirect to. … … 1081 1081 * Hooked to 'bp_screens'. 1082 1082 * 1083 * @since BuddyPress (1.8.0)1083 * @since 1.8.0 1084 1084 * @access public So that do_action() has access. Do not call directly. 1085 1085 * … … 1100 1100 * if one is not found. 1101 1101 * 1102 * @since BuddyPress (1.8.0)1102 * @since 1.8.0 1103 1103 * 1104 1104 * @param string $screen The screen markup, captured in the output … … 1123 1123 * Does the given markup have a submit button? 1124 1124 * 1125 * @since BuddyPress (1.8.0)1125 * @since 1.8.0 1126 1126 * 1127 1127 * @param string $screen The markup to check. … … 1138 1138 * Detect redirects hardcoded into edit_screen_save() callbacks. 1139 1139 * 1140 * @since BuddyPress (2.1.0)1140 * @since 2.1.0 1141 1141 * 1142 1142 * @param string $redirect … … 1157 1157 * Hook this extension's Admin metabox into BuddyPress, if necessary. 1158 1158 * 1159 * @since BuddyPress (1.8.0)1159 * @since 1.8.0 1160 1160 */ 1161 1161 protected function setup_admin_hooks() { … … 1177 1177 * Call the admin_screen() method, and add a nonce field. 1178 1178 * 1179 * @since BuddyPress (1.8.0)1179 * @since 1.8.0 1180 1180 */ 1181 1181 public function call_admin_screen() { … … 1187 1187 * Check the nonce, and call the admin_screen_save() method. 1188 1188 * 1189 * @since BuddyPress (1.8.0)1189 * @since 1.8.0 1190 1190 */ 1191 1191 public function call_admin_screen_save() { … … 1197 1197 * Create the Dashboard meta box for this extension. 1198 1198 * 1199 * @since BuddyPress (1.7.0)1199 * @since 1.7.0 1200 1200 */ 1201 1201 public function _meta_box_display_callback() { … … 1225 1225 * must avoid name clashes. 1226 1226 * 1227 * @since BuddyPress (1.8.0)1227 * @since 1.8.0 1228 1228 * 1229 1229 * @param string $context Screen context. 'create', 'edit', or 'admin'. … … 1236 1236 * Check the nonce on a submitted settings form. 1237 1237 * 1238 * @since BuddyPress (1.8.0)1238 * @since 1.8.0 1239 1239 * 1240 1240 * @param string $context Screen context. 'create', 'edit', or 'admin'. … … 1251 1251 * must also exist and be callable. 1252 1252 * 1253 * @since BuddyPress (1.8.0)1253 * @since 1.8.0 1254 1254 * 1255 1255 * @param string $context Screen context. 'create', 'edit', or 'admin'. … … 1299 1299 * determine whether your extension has provided a given callback. 1300 1300 * 1301 * @since BuddyPress (1.8.0)1301 * @since 1.8.0 1302 1302 * 1303 1303 * @param string $context Screen context. 'create', 'edit', or 'admin'. … … 1350 1350 * https://core.trac.wordpress.org/ticket/19888 1351 1351 * 1352 * @since BuddyPress (1.8.0)1352 * @since 1.8.0 1353 1353 * 1354 1354 * @param array $a First set of arguments. … … 1395 1395 * self::setup_legacy_properties(). 1396 1396 * 1397 * @since BuddyPress (1.8.0)1397 * @since 1.8.0 1398 1398 * 1399 1399 * @param string $key Property name. … … 1420 1420 * $this->data array. 1421 1421 * 1422 * @since BuddyPress (1.8.0)1422 * @since 1.8.0 1423 1423 * 1424 1424 * @param string $key Property name. … … 1444 1444 * $this->enable_create_step. 1445 1445 * 1446 * @since BuddyPress (1.8.0)1446 * @since 1.8.0 1447 1447 * 1448 1448 * @param string $key Property name. … … 1509 1509 * object properties for configuration. Some have been moved. 1510 1510 * 1511 * @since BuddyPress (1.8.0)1511 * @since 1.8.0 1512 1512 * 1513 1513 * @return array List of legacy property keys. … … 1545 1545 * parse them into the new init() array. 1546 1546 * 1547 * @since BuddyPress (1.8.0)1547 * @since 1.8.0 1548 1548 */ 1549 1549 protected function parse_legacy_properties() { … … 1626 1626 * their old locations. 1627 1627 * 1628 * @since BuddyPress (1.8.0)1628 * @since 1.8.0 1629 1629 * 1630 1630 * @see BP_Group_Extension::__get() -
trunk/src/bp-groups/classes/class-bp-group-member-query.php
r9906 r10148 7 7 */ 8 8 9 // Exit if accessed directly 9 // Exit if accessed directly. 10 10 defined( 'ABSPATH' ) || exit; 11 11 … … 23 23 * inviter_id = 0 (and invite_sent = 0). 24 24 * 25 * @since BuddyPress (1.8.0)25 * @since 1.8.0 26 26 * 27 27 * @param array $args { … … 45 45 * Array of group member ids, cached to prevent redundant lookups. 46 46 * 47 * @since BuddyPress (1.8.1)47 * @since 1.8.1 48 48 * @access protected 49 49 * @var null|array Null if not yet defined, otherwise an array of ints. … … 54 54 * Set up action hooks. 55 55 * 56 * @since BuddyPress (1.8.0)56 * @since 1.8.0 57 57 */ 58 58 public function setup_hooks() { … … 77 77 * group-member logic. 78 78 * 79 * @since BuddyPress (1.8.0)79 * @since 1.8.0 80 80 * 81 81 * @param array $include Existing group IDs in the $include parameter, … … 116 116 * Get the members of the queried group. 117 117 * 118 * @since BuddyPress (1.8.0)118 * @since 1.8.0 119 119 * 120 120 * @return array $ids User IDs of relevant group member ids. … … 239 239 * defined a custom 'type'). 240 240 * 241 * @since BuddyPress (2.0.0)241 * @since 2.0.0 242 242 * 243 243 * @param array $group_member_ids Array of associated member IDs. … … 298 298 * - date_modified 299 299 * 300 * @since BuddyPress (1.8.0)300 * @since 1.8.0 301 301 * 302 302 * @param BP_User_Query $query BP_User_Query object. Because we're … … 336 336 * Sort user IDs by how recently they have generated activity within a given group. 337 337 * 338 * @since BuddyPress (2.1.0)338 * @since 2.1.0 339 339 * 340 340 * @param BP_User_Query $query BP_User_Query object. -
trunk/src/bp-groups/classes/class-bp-groups-group.php
r9982 r10148 7 7 */ 8 8 9 // Exit if accessed directly 9 // Exit if accessed directly. 10 10 defined( 'ABSPATH' ) || exit; 11 11 … … 108 108 * Is the current user a member of this group? 109 109 * 110 * @since BuddyPress (1.2.0)110 * @since 1.2.0 111 111 * @var bool 112 112 */ … … 116 116 * Does the current user have an outstanding invitation to this group? 117 117 * 118 * @since BuddyPress (1.9.0)118 * @since 1.9.0 119 119 * @var bool 120 120 */ … … 124 124 * Does the current user have a pending membership request to this group? 125 125 * 126 * @since BuddyPress (1.9.0)126 * @since 1.9.0 127 127 * @var bool 128 128 */ … … 132 132 * Timestamp of the last activity that happened in this group. 133 133 * 134 * @since BuddyPress (1.2.0)134 * @since 1.2.0 135 135 * @var string 136 136 */ … … 140 140 * If this is a private or hidden group, does the current user have access? 141 141 * 142 * @since BuddyPress (1.6.0)142 * @since 1.6.0 143 143 * @var bool 144 144 */ … … 148 148 * Raw arguments passed to the constructor. 149 149 * 150 * @since BuddyPress (2.0.0)150 * @since 2.0.0 151 151 * @var array 152 152 */ … … 217 217 * Filters the SQL prepared statement used to fetch group admins and mods. 218 218 * 219 * @since BuddyPress (1.5.0)219 * @since 1.5.0 220 220 * 221 221 * @param string $value SQL select statement used to fetch admins and mods. … … 282 282 * Please use this hook to filter the properties above. Each part will be passed in. 283 283 * 284 * @since BuddyPress (1.0.0)284 * @since 1.0.0 285 285 * 286 286 * @param BP_Groups_Group $this Current instance of the group item being saved. Passed by reference. … … 362 362 * Fires after the current group item has been saved. 363 363 * 364 * @since BuddyPress (1.0.0)364 * @since 1.0.0 365 365 * 366 366 * @param BP_Groups_Group $this Current instance of the group item that was saved. Passed by reference. … … 397 397 * Fires before the deletion of a group. 398 398 * 399 * @since BuddyPress (1.2.0)399 * @since 1.2.0 400 400 * 401 401 * @param BP_Groups_Group $this Current instance of the group item being deleted. Passed by reference.