wordpress-psr/request-handler

A PSR-15 server request handler for WordPress.

dev-master 2022-04-06 05:29 UTC

Requires

• php: >=7.1
• dflydev/fig-cookies: ^3.0
• johnpbloch/wordpress-core-installer: ^2.0
• psr/http-factory: ^1.0
• psr/http-message: ~1.0
• psr/http-server-handler: ~1.0
• psr/http-server-middleware: ^1.0
• superdav42/wordpress-core: dev-master
• symfony/polyfill-php80: ^1.22.1

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ^0.7.0
• friendsofphp/php-cs-fixer: ^2.18.2
• laminas/laminas-diactoros: ~2.2
• laminas/laminas-httphandlerrunner: ^1.3
• nyholm/psr7: ^1.4
• phpstan/phpstan: ^0.12.80
• phpunit/phpunit: ^9.3.8
• rector/rector: dev-main
• roave/security-advisories: dev-master
• wp-coding-standards/wpcs: ^2.3.0

Suggests

• rector/rector: Modify code on-the-fly to use PSR functions.

Provides

• psr/http-server-handler-implementation: 1.0

MIT

• David Stone

• wordpress
• middleware
• psr-7
• psr-15

README

A PSR-15 Request Handler wrapper around WordPress core.

Installation

$ composer require wordpress-psr/request-handler

Overview

This package allows WordPress installations to be used in a PSR Request and Response context. This package is not very useful by itself but can be combined with any number of Request Handler Runners or Middlewares to use WordPress is ways which were never possible before.

Swoole

Using this request handler and combining it with the chubbyphp-swoole-request-handler it is possible to run WordPress in the persistent, high performance, event-driven, asynchronous swoole http server. See the WordPress PSR Swoole project for more details. In addition to Swoole since this request handler is using the psr-15 standard other event driven libraries such as react or amp should work as well.

Example Usage

See tests/server.php for a working example of how this request handler could be used. This file was used to test the request handler with this line in the nginx conf:

try_files $uri /wordpress/$uri /tests/server.php?$args;

which is needed so static files in the wordpress sub-folder can be accessed and anything else is handled by server.php.

WordPress Modifications

WordPress core code needed to be modified to get certain aspects of the request handler to work. These are kept in a fork right now but hopefully after their usefulness has been proven the changes can be merged into core. Rector was used to make some modifications such as changing all called to exit or die to a new function called wp_exit. wp_exit() just does the action wp_exit before calling exit so that this request handler can throw an exception which return the execution flow to the request handler which returns a response object instead of exiting.
All calls to header() and setcookie were also changed to trigger an action that this request handler hooks onto. The hook records the headers and cookies so they can be added to the response object. Other changes are performed to allow WordPress to work as a long-running process. Mostly using require instead of require_once where appropriate.

License

GPL, see LICENSE.