• Knowledge Base
    • All Articles
    • BuddyBoss Platform
    • BuddyBoss Theme
    • BuddyBoss App
    • Integrations
    • Advanced Setup
    • Troubleshooting
    • Release Notes
      • BuddyBoss Platform
      • BuddyBoss Platform Pro
      • BuddyBoss Theme
      • BuddyBoss App
      • BuddyBoss App Plugin
      • Other Products
  • Developers
    • Developer Tutorials
      • Web Development
      • App Development
    • Code Reference
      • Functions
      • Hooks
      • Classes
      • Methods
      • Commands
      • App Codex
    • REST API
      • BuddyBoss Platform
      • BuddyBoss App
    • Font Cheatsheet
    • Github Project
  • Roadmap
  • Go to BuddyBoss
    Contact Support
    Filter
    • Knowledge Base
      • All Articles
      • BuddyBoss Platform
      • BuddyBoss Theme
      • BuddyBoss App
      • Integrations
      • Advanced Setup
      • Troubleshooting
      • Release Notes
        • BuddyBoss Platform
        • BuddyBoss Platform Pro
        • BuddyBoss Theme
        • BuddyBoss App
        • BuddyBoss App Plugin
        • Other Products
    • Developers
      • Developer Tutorials
        • Web Development
        • App Development
      • Code Reference
        • Functions
        • Hooks
        • Classes
        • Methods
        • Commands
        • App Codex
      • REST API
        • BuddyBoss Platform
        • BuddyBoss App
      • Font Cheatsheet
      • Github Project
    • Roadmap
    • Go to BuddyBoss
    Filter
    Filter

    Contents

    • Description
    • Parameters
    • Return
    • Source
    • Changelog
    • Related
    Code Reference Classes BP_REST_Account_Settings_Options_Endpoint BP_REST_Account_Settings_Options_Endpoint::get_item()

    BP_REST_Account_Settings_Options_Endpoint::get_item( WP_REST_Request $request )

    Retrieve Account Settings options.

    Description

    Parameters

    $request

    (WP_REST_Request) (Required) Full details about the request.

    Return

    (WP_REST_Response) | WP_Error

    Source

    File: bp-settings/classes/class-bp-rest-account-settings-options-endpoint.php

    	public function get_item( $request ) {
    
    		$nav    = $request->get_param( 'nav' );
    		$fields = array();
    		switch ( $nav ) {
    			case 'general':
    				$fields = $this->get_general_fields();
    				break;
    
    			case 'notifications':
    				$fields = $this->get_notifications_fields();
    				break;
    
    			case 'profile':
    				$fields = $this->get_profile_fields();
    				break;
    
    			case 'invites':
    				$fields = $this->get_invites_fields();
    				break;
    
    			case 'export':
    				$fields = $this->get_export_fields();
    				break;
    
    			case 'delete-account':
    				$fields = $this->get_delete_account_fields();
    				break;
    		}
    
    		$fields = apply_filters( 'bp_rest_account_setting_fields', $fields, $nav );
    
    		if ( empty( $fields ) ) {
    			return new WP_Error(
    				'bp_rest_invalid_setting_nav',
    				__( 'Sorry, you are not allowed to see the account settings options.', 'buddyboss' ),
    				array(
    					'status' => 400,
    				)
    			);
    		}
    
    		$retval = array();
    		if ( ! empty( $fields ) ) {
    			foreach ( $fields as $field ) {
    				$retval[] = $this->prepare_response_for_collection(
    					$this->prepare_item_for_response( $field, $request )
    				);
    			}
    		}
    
    		$response = rest_ensure_response( $retval );
    
    		/**
    		 * Fires after account setting options are fetched via the REST API.
    		 *
    		 * @param array            $fields   Fetched Fields.
    		 * @param WP_REST_Response $response The response data.
    		 * @param WP_REST_Request  $request  The request sent to the API.
    		 *
    		 * @since 0.1.0
    		 */
    		do_action( 'bp_rest_account_settings_options_get_item', $fields, $response, $request );
    
    		return $response;
    	}
    

    Expand full source code Collapse full source code

    Changelog

    Changelog
    Version Description
    0.1.0 Introduced.

    Related

    Uses

    Uses
    Uses Description
    bp-settings/classes/class-bp-rest-account-settings-options-endpoint.php: BP_REST_Account_Settings_Options_Endpoint::get_general_fields()

    Get Fields for the General “Login Information”.

    bp-settings/classes/class-bp-rest-account-settings-options-endpoint.php: BP_REST_Account_Settings_Options_Endpoint::get_notifications_fields()

    Get Fields for the Notifications “Email Preferences”.

    bp-settings/classes/class-bp-rest-account-settings-options-endpoint.php: BP_REST_Account_Settings_Options_Endpoint::get_profile_fields()

    Get Fields for the Profile “Privacy”.

    bp-settings/classes/class-bp-rest-account-settings-options-endpoint.php: BP_REST_Account_Settings_Options_Endpoint::get_invites_fields()

    Get Fields for the Invites “Group Invites”.

    bp-settings/classes/class-bp-rest-account-settings-options-endpoint.php: BP_REST_Account_Settings_Options_Endpoint::get_export_fields()

    Get Fields for the Export “Export Data”.

    bp-settings/classes/class-bp-rest-account-settings-options-endpoint.php: BP_REST_Account_Settings_Options_Endpoint::get_delete_account_fields()

    Get Fields for the Delete Account “Delete Account”.

    bp-settings/classes/class-bp-rest-account-settings-options-endpoint.php: BP_REST_Account_Settings_Options_Endpoint::prepare_item_for_response()

    Prepares account settings data for return as an object.

    bp-settings/classes/class-bp-rest-account-settings-options-endpoint.php: bp_rest_account_setting_fields

    BP REST: BP_REST_Account_Settings_Options_Endpoint class

    bp-settings/classes/class-bp-rest-account-settings-options-endpoint.php: bp_rest_account_settings_options_get_item

    Fires after account setting options are fetched via the REST API.

    Show 4 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.

    © 2023 • BuddyBoss