Permission callbacks in Wordpress - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a permission callback in WordPress REST API?

A permission callback is a function that checks if the current user has the right to access or modify a REST API endpoint. It returns true if allowed, false otherwise.

beginner

Why do we use permission callbacks when registering REST API routes?

Permission callbacks protect REST API routes by ensuring only authorized users can access or change data, helping keep the site secure.

intermediate

How do you define a permission callback when registering a REST route in WordPress?

You add a 'permission_callback' key in the route arguments, assigning it a function that returns true or false based on user capabilities.

beginner

What happens if a permission callback returns false?

The REST API request is denied with a 403 Forbidden error, preventing unauthorized access.

intermediate

Give an example of a simple permission callback function in WordPress.

function my_permission_callback() { return current_user_can('edit_posts'); } This allows only users who can edit posts to access the route.

What does a permission callback function return to allow access?

A an error message

B true

C null

D false

Permission callbacks must return true to allow access to the REST API endpoint.

Where do you specify the permission callback when registering a REST route?

A In the 'args' argument

B In the 'callback' argument

C In the 'methods' argument

D In the 'permission_callback' argument

The 'permission_callback' argument is used to define the function that checks user permissions.

What HTTP status code is returned if permission callback denies access?

A 200 OK

B 404 Not Found

C 403 Forbidden

D 500 Internal Server Error

A 403 Forbidden status code indicates the user is not allowed to access the resource.

Which WordPress function is commonly used inside permission callbacks to check capabilities?

A current_user_can()

B wp_enqueue_script()

C get_post()

D register_rest_route()

current_user_can() checks if the current user has a specific capability.

If no permission callback is set, what is the default behavior for REST API routes?

A Access is allowed to everyone

B Access is denied to everyone

C Access depends on the HTTP method

D Access depends on user role

By default, REST API routes are public unless a permission callback restricts access.

Explain what a permission callback is and why it is important in WordPress REST API.

Think about who can use your API and how you check that.

Describe how to add a permission callback when registering a REST API route in WordPress.

Focus on the arguments passed to register_rest_route.

Practice

1. What is the main purpose of a permission callback in WordPress REST API routes?

easy

A. To define the URL of the REST API route

B. To check if the current user has permission to access the route

C. To format the response data before sending

D. To register the REST API route with WordPress

Solution

1. Step 1: Understand permission callback role

   A permission callback is a function that decides if a user can access a REST API route.

2. Step 2: Identify what permission callback checks

   It returns true if the user has the right capability, false otherwise.

3. Final Answer:

   To check if the current user has permission to access the route -> Option B

4. Quick Check:

   Permission callback = access control [OK]

Hint: Permission callbacks control access rights [OK]

Common Mistakes:

• Confusing permission callback with route registration
• Thinking it formats data instead of checking access
• Assuming it sets the route URL

2. Which of the following is the correct way to define a permission callback in register_rest_route?

easy

A. "permission_callback" => array(check_user_permission)

B. "permission_callback" => check_user_permission()

C. "permission_callback" => "check_user_permission()"

D. "permission_callback" => check_user_permission

Solution

1. Step 1: Understand callback syntax in PHP arrays

   Callbacks are passed as callable references without parentheses.

2. Step 2: Identify correct syntax for permission_callback

   It should be a string or callable without calling it immediately, so no parentheses.

3. Final Answer:

   "permission_callback" => check_user_permission -> Option D

4. Quick Check:

   Callback = function name without () [OK]

Hint: Use function name without parentheses for callbacks [OK]

Common Mistakes:

• Adding parentheses calls the function immediately
• Using array() incorrectly for single function
• Passing callback as a string with quotes and parentheses

3. Given this permission callback function, what will register_rest_route allow?

function my_permission_check() {
  return current_user_can('edit_posts');
}

register_rest_route('myplugin/v1', '/data', [
  'methods' => 'GET',
  'callback' => 'my_data_callback',
  'permission_callback' => 'my_permission_check'
]);

medium

A. Only users who can edit posts can access the route

B. All users can access the route

C. No users can access the route

D. Only administrators can access the route

Solution

1. Step 1: Analyze the permission callback function

   The function returns true if the current user has the 'edit_posts' capability.

2. Step 2: Understand effect on route access

   Only users with 'edit_posts' capability can access the route; others get denied.

3. Final Answer:

   Only users who can edit posts can access the route -> Option A

4. Quick Check:

   Capability check controls access [OK]

Hint: Permission callback returns true only for allowed users [OK]

Common Mistakes:

• Assuming all users can access without checking capability
• Confusing 'edit_posts' with administrator only
• Ignoring the return value of permission callback

4. Identify the error in this permission callback code:

function check_permission() {
  if (current_user_can('edit_posts')) {
    return true;
  }
}

medium

A. Function should not return boolean

B. Incorrect capability name used

C. Missing return false when user lacks permission

D. Permission callback must be anonymous function

Solution

1. Step 1: Review function return paths

   The function returns true if user can edit posts, but returns nothing otherwise.

2. Step 2: Understand permission callback requirements

   Permission callbacks must return true or false explicitly to avoid unexpected behavior.

3. Final Answer:

   Missing return false when user lacks permission -> Option C

4. Quick Check:

   Always return true or false in permission callbacks [OK]

Hint: Always return false if permission denied [OK]

Common Mistakes:

• Omitting return false causes implicit null return
• Assuming no return means false automatically
• Using wrong capability names

5. You want to create a REST API route that only allows users who can either edit_posts or publish_posts. Which permission callback function correctly implements this?

hard

A. function permission_check() {
return current_user_can('edit_posts') || current_user_can('publish_posts');
}

B. function permission_check() {
return current_user_can('publish_posts');
}

C. function permission_check() {
if (current_user_can('edit_posts')) {
return true;
}
return false;
}

D. function permission_check() {
return current_user_can('edit_posts') && current_user_can('publish_posts');
}

Solution

1. Step 1: Understand the requirement

   Access should be granted if user can edit posts OR publish posts.

2. Step 2: Analyze each function logic

   function permission_check() { return current_user_can('edit_posts') && current_user_can('publish_posts'); } requires both capabilities (AND), which is too strict. function permission_check() { return current_user_can('edit_posts') || current_user_can('publish_posts'); } uses OR, which matches requirement. function permission_check() { if (current_user_can('edit_posts')) { return true; } return false; } only checks edit_posts. function permission_check() { return current_user_can('publish_posts'); } only checks publish_posts.

3. Final Answer:

   function permission_check() { return current_user_can('edit_posts') || current_user_can('publish_posts'); } -> Option A

4. Quick Check:

   Use OR for either capability allowed [OK]

Hint: Use || to allow either capability [OK]

Common Mistakes:

• Using && instead of || for either/or logic
• Checking only one capability when two are needed
• Not returning false explicitly when needed