bp_groups_admin_load()
Set up the Groups admin page.
Description
Loaded before the page is rendered, this function does all initial setup, including: processing form requests, registering contextual help, and setting up screen options.
Source
File: bp-groups/bp-groups-admin.php
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 | function bp_groups_admin_load() { global $bp_groups_list_table; // Build redirection URL. $redirect_to = remove_query_arg( array( 'action', 'action2', 'gid', 'deleted', 'error', 'updated', 'success_new', 'error_new', 'success_modified', 'error_modified' ), $_SERVER['REQUEST_URI'] ); $doaction = bp_admin_list_table_current_bulk_action(); $min = bp_core_get_minified_asset_suffix(); /** * Fires at top of groups admin page. * * @since BuddyPress 1.7.0 * * @param string $doaction Current $_GET action being performed in admin screen. */ do_action( 'bp_groups_admin_load', $doaction ); // Edit screen. if ( 'do_delete' == $doaction && ! empty( $_GET['gid'] ) ) { check_admin_referer( 'bp-groups-delete' ); $group_ids = wp_parse_id_list( $_GET['gid'] ); $gf_ids = wp_parse_id_list( $_GET['gfid'] ); // Delete groups forums if ( ! empty( $gf_ids ) ) { foreach ( $gf_ids as $gf_id ) { $forum_ids = bbp_get_group_forum_ids( $gf_id ); foreach ( $forum_ids as $forum_id ) { wp_delete_post( $forum_id, true ); } } } $count = 0; foreach ( $group_ids as $group_id ) { if ( groups_delete_group( $group_id ) ) { $count++; } } $redirect_to = add_query_arg( 'deleted', $count, $redirect_to ); bp_core_redirect( $redirect_to ); } elseif ( 'edit' == $doaction && ! empty( $_GET['gid'] ) ) { // Columns screen option. add_screen_option( 'layout_columns', array( 'default' => 2, 'max' => 2, ) ); get_current_screen()->add_help_tab( array( 'id' => 'bp-group-edit-overview', 'title' => __( 'Overview', 'buddyboss' ), 'content' => '<p>' . __( 'This page is a convenient way to edit the details associated with one of your groups.', 'buddyboss' ) . '</p>' . '<p>' . __( 'The Name and Description box is fixed in place, but you can reposition all the other boxes using drag and drop, and can minimize or expand them by clicking the title bar of each box. Use the Screen Options tab to hide or unhide, or to choose a 1- or 2-column layout for this screen.', 'buddyboss' ) . '</p>' ) ); // Help panel - sidebar links. get_current_screen()->set_help_sidebar( '<p><strong>' . __( 'For more information:', 'buddyboss' ) . '</strong></p>' . '<p>' . __( '<a href="https://www.buddyboss.com/resources/">Documentation</a>', 'buddyboss' ) . '</p>' ); // Register metaboxes for the edit screen. add_meta_box( 'submitdiv', __( 'Save', 'buddyboss' ), 'bp_groups_admin_edit_metabox_status', get_current_screen()->id, 'side', 'high' ); add_meta_box( 'bp_group_settings', __( 'Settings', 'buddyboss' ), 'bp_groups_admin_edit_metabox_settings', get_current_screen()->id, 'side', 'core' ); add_meta_box( 'bp_group_add_members', __( 'Add New Members', 'buddyboss' ), 'bp_groups_admin_edit_metabox_add_new_members', get_current_screen()->id, 'normal', 'core' ); add_meta_box( 'bp_group_members', __( 'Manage Members', 'buddyboss' ), 'bp_groups_admin_edit_metabox_members', get_current_screen()->id, 'normal', 'core' ); // Group Type metabox. Only added if group types have been registered. $group_types = bp_groups_get_group_types(); if ( ! empty( $group_types ) ) { add_meta_box( 'bp_groups_admin_group_type', __( 'Group Type', 'buddyboss' ), 'bp_groups_admin_edit_metabox_group_type', get_current_screen()->id, 'side', 'core' ); } if ( bp_enable_group_hierarchies() ) { add_meta_box( 'bp_groups_admin_group_parent', __( 'Group Parent', 'buddyboss' ), 'bp_groups_admin_edit_metabox_group_parent', get_current_screen()->id, 'side', 'core' ); } /** * Fires after the registration of all of the default group meta boxes. * * @since BuddyPress 1.7.0 */ do_action( 'bp_groups_admin_meta_boxes' ); // Enqueue JavaScript files. wp_enqueue_script( 'postbox' ); wp_enqueue_script( 'dashboard' ); // Index screen. } else { // Create the Groups screen list table. $bp_groups_list_table = new BP_Groups_List_Table(); // The per_page screen option. add_screen_option( 'per_page', array( 'label' => __( 'Groups', 'buddyboss' )) ); // Help panel - overview text. get_current_screen()->add_help_tab( array( 'id' => 'bp-groups-overview', 'title' => __( 'Overview', 'buddyboss' ), 'content' => '<p>' . __( 'You can manage groups much like you can manage comments and other content. This screen is customizable in the same ways as other management screens, and you can act on groups by using the on-hover action links or the Bulk Actions.', 'buddyboss' ) . '</p>', ) ); get_current_screen()->add_help_tab( array( 'id' => 'bp-groups-overview-actions', 'title' => __( 'Group Actions', 'buddyboss' ), 'content' => '<p>' . __( 'Clicking "Visit" will take you to the group\'s public page. Use this link to see what the group looks like on the front end of your site.', 'buddyboss' ) . '</p>' . '<p>' . __( 'Clicking "Edit" will take you to a Dashboard panel where you can manage various details about the group, such as its name and description, its members, and other settings.', 'buddyboss' ) . '</p>' . '<p>' . __( 'If you click "Delete" under a specific group, or select a number of groups and then choose Delete from the Bulk Actions menu, you will be led to a page where you\'ll be asked to confirm the permanent deletion of the group(s).', 'buddyboss' ) . '</p>', ) ); // Help panel - sidebar links. get_current_screen()->set_help_sidebar( '<p><strong>' . __( 'For more information:', 'buddyboss' ) . '</strong></p>' . '<p>' . __( '<a href="https://www.buddyboss.com/resources/">Documentation</a>', 'buddyboss' ) . '</p>' ); // Add accessible hidden heading and text for Groups screen pagination. get_current_screen()->set_screen_reader_content( array( /* translators: accessibility text */ 'heading_pagination' => __( 'Groups list navigation', 'buddyboss' ), ) ); } $bp = buddypress(); // Enqueue CSS and JavaScript. wp_enqueue_script( 'bp_groups_admin_js', $bp->plugin_url . "bp-groups/admin/js/admin{$min}.js", array( 'jquery', 'wp-ajax-response', 'jquery-ui-autocomplete' ), bp_get_version(), true ); wp_localize_script( 'bp_groups_admin_js', 'BP_Group_Admin', array( 'add_member_placeholder' => __( 'Start typing a username to add a new member.', 'buddyboss' ), 'warn_on_leave' => __( 'If you leave this page, you will lose any unsaved changes you have made to the group.', 'buddyboss' ), ) ); wp_enqueue_style( 'bp_groups_admin_css', $bp->plugin_url . "bp-groups/admin/css/admin{$min}.css", array(), bp_get_version() ); wp_style_add_data( 'bp_groups_admin_css', 'rtl', true ); if ( $min ) { wp_style_add_data( 'bp_groups_admin_css', 'suffix', $min ); } if ( $doaction && 'save' == $doaction ) { // Get group ID. $group_id = isset( $_REQUEST['gid'] ) ? (int) $_REQUEST['gid'] : ''; $redirect_to = add_query_arg( array( 'gid' => (int) $group_id, 'action' => 'edit' ), $redirect_to ); // Check this is a valid form submission. check_admin_referer( 'edit-group_' . $group_id ); // Get the group from the database. $group = groups_get_group( $group_id ); // If the group doesn't exist, just redirect back to the index. if ( empty( $group->slug ) ) { wp_redirect( $redirect_to ); exit; } // Check the form for the updated properties. // Store errors. $error = 0; $success_new = $error_new = $success_modified = $error_modified = array(); // Name, description and slug must not be empty. if ( empty( $_POST['bp-groups-name'] ) ) { $error = $error - 1; } if ( empty( $_POST['bp-groups-slug'] ) ) { $error = $error - 4; } /* * Group name, slug, and description are handled with * groups_edit_base_group_details(). */ if ( ! $error && ! groups_edit_base_group_details( array( 'group_id' => $group_id, 'name' => $_POST['bp-groups-name'], 'slug' => $_POST['bp-groups-slug'], 'description' => $_POST['bp-groups-description'], 'parent_id' => isset( $_POST['bp-groups-parent'] ) ? $_POST['bp-groups-parent'] : 0, 'notify_members' => false, ) ) ) { $error = $group_id; } // Enable discussion forum. $enable_forum = ( isset( $_POST['group-show-forum'] ) ) ? 1 : 0; /** * Filters the allowed status values for the group. * * @since BuddyPress 1.0.2 * * @param array $value Array of allowed group statuses. */ $allowed_status = apply_filters( 'groups_allowed_status', array( 'public', 'private', 'hidden' ) ); $status = ( in_array( $_POST['group-status'], (array) $allowed_status ) ) ? $_POST['group-status'] : 'public'; /** * Filters the allowed invite status values for the group. * * @since BuddyPress 1.5.0 * * @param array $value Array of allowed invite statuses. */ $allowed_invite_status = apply_filters( 'groups_allowed_invite_status', array( 'members', 'mods', 'admins' ) ); $invite_status = in_array( $_POST['group-invite-status'], (array) $allowed_invite_status ) ? $_POST['group-invite-status'] : 'members'; /** * Filters the allowed activity feed status values for the group. * * @since BuddyBoss 1.0.0 * * @param array $value Array of allowed activity feed statuses. */ $allowed_activity_feed_status = apply_filters( 'groups_allowed_activity_feed_status', array( 'members', 'mods', 'admins' ) ); $activity_feed_status = in_array( $_POST['group-activity-feed-status'], (array) $allowed_activity_feed_status ) ? $_POST['group-activity-feed-status'] : 'members'; /** * Filters the allowed media status values for the group. * * @since BuddyBoss 1.0.0 * * @param array $value Array of allowed media statuses. */ $allowed_media_status = apply_filters( 'groups_allowed_media_status', array( 'members', 'mods', 'admins' ) ); $media_status = in_array( $_POST['group-media-status'], (array) $allowed_media_status ) ? $_POST['group-media-status'] : 'members'; /** * Filters the allowed album status values for the group. * * @since BuddyBoss 1.0.0 * * @param array $value Array of allowed album statuses. */ $allowed_album_status = apply_filters( 'groups_allowed_album_status', array( 'members', 'mods', 'admins' ) ); $album_status = in_array( $_POST['group-album-status'], (array) $allowed_album_status ) ? $_POST['group-album-status'] : 'members'; if ( !groups_edit_group_settings( $group_id, $enable_forum, $status, $invite_status, $activity_feed_status, false, $media_status, $album_status ) ) { $error = $group_id; } // Process new members. $user_names = array(); if ( ! empty( $_POST['bp-groups-new-members'] ) ) { $user_names = array_merge( $user_names, explode( ',', $_POST['bp-groups-new-members'] ) ); } if ( ! empty( $user_names ) ) { foreach( array_values( $user_names ) as $user_name ) { $un = trim( $user_name ); // Make sure the user exists before attempting // to add to the group. $user = get_user_by( 'slug', $un ); if ( empty( $user ) ) { $error_new[] = $un; } else { if ( ! groups_join_group( $group_id, $user->ID ) ) { $error_new[] = $un; } else { $success_new[] = $un; } } } } // Process member role changes. if ( ! empty( $_POST['bp-groups-role'] ) && ! empty( $_POST['bp-groups-existing-role'] ) ) { // Before processing anything, make sure you're not // attempting to remove the all user admins. $admin_count = 0; foreach ( (array) $_POST['bp-groups-role'] as $new_role ) { if ( 'admin' == $new_role ) { $admin_count++; break; } } if ( ! $admin_count ) { $redirect_to = add_query_arg( 'no_admins', 1, $redirect_to ); $error = $group_id; } else { // Process only those users who have had their roles changed. foreach ( (array) $_POST['bp-groups-role'] as $user_id => $new_role ) { $user_id = (int) $user_id; $existing_role = isset( $_POST['bp-groups-existing-role'][$user_id] ) ? $_POST['bp-groups-existing-role'][$user_id] : ''; if ( $existing_role != $new_role ) { $result = false; switch ( $new_role ) { case 'mod' : // Admin to mod is a demotion. Demote to // member, then fall through. if ( 'admin' == $existing_role ) { groups_demote_member( $user_id, $group_id ); } case 'admin' : // If the user was banned, we must // unban first. if ( 'banned' == $existing_role ) { groups_unban_member( $user_id, $group_id ); } // At this point, each existing_role // is a member, so promote. $result = groups_promote_member( $user_id, $group_id, $new_role ); break; case 'member' : if ( 'admin' == $existing_role || 'mod' == $existing_role ) { $result = groups_demote_member( $user_id, $group_id ); } elseif ( 'banned' == $existing_role ) { $result = groups_unban_member( $user_id, $group_id ); } break; case 'banned' : $result = groups_ban_member( $user_id, $group_id ); break; case 'remove' : $result = groups_remove_member( $user_id, $group_id ); break; } // Store the success or failure. if ( $result ) { $success_modified[] = $user_id; } else { $error_modified[] = $user_id; } } } } } /** * Fires before redirect so plugins can do something first on save action. * * @since BuddyPress 1.6.0 * * @param int $group_id ID of the group being edited. */ do_action( 'bp_group_admin_edit_after', $group_id ); // Create the redirect URL. if ( $error ) { // This means there was an error updating group details. $redirect_to = add_query_arg( 'error', (int) $error, $redirect_to ); } else { // Group details were update successfully. $redirect_to = add_query_arg( 'updated', 1, $redirect_to ); } if ( !empty( $success_new ) ) { $success_new = implode( ',', array_filter( $success_new, 'urlencode' ) ); $redirect_to = add_query_arg( 'success_new', $success_new, $redirect_to ); } if ( !empty( $error_new ) ) { $error_new = implode( ',', array_filter( $error_new, 'urlencode' ) ); $redirect_to = add_query_arg( 'error_new', $error_new, $redirect_to ); } if ( !empty( $success_modified ) ) { $success_modified = implode( ',', array_filter( $success_modified, 'urlencode' ) ); $redirect_to = add_query_arg( 'success_modified', $success_modified, $redirect_to ); } if ( !empty( $error_modified ) ) { $error_modified = implode( ',', array_filter( $error_modified, 'urlencode' ) ); $redirect_to = add_query_arg( 'error_modified', $error_modified, $redirect_to ); } /** * Filters the URL to redirect to after successfully editing a group. * * @since BuddyPress 1.7.0 * * @param string $redirect_to URL to redirect user to. */ wp_redirect( apply_filters( 'bp_group_admin_edit_redirect', $redirect_to ) ); exit; // If a referrer and a nonce is supplied, but no action, redirect back. } elseif ( ! empty( $_GET['_wp_http_referer'] ) ) { wp_redirect( remove_query_arg( array( '_wp_http_referer', '_wpnonce' ), stripslashes( $_SERVER['REQUEST_URI'] ) ) ); exit; }} |
Changelog
| Version | Description |
|---|---|
| BuddyPress 1.7.0 | Introduced. |
Questions?
We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.