• 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_Signup_Endpoint BP_REST_Signup_Endpoint::delete_item()

    BP_REST_Signup_Endpoint::delete_item( WP_REST_Request $request )

    Delete a signup.

    Description

    Parameters

    $request

    (Required) Full details about the request.

    Return

    (WP_REST_Response) | WP_Error

    Source

    File: bp-members/classes/class-bp-rest-signup-endpoint.php

    	public function delete_item( $request ) {
    		$request->set_param( 'context', 'edit' );
    
    		// Get the signup before it's deleted.
    		$signup   = $this->get_signup_object( $request['id'] );
    		$previous = $this->prepare_item_for_response( $signup, $request );
    		$deleted  = BP_Signup::delete( array( $signup->id ) );
    
    		if ( ! $deleted ) {
    			return new WP_Error(
    				'bp_rest_signup_cannot_delete',
    				__( 'Could not delete signup.', 'buddyboss' ),
    				array(
    					'status' => 500,
    				)
    			);
    		}
    
    		// Build the response.
    		$response = new WP_REST_Response();
    		$response->set_data(
    			array(
    				'deleted'  => true,
    				'previous' => $previous->get_data(),
    			)
    		);
    
    		/**
    		 * Fires after a signup is deleted via the REST API.
    		 *
    		 * @param BP_Signup        $signup   The deleted signup.
    		 * @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_signup_delete_item', $signup, $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-members/classes/class-bp-rest-signup-endpoint.php: BP_REST_Signup_Endpoint::get_signup_object()

    Get signup object.

    bp-members/classes/class-bp-rest-signup-endpoint.php: BP_REST_Signup_Endpoint::prepare_item_for_response()

    Prepares signup to return as an object.

    bp-members/classes/class-bp-rest-signup-endpoint.php: bp_rest_signup_delete_item

    Fires after a signup is deleted via the REST API.

    bp-members/classes/class-bp-signup.php: BP_Signup::delete()

    Delete a pending account.

    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.

    © 2025 • BuddyBoss