{"id": "plugin_hooks:plugin-hook-forbidden", "page": "plugin_hooks", "ref": "plugin-hook-forbidden", "title": "forbidden(datasette, request, message)", "content": "datasette  -  Datasette class \n                     \n                         You can use this to access plugin configuration options via  datasette.plugin_config(your_plugin_name) , or to render templates or execute SQL queries. \n                     \n                 \n                 \n                     request  -  Request object \n                     \n                         The current HTTP request. \n                     \n                 \n                 \n                     message  - string \n                     \n                         A message hinting at why the request was forbidden. \n                     \n                 \n             \n             Plugins can use this to customize how Datasette responds when a 403 Forbidden error occurs - usually because a page failed a permission check, see  Permissions . \n             If a plugin hook wishes to react to the error, it should return a  Response object . \n             This example returns a redirect to a  /-/login  page: \n             from datasette import hookimpl\nfrom urllib.parse import urlencode\n\n\n@hookimpl\ndef forbidden(request, message):\n    return Response.redirect(\n        \"/-/login?=\" + urlencode({\"message\": message})\n    ) \n             The function can alternatively return an awaitable function if it needs to make any asynchronous method calls. This example renders a template: \n             from datasette import hookimpl, Response\n\n\n@hookimpl\ndef forbidden(datasette):\n    async def inner():\n        return Response.html(\n            await datasette.render_template(\n                \"render_message.html\", request=request\n            )\n        )\n\n    return inner", "breadcrumbs": "[\"Plugin hooks\"]", "references": "[]"}