[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-groups/ -> bp-groups-admin.php (summary)

BuddyPress Groups component admin screen. Props to WordPress core for the Comments admin screen, and its contextual help text, on which this implementation is heavily based.

File Size: 1489 lines (54 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 23 functions

  bp_groups_add_admin_menu()
  bp_group_site_admin_network_admin_redirect()
  bp_groups_admin_types_menu()
  bp_groups_admin_menu_order()
  bp_groups_admin_load()
  bp_groups_admin_screen_options()
  bp_groups_admin()
  bp_groups_admin_edit()
  bp_groups_admin_delete()
  bp_groups_admin_index()
  bp_groups_admin_edit_metabox_settings()
  bp_groups_admin_edit_metabox_add_new_members()
  bp_groups_admin_edit_metabox_members()
  bp_groups_admin_edit_metabox_status()
  bp_groups_admin_edit_metabox_group_type()
  bp_groups_process_group_type_update()
  bp_groups_admin_create_pagination_links()
  bp_groups_admin_get_usernames_from_ids()
  bp_groups_admin_autocomplete_handler()
  bp_groups_admin_process_group_type_bulk_changes()
  bp_groups_admin_groups_type_change_notice()
  bp_groups_type_admin_type_exists()
  bp_groups_type_admin_updated_messages()

Functions
Functions that are not part of a class:

bp_groups_add_admin_menu()   X-Ref
Register the Groups component admin screen.

since: 1.7.0

bp_group_site_admin_network_admin_redirect()   X-Ref
Redirects the user on the Goups network admin screen when BuddyPress is network activated.

since: 7.0.0

bp_groups_admin_types_menu()   X-Ref
Create Groups submenu to manage BuddyPress types.

since: 7.0.0

bp_groups_admin_menu_order( $custom_menus = array()   X-Ref
Add groups component to custom menus array.

This ensures that the Groups menu item appears in the proper order on the
main Dashboard menu.

param: array $custom_menus Array of BP top-level menu items.
since: 1.7.0
return: array Menu item array, with Groups added.

bp_groups_admin_load()   X-Ref
Set up the Groups admin page.

Loaded before the page is rendered, this function does all initial setup,
including: processing form requests, registering contextual help, and
setting up screen options.

since: 1.7.0

bp_groups_admin_screen_options( $value, $option, $new_value )   X-Ref
Handle save/update of screen options for the Groups component admin screen.

param: string $value     Will always be false unless another plugin filters it first.
param: string $option    Screen option name.
param: string $new_value Screen option form value.
since: 1.7.0
return: string|int Option value. False to abandon update.

bp_groups_admin()   X-Ref
Select the appropriate Groups admin screen, and output it.

since: 1.7.0

bp_groups_admin_edit()   X-Ref
Display the single groups edit screen.

since: 1.7.0

bp_groups_admin_delete()   X-Ref
Display the Group delete confirmation screen.

We include a separate confirmation because group deletion is truly
irreversible.

since: 1.7.0

bp_groups_admin_index()   X-Ref
Display the Groups admin index screen.

This screen contains a list of all BuddyPress groups.

since: 1.7.0

bp_groups_admin_edit_metabox_settings( $item )   X-Ref
Markup for the single group's Settings metabox.

param: object $item Information about the current group.
since: 1.7.0

bp_groups_admin_edit_metabox_add_new_members( $item )   X-Ref
Output the markup for a single group's Add New Members metabox.

param: BP_Groups_Group $item The BP_Groups_Group object for the current group.
since: 1.7.0

bp_groups_admin_edit_metabox_members( $item )   X-Ref
Renders the Members metabox on single group pages.

param: BP_Groups_Group $item The BP_Groups_Group object for the current group.
since: 1.7.0

bp_groups_admin_edit_metabox_status( $item )   X-Ref
Renders the Status metabox for the Groups admin edit screen.

param: object $item Information about the currently displayed group.
since: 1.7.0

bp_groups_admin_edit_metabox_group_type( BP_Groups_Group $group = null )   X-Ref
Render the Group Type metabox.

param: BP_Groups_Group|null $group The BP_Groups_Group object corresponding to the group being edited.
since: 2.6.0

bp_groups_process_group_type_update( $group_id )   X-Ref
Process changes from the Group Type metabox.

param: int $group_id Group ID.
since: 2.6.0

bp_groups_admin_create_pagination_links( BP_Group_Member_Query $query, $member_type )   X-Ref
Create pagination links out of a BP_Group_Member_Query.

This function is intended to create pagination links for use under the
Manage Members section of the Groups Admin Dashboard pages. It is a stopgap
measure until a more general pagination solution is in place for BuddyPress.
Plugin authors should not use this function, as it is likely to be
deprecated soon.

param: BP_Group_Member_Query $query       A BP_Group_Member_Query object.
param: string                $member_type member|mod|admin|banned.
since: 1.8.0
return: string Pagination links HTML.

bp_groups_admin_get_usernames_from_ids( $user_ids = array()   X-Ref
Get a set of usernames corresponding to a set of user IDs.

param: array $user_ids Array of user IDs.
since: 1.7.0
return: array Array of user_logins corresponding to $user_ids.

bp_groups_admin_autocomplete_handler()   X-Ref
AJAX handler for group member autocomplete requests.

since: 1.7.0

bp_groups_admin_process_group_type_bulk_changes( $doaction )   X-Ref
Process input from the Group Type bulk change select.

param: string $doaction Current $_GET action being performed in admin screen.
since: 2.7.0

bp_groups_admin_groups_type_change_notice()   X-Ref
Display an admin notice upon group type bulk update.

since: 2.7.0

bp_groups_type_admin_type_exists( $exists = false, $type_id = '' )   X-Ref
Checks whether a group type already exists.

param: boolean $exists  True if the group type already exists. False otherwise.
param: string  $type_id The group type identifier.
since: 7.0.0
return: boolean          True if the group type already exists. False otherwise.

bp_groups_type_admin_updated_messages( $messages = array()   X-Ref
Set the feedback messages for the Group Types Admin actions.

param: array  $messages The feedback messages.
since: 7.0.0
return: array           The feedback messages including the ones for the Group Types Admin actions.



Generated: Mon Sep 28 01:01:32 2020 Cross-referenced by PHPXref 0.7.1