Default API endpoints in Wordpress - Mini Project: Build & Apply

Default API Endpoints in WordPress

📖 Scenario: You are building a simple WordPress site that needs to show posts and pages data using the default WordPress REST API endpoints.

🎯 Goal: Learn how to access and use the default WordPress REST API endpoints to fetch posts and pages data.

📋 What You'll Learn

Create a variable to store the base URL of the WordPress REST API

Create a variable to store the endpoint for fetching posts

Use the fetch API to get posts data from the posts endpoint

Add the final fetch call for pages endpoint

💡 Why This Matters

🌍 Real World

WordPress sites often expose content via REST API endpoints. Knowing how to access these endpoints helps you build custom frontends or integrations.

💼 Career

Many web developer roles require fetching and displaying WordPress content using its REST API, making this knowledge practical and valuable.

1

Set up the base API URL

Create a variable called apiBaseUrl and set it to the string "https://example.com/wp-json/wp/v2" which is the base URL for WordPress REST API.

Wordpress

# Create a variable called apiBaseUrl and set it to "https://example.com/wp-json/wp/v2"
# Your code here

Hint

The base URL for WordPress REST API usually ends with /wp-json/wp/v2.

2

Create posts endpoint URL

Create a variable called postsEndpoint and set it to the posts endpoint by combining apiBaseUrl with "/posts".

Wordpress

const apiBaseUrl = "https://example.com/wp-json/wp/v2";
# Create a variable postsEndpoint by adding "/posts" to apiBaseUrl
# Your code here

Hint

Use string concatenation to add /posts to the base URL.

3

Fetch posts data

Use the fetch function to get data from postsEndpoint. Create a variable called postsData and assign it the result of await fetch(postsEndpoint).

Wordpress

const apiBaseUrl = "https://example.com/wp-json/wp/v2";
const postsEndpoint = apiBaseUrl + "/posts";
// Use fetch to get posts data and assign to postsData
// Your code here

Hint

Remember to use await with fetch to wait for the response.

4

Fetch pages data

Create a variable called pagesEndpoint by adding "/pages" to apiBaseUrl. Then use fetch to get data from pagesEndpoint and assign it to a variable called pagesData.

Wordpress

const apiBaseUrl = "https://example.com/wp-json/wp/v2";
const postsEndpoint = apiBaseUrl + "/posts";
const postsData = await fetch(postsEndpoint);
// Create pagesEndpoint and fetch pagesData
// Your code here

Hint

Follow the same pattern as posts to get pages data.

Practice

1. What is the main purpose of WordPress default API endpoints?

easy

A. To allow easy access to WordPress data via URLs

B. To create custom themes automatically

C. To manage user roles and permissions

D. To optimize website SEO settings

Solution

1. Step 1: Understand what API endpoints do

   API endpoints provide a way to get or send data through URLs.

2. Step 2: Identify the role of default WordPress endpoints

   They let you access WordPress content like posts or users easily without extra coding.

3. Final Answer:

   To allow easy access to WordPress data via URLs -> Option A

4. Quick Check:

   Default API endpoints = easy data access [OK]

Hint: Default API endpoints = easy data access URLs [OK]

Common Mistakes:

• Thinking endpoints create themes
• Confusing endpoints with user management
• Assuming endpoints handle SEO

2. Which of the following is the correct default REST API endpoint URL to get all posts in WordPress?

easy

A. /wp-content/posts

B. /wp-admin/posts

C. /api/v1/posts/all

D. /wp-json/wp/v2/posts

Solution

1. Step 1: Recall the WordPress REST API base URL

   The base URL for WordPress REST API is /wp-json/wp/v2/.

2. Step 2: Identify the correct endpoint for posts

   The posts endpoint is posts, so full URL is /wp-json/wp/v2/posts.

3. Final Answer:

   /wp-json/wp/v2/posts -> Option D

4. Quick Check:

   Posts endpoint = /wp-json/wp/v2/posts [OK]

Hint: WordPress REST API base = /wp-json/wp/v2/ [OK]

Common Mistakes:

• Using admin URLs instead of API URLs
• Confusing API version or path
• Using incorrect folder paths

3. What will be the result of accessing the URL /wp-json/wp/v2/posts/10 in a WordPress site?

medium

A. Returns the post with ID 10 in JSON format

B. Returns a list of all posts except post 10

C. Returns an error because ID is not allowed

D. Redirects to the homepage

Solution

1. Step 1: Understand the endpoint pattern

   The URL /wp-json/wp/v2/posts/{id} fetches a single post by its ID.

2. Step 2: Interpret the given URL

   Here, ID is 10, so it returns the post with ID 10 in JSON format.

3. Final Answer:

   Returns the post with ID 10 in JSON format -> Option A

4. Quick Check:

   Single post URL returns that post [OK]

Hint: URL with /posts/{id} returns that post [OK]

Common Mistakes:

• Thinking it returns all posts except one
• Assuming ID is invalid in URL
• Expecting a redirect instead of JSON

4. You try to fetch users data using /wp-json/wp/v2/users but get a 401 Unauthorized error. What is the likely cause?

medium

A. The URL is missing the API version

B. The users endpoint does not exist in WordPress

C. You need proper authentication to access users endpoint

D. You must use GET method instead of POST

Solution

1. Step 1: Check endpoint access rules

   Users endpoint requires authentication because user data is sensitive.

2. Step 2: Analyze the error 401 Unauthorized

   This error means the request lacks valid credentials to access the resource.

3. Final Answer:

   You need proper authentication to access users endpoint -> Option C

4. Quick Check:

   401 error = authentication needed [OK]

Hint: 401 error means login/auth needed [OK]

Common Mistakes:

• Thinking users endpoint is missing
• Assuming URL version is wrong
• Confusing HTTP methods

5. You want to get all published posts with the category ID 5 using the default WordPress REST API. Which URL should you use?

hard

A. /wp-json/wp/v2/posts?category=5&status=published

B. /wp-json/wp/v2/posts?categories=5&status=publish

C. /wp-json/wp/v2/posts?cat=5&post_status=publish

D. /wp-json/wp/v2/posts?categories=5&post_status=published

Solution

1. Step 1: Identify correct query parameters for category and status

   WordPress REST API uses categories for category IDs and status for post status.

2. Step 2: Match parameters with correct values

   Category ID is 5, and published posts use status=publish.

3. Final Answer:

   /wp-json/wp/v2/posts?categories=5&status=publish -> Option B

4. Quick Check:

   categories=5 and status=publish are correct params [OK]

Hint: Use categories=ID and status=publish for filtering posts [OK]

Common Mistakes:

• Using wrong parameter names like category or cat
• Using status=published instead of publish
• Mixing post_status with status