Permission callbacks in Wordpress - Mini Project: Build & Apply

WordPress Permission Callbacks

📖 Scenario: You are building a WordPress plugin that adds a custom REST API endpoint. To keep your site safe, you want to control who can access this endpoint by using permission callbacks.Think of permission callbacks like a security guard checking if someone has the right badge before entering a room.

🎯 Goal: Create a simple WordPress plugin that registers a REST API route with a permission callback. The callback will check if the current user has the edit_posts capability before allowing access.

📋 What You'll Learn

Create a function called myplugin_register_route to register the REST API route

Use register_rest_route with namespace myplugin/v1 and route /data

Add a permission callback function called myplugin_permission_check that returns true if the user can edit_posts

Hook the route registration function to rest_api_init

💡 Why This Matters

🌍 Real World

Permission callbacks are essential in WordPress plugins to protect sensitive data and actions from unauthorized users.

💼 Career

Understanding permission callbacks is important for WordPress developers to build secure and reliable plugins and themes.

1

Create the plugin setup and register REST route

Create a function called myplugin_register_route that uses register_rest_route to add a route /data under namespace myplugin/v1. For now, set the permission_callback to __return_true and the callback to a function that returns an array with 'message' => 'Hello World'. Hook myplugin_register_route to rest_api_init.

Wordpress

<?php
// Your code here

Hint

Use register_rest_route inside your function and hook it to rest_api_init.

2

Add the permission callback function

Create a function called myplugin_permission_check that returns true if the current user can edit_posts. Use the WordPress function current_user_can('edit_posts') inside it.

Wordpress

 'GET',
        'callback' => function() {
            return array('message' => 'Hello World');
        },
        'permission_callback' => '__return_true'
    ));
}
add_action('rest_api_init', 'myplugin_register_route');

// Your code here

Hint

Use current_user_can('edit_posts') to check permissions.

3

Update the route to use the permission callback

Modify the permission_callback in myplugin_register_route to use the function myplugin_permission_check instead of __return_true.

Wordpress

 'GET',
        'callback' => function() {
            return array('message' => 'Hello World');
        },
        'permission_callback' => '__return_true' // Change this
    ));
}
add_action('rest_api_init', 'myplugin_register_route');

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

Hint

Replace __return_true with 'myplugin_permission_check'.

4

Complete the plugin with proper PHP tags and comments

Ensure the plugin code starts with <?php and add a comment at the top: // Plugin to register a REST API route with permission callback.

Wordpress

<?php
// Your code here

Hint

Start your PHP file with <?php and add a descriptive comment.

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