snicco/wp-capability-middleware

Provides a middleware for snicco/http-routing that uses the WP capability system.

v1.9.0 2023-09-20 12:36 UTC

Requires

• php: ^7.4|^8.0
• snicco/better-wp-api: ^1.9
• snicco/http-routing: ^1.9
• snicco/psr7-error-handler: ^1.9

Requires (Dev)

• phpunit/phpunit: ^9.5.13
• snicco/http-routing-testing: ^1.9

Conflicts

• snicco/better-wp-cache: <1.9.0
• snicco/better-wp-cache-bundle: <1.9.0
• snicco/better-wp-cli: <1.9.0
• snicco/better-wp-cli-testing: <1.9.0
• snicco/better-wp-hooks: <1.9.0
• snicco/better-wp-hooks-bundle: <1.9.0
• snicco/better-wp-mail: <1.9.0
• snicco/better-wp-mail-bundle: <1.9.0
• snicco/better-wp-mail-testing: <1.9.0
• snicco/better-wpdb: <1.9.0
• snicco/better-wpdb-bundle: <1.9.0
• snicco/blade-bridge: <1.9.0
• snicco/blade-bundle: <1.9.0
• snicco/content-negotiation-middleware: <1.9.0
• snicco/debug-bundle: <1.9.0
• snicco/default-headers-middleware: <1.9.0
• snicco/eloquent: <1.9.0
• snicco/encryption-bundle: <1.9.0
• snicco/event-dispatcher: <1.9.0
• snicco/event-dispatcher-testing: <1.9.0
• snicco/guests-only-middleware: <1.0.0
• snicco/http-routing-bundle: <1.9.0
• snicco/http-routing-testing: <1.9.0
• snicco/https-only-middleware: <1.9.0
• snicco/illuminate-container-bridge: <1.9.0
• snicco/kernel: <1.9.0
• snicco/kernel-testing: <1.9.0
• snicco/method-override-middleware: <1.9.0
• snicco/minimal-logger: <1.9.0
• snicco/must-match-route-middleware: <1.9.0
• snicco/no-robots-middleware: <1.9.0
• snicco/open-redirect-protection-middleware: <1.9.0
• snicco/payload-middleware: <1.9.0
• snicco/pimple-bridge: <1.9.0
• snicco/psr7-error-handler: <1.0.0
• snicco/redirect-middleware: <1.9.0
• snicco/session: <1.9.0
• snicco/session-bundle: <1.9.0
• snicco/session-psr16-bridge: <1.9.0
• snicco/session-testing: <1.9.0
• snicco/session-wp-bridge: <1.9.0
• snicco/share-cookies-middleware: <1.9.0
• snicco/signed-url: <1.9.0
• snicco/signed-url-psr15-bridge: <1.9.0
• snicco/signed-url-psr16-bridge: <1.9.0
• snicco/signed-url-testing: <1.9.0
• snicco/signed-url-wp-bridge: <1.9.0
• snicco/str-arr: <1.9.0
• snicco/templating: <1.9.0
• snicco/templating-bundle: <1.9.0
• snicco/testable-clock: <1.9.0
• snicco/testing-bundle: <1.9.0
• snicco/trailing-slash-middleware: <1.9.0
• snicco/wp-auth-only-middleware: <1.9.0
• snicco/wp-guests-only-middleware: <1.9.0
• snicco/wp-nonce-middleware: <1.9.0

LGPL-3.0-only

• Calvin Alkan

README

This middleware checks if the currently logged-in WordPress user has a specified capability and will throw a 403 HTTPExcetion if that's not the case.

Installation

composer require snicco/wp-capability-middleware

Usage

This middleware should be added on a per-route basis.

If the currently authenticated WordPress user does not have the specified capability this middleware will throw an exception. Otherwise, the next middleware will be called.

use Snicco\Middleware\WPCap\AuthorizeWPCap;

$configurator->get('route1', '/route1', SomeController::class)
             ->middleware(AuthorizeWPCap::class.':manage_options');

// Optionally, a resource ID can be specified.
$configurator->get('route1', '/route1', SomeController::class)
             ->middleware(AuthorizeWPCap::class.':edit_post,1');

Contributing

This repository is a read-only split of the development repo of the Snicco project.

This is how you can contribute.

Reporting issues and sending pull requests

Please report issues in the Snicco monorepo.

Security

If you discover a security vulnerability, please follow our disclosure procedure.