Blocking
Updated: Oct 14, 2026
This is a Platform SDK feature requiring Data Use Checkup
To use this feature, you must complete a Data Use Checkup (DUC). The DUC ensures that you comply with Developer Policies. It requires an administrator from your team to certify that your use of user data aligns with platform guidelines. During development, a DUC you submit is approved automatically and gives your app provisional access. Submitting the app for review or enabling higher release channel limits permanently ends automatic approval, but features you already have keep working while their review runs (see When to submit a DUC). Test users can call these features before DUC approval, except getting the logged-in user, which needs the User ID or User Profile grant.Blocking and Unblocking Users
Blocking is a core safety feature which users expect in multiplayer games and social experiences. This platform feature lets you access a user’s block list and allow users to block others directly from your app.
The user-block flow can be used to create new blocks with minimal disruption to the app experience. This is useful in multiplayer or social settings where a user might want to block another player. This flow allows you to prompt a user to block a specific other user, which they can choose to confirm or cancel. The user is then brought right back into your app. You can then access this block data to honor all their blocks in your app.
User_LaunchBlockFlow(FOvrId UserID)
Input:
FOvrIdUserID : The ID of the user the viewer wants to block.
This method deeplinks the viewer into a modal dialog targeting the specified user to be blocked. From the modal, the viewer can select Block to block the user and return to the app. Selecting Cancel returns the viewer to their app without any block action.
If using the
Meta XR Platform SDK in an Unreal app, you may use the
User Launch Block Flow blueprint function:
After calling the above method, you can use
FOvrLaunchBlockFlowResult to get the results of the viewer’s actions from the modal.
FOvrLaunchBlockFlowResult::DidBlock checks if the viewer selected Block from the modal.FOvrLaunchBlockFlowResult::DidCancel checks if the viewer canceled or selected Back from the modal.
For examples of how these values can be used, see the table below.
Block result feedback cases
| Situation | Description | Result Feedback (FOvrLaunchBlockFlowResult) |
|---|
Successful block | The user will view a dialog allowing them to Block or Cancel. The user selects Block and the block is executed successfully. | DidBlock: true, DidCancel: false
|
User cancel | The user will view a dialog allowing them to Block or Cancel. The user selects Cancel and returns the viewer to the app. | DidBlock: false, DidCancel: true
|
Viewer tries to block someone they blocked previously | The viewer receives a message informing them of the situation and asking whether they would like to unblock the target user. Selecting Back returns the viewer to their app. | DidBlock: false, DidCancel: true
|
Viewer tries to block themselves | The viewer receives a message indicating that this is not supported. Selecting Back returns the viewer to their app. | DidBlock: false, DidCancel: true
|
The block cannot be sent for some other reason. | The user receives the message “Unable to block. Please check your connection and try again.” Selecting Back returns the viewer to the app. | DidBlock: false, DidCancel: true
|
User_LaunchUnblockFlow(FOvrId UserID)
Input:
FOvrIdUserID : The ID of the user the viewer wants to unblock.
This method deeplinks the viewer into a modal dialog targeting the specified user to be unblocked. From the modal, the viewer can select Unblock to unblock the user and return to the app. Selecting Cancel returns the viewer to their app without any unblock action.
FOvrLaunchUnblockFlowResult::DidUnblock checks if the viewer selected Unblock from the modal.FOvrLaunchUnblockFlowResult::DidCancel checks if the viewer canceled or selected Back from the modal.
Retrieve a List of the User’s Blocked Users
To retrieve a list of a user’s blocked users, call the User_GetBlockedUsers() method. Doing so retrieves an array of the current user’s blocked user IDs who are also entitled to your app.
If there are a large number of values being returned, you may need to call BlockedUserPages_GetNextUrl() and paginate the data.
If using the
Meta XR Platform SDK in an Unreal app, you may use the
User Get Blocked Users blueprint function: