Search...
deleteDraftPost( )
Moves a draft post with the provided ID to the trash bin.
A published post can also be deleted by its provided draftPostId
.
Description
The optional permanent
field enables you to delete a post permanently, bypassing the trash bin. When a draft post is deleted this way, it can't be restored.
Admin Method
This function requires elevated permissions to run. This function is not universal and runs only on the backend.
Syntax
function deleteDraftPost(draftPostId: string, options: DeleteDraftPostOptions): Promise<void>
deleteDraftPost Parameters
NAME
TYPE
DESCRIPTION
draftPostId
string
Draft post ID.
options
Optional
DeleteDraftPostOptions
Options for deleting a draft post.
Returns
Return Type:
Promise<
void
>Was this helpful?
Delete a draft post (export from backend code)
Copy Code
1import { draftPosts } from 'wix-blog-backend';2import { webMethod, Permissions } from 'wix-web-module';3import { elevate } from 'wix-auth';45// Sample draftPostId value: "2b36fbd0-f87a-43ce-ad11-e73d354b0072"67const elevatedDeleteDraftPost = elevate(draftPosts.deleteDraftPost);89export const myDeleteDraftPostFunction = webMethod(10 Permissions.Admin,11 async (draftPostId) => {12 try {13 await elevatedDeleteDraftPost(draftPostId);14 console.log('Successfully deleted the following draft post:', draftPostId);15 return;16 } catch (error) {17 console.error(error);18 // Handle the error19 }20 }21);2223// Promise returns void
Delete a draft post using options (export from backend code)
Copy Code
1import { draftPosts } from 'wix-blog-backend';2import { webMethod, Permissions } from 'wix-web-module';3import { elevate } from 'wix-auth';45/*6 * Sample draftPostId value: "d1ce1aad-edcc-43a8-b36f-d6c4ca76ef70";7 *8 * Sample options value:9 * {10 * permanent: true11 * }12 */13const elevatedDeleteDraftPost = elevate(draftPosts.deleteDraftPost);1415export const myDeleteDraftPostFunction = webMethod(16 Permissions.Admin,17 async (draftPostId, options) => {18 try {19 await elevatedDeleteDraftPost(draftPostId, options);20 console.log('Permanently deleted the following draft post:', draftPostId);21 return;22 } catch (error) {23 console.error(error);24 // Handle the error25 }26 }27);2829// Promise returns void
Delete a draft post (dashboard page code)
Copy Code
1import { draftPosts } from 'wix-blog-backend';23// Sample draftPostId value: "2b36fbd0-f87a-43ce-ad11-e73d354b0072"45export async function myDeleteDraftPostFunction(draftPostId) {6 try {7 await draftPosts.deleteDraftPost(draftPostId);8 console.log('Successfully deleted the following draft post:', draftPostId);9 return;10 } catch (error) {11 console.error(error);12 // Handle the error13 }14 }1516// Promise returns void