> For the complete documentation index, see [llms.txt](https://xoops.gitbook.io/xmf-cookbook/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://xoops.gitbook.io/xmf-cookbook/recipes/using-the-permission-helper/checking-permissions.md).

# Checking Permissions

Checking a user's permissions is easy with a permission helper.

The first step is to get a Permission Helper instance.

```php
$permHelper = new \Xmf\Module\Helper\Permission();
```

## Does the User Have Permission for an Item?

Let's imagine we have a protected forum, where each topic is protected by group permissions. The user needs a 'viewtopic' permission for a topic to view it. The id of the forum is stored in $id.

```php
$permission = $permHelper->checkPermission('viewtopic', $id);
```

The $permission variable now holds true if the user has permission, false if not.

## Leave if the User Does Not Have Permission

This is based on the same scenario as above, but we want to send the user back to the index page, if they don't have permission.

```php
$permHelper->checkPermissionRedirect('viewtopic', $id,
             'index.php', 3, 'You are not allowed to view that topic');
```

The user's browser session will be redirected to the module's index.php if the required permission is not assigned.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://xoops.gitbook.io/xmf-cookbook/recipes/using-the-permission-helper/checking-permissions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.