Gets a post by the provided slug.
The getPostBySlug()
function returns a Promise that resolves to a post whose slug matches the given slug.
The slug
is the end of a post's URL that refers to a specific post. For example, if a post's URL is https:/example.com/blog/post/my-post-slug
, the slug is my-post-slug
. The slug is case-sensitive, and is generally derived from the post title, unless specified otherwise.
function getPostBySlug(
slug: string,
options: GetPostBySlugOptions,
): Promise<GetPostBySlugResponse>;
Slug of the post to retrieve.
The end of a post's URL, for example, https:/example.com/blog/post/my-post-slug
. Case sensitive and generally based on the post title if not specified.
Options specifying which fields to return.
import { posts } from "wix-blog-backend";
/* Sample slug value:
* 'my-slug'
*/
export async function getPostBySlugFunction(slug) {
try {
const result = await posts.getPostBySlug(slug);
const title = result.post.title;
const postId = result.post._id;
console.log("Retrieved Result:", result);
return result;
} catch (error) {
console.error(error);
}
}
/* Promise resolves to:
* {
* "post": {
* "_id": "ccbb6257-ed0e-4521-97df-8b5b207adb00",
* "categoryIds": [
* "1ea22fce-bc3c-4b78-9422-f0f367f8628e"
* ],
* "commentingEnabled": true,
* "excerpt": "Create a blog post subtitle that summarizes your post in a few short, punchy sentences and entices your audience to continue reading....",
* "featured": true,
* "firstPublishedDate": "2020-08-05T21:00:00.000Z",
* "hashtags": [
* "sea",
* "sun"
* ],
* "heroImage": ""
* "language": "en",
* "lastPublishedDate": "2020-08-05T21:00:00.000Z",
* "media": {
* "wixMedia": {
* "image": "wix:image://v1/75059a_9f8cd2f1282c4dc7ae9a4bea155e2661~mv2.jpg#originWidth=602&originHeight=773"
* },
* "displayed": true,
* "custom": false
* },
* "memberId": "4b9f4b64-0792-481e-9289-b2550c1bb7ea",
* "minutesToRead": 1,
* "moderationDetails": {},
* "pinned": false,
* "preview": false,
* "pricingPlanIds": [
* "b6e94a0c-4d0f-435e-9602-0dd61d2aca37"
* ],
* "relatedPostIds": [
* "425a5dca-c32d-40e6-b2d7-a8ffa3addded"
* ],
* "slug": "my-vacation",
* "tagIds": [
* "b698f939-cab5-419b-9966-ba0fa3316de9"
* ],
* "title": "My vacation",
* "translationId": "3cd710b7-c28d-4547-9b8a-3c1ec776064b"
* }
* }
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.