Contents

Code Reference Classes BP_REST_Group_Settings_Endpoint BP_REST_Group_Settings_Endpoint::update_settings_fields()

BP_REST_Group_Settings_Endpoint::update_settings_fields( WP_REST_Request $request )

Update Group settings.

Description

Parameters

$request

(Required) Request used to generate the response.

Return

(array)

Source

File: bp-groups/classes/class-bp-rest-group-settings-endpoint.php

921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
protected function update_settings_fields( $request ) {
    $post_fields                        = $request->get_param( 'fields' );
    $group_id                           = $request->get_param( 'id' );
    $group                              = groups_get_group( $group_id );
    buddypress()->groups->current_group = $group;
 
    if ( empty( $post_fields ) ) {
        return array(
            'error'  => '',
            'notice' => '',
        );
    }
 
    // Checked against a whitelist for security.
    /** This filter is documented in bp-groups/bp-groups-admin.php */
    $allowed_status = apply_filters( 'groups_allowed_status', array( 'public', 'private', 'hidden' ) );
    $status         = ( array_key_exists( 'group-status', (array) $post_fields ) && ! empty( $post_fields['group-status'] ) ) ? $post_fields['group-status'] : ( ! bp_get_new_group_status() ? 'public' : bp_get_new_group_status() );
 
    // Checked against a whitelist for security.
    /** This filter is documented in bp-groups/bp-groups-admin.php */
    $allowed_invite_status = apply_filters( 'groups_allowed_invite_status', array( 'members', 'mods', 'admins' ) );
    $invite_status         = ( array_key_exists( 'group-invite-status', (array) $post_fields ) && ! empty( $post_fields['group-invite-status'] ) ) ? $post_fields['group-invite-status'] : bp_group_get_invite_status( $group->id );
 
    // Checked against a whitelist for security.
    /** This filter is documented in bp-groups/bp-groups-admin.php */
    $allowed_activity_feed_status = apply_filters( 'groups_allowed_activity_feed_status', array( 'members', 'mods', 'admins' ) );
    $activity_feed_status         = ( array_key_exists( 'group-activity-feed-status', (array) $post_fields ) && ! empty( $post_fields['group-activity-feed-status'] ) ) ? $post_fields['group-activity-feed-status'] : bp_group_get_activity_feed_status( $group->id );
 
    // Checked against a whitelist for security.
    /** This filter is documented in bp-groups/bp-groups-admin.php */
    $allowed_media_status = apply_filters( 'groups_allowed_media_status', array( 'members', 'mods', 'admins' ) );
    $media_status         = ( array_key_exists( 'group-media-status', (array) $post_fields ) && ! empty( $post_fields['group-media-status'] ) ) ? $post_fields['group-media-status'] : bp_group_get_media_status( $group->id );
 
    // Checked against a whitelist for security.
    /** This filter is documented in bp-groups/bp-groups-admin.php */
    $allowed_album_status = apply_filters( 'groups_allowed_album_status', array( 'members', 'mods', 'admins' ) );
    $album_status         = ( array_key_exists( 'group-album-status', (array) $post_fields ) && ! empty( $post_fields['group-album-status'] ) ) ? $post_fields['group-album-status'] : bp_group_get_album_status( $group->id );
 
    // Checked against a whitelist for security.
    /** This filter is documented in bp-groups/bp-groups-admin.php */
    $allowed_message_status = apply_filters( 'groups_allowed_message_status', array( 'mods', 'admins', 'members' ) );
    $message_status         = ( array_key_exists( 'group-message-status', (array) $post_fields ) && ! empty( $post_fields['group-message-status'] ) ) ? $post_fields['group-message-status'] : bp_group_get_message_status( $group->id );
 
    /*
     * Save group types.
     *
     * Ensure we keep types that have 'show_in_create_screen' set to false.
     */
    $current_types = bp_groups_get_group_type( $group_id, false );
    $current_types = array_intersect( bp_groups_get_group_types( array( 'show_in_create_screen' => false ) ), (array) $current_types );
    if ( isset( $post_fields['group-types'] ) ) {
        $current_types = array_merge( $current_types, (array) $post_fields['group-types'] );
 
        // Set group types.
        bp_groups_set_group_type( $group_id, $current_types );
 
        // No group types checked, so this means we want to wipe out all group types.
    } else {
        /*
         * Passing a blank string will wipe out all types for the group.
         *
         * Ensure we keep types that have 'show_in_create_screen' set to false.
         */
        $current_types = empty( $current_types ) ? '' : $current_types;
 
        // Set group types.
        bp_groups_set_group_type( $group_id, $current_types );
    }
 
    $parent_id    = isset( $post_fields['bp-groups-parent'] ) && array_key_exists( 'bp-groups-parent', (array) $post_fields ) ? $post_fields['bp-groups-parent'] : '0';
    $enable_forum = ( isset( $group->enable_forum ) ? $group->enable_forum : false );
 
    $error  = '';
    $notice = '';
 
    if ( ! groups_edit_group_settings( $group_id, $enable_forum, $status, $invite_status, $activity_feed_status, $parent_id, $media_status, $album_status, $message_status ) ) {
        $error = __( 'There was an error updating group settings. Please try again.', 'buddyboss' );
    } else {
        $notice = __( 'Group settings were successfully updated.', 'buddyboss' );
    }
 
    return array(
        'error'  => $error,
        'notice' => $notice,
    );
 
}

Expand full source code Collapse full source code

Uses

Uses
Uses Description
bp-groups/bp-groups-template.php: bp_group_get_message_status()

Get the message status of a group.
bp-groups/bp-groups-template.php: bp_group_get_document_status()

Get the media status of a group.
bp-groups/bp-groups-admin.php: groups_allowed_document_status

Filters the allowed media status values for the group.
bp-loader.php: buddypress()

The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
bp-groups/bp-groups-admin.php: groups_allowed_status

Filters the allowed status values for the group.
bp-groups/bp-groups-admin.php: groups_allowed_invite_status

Filters the allowed invite status values for the group.
bp-groups/bp-groups-admin.php: groups_allowed_activity_feed_status

Filters the allowed activity feed status values for the group.
bp-groups/bp-groups-admin.php: groups_allowed_media_status

Filters the allowed media status values for the group.
bp-groups/bp-groups-admin.php: groups_allowed_album_status

Filters the allowed album status values for the group.
bp-groups/bp-groups-functions.php: bp_groups_get_group_type()

Get type for a group.
bp-groups/bp-groups-functions.php: bp_groups_get_group_types()

Get a list of all registered group type objects.
bp-groups/bp-groups-functions.php: bp_groups_set_group_type()

Set type for a group.
bp-groups/bp-groups-functions.php: groups_edit_group_settings()

Edit the base details for a group.
bp-groups/bp-groups-functions.php: groups_get_group()

Fetch a single group object.
bp-groups/bp-groups-template.php: bp_get_new_group_status()

Get the newly created group privacy.
bp-groups/bp-groups-template.php: bp_group_get_media_status()

Get the media status of a group.
bp-groups/bp-groups-template.php: bp_group_get_invite_status()

Get the invite status of a group.
bp-groups/bp-groups-template.php: bp_group_get_activity_feed_status()

Get the activity feed status of a group.
bp-groups/bp-groups-template.php: bp_group_get_album_status()

Get the album status of a group.
Show 14 more uses Hide more uses

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.