@php-wasm/node

WebAssembly PHP for Node.js

This package ships WebAssembly PHP binaries and the JavaScript API optimized for Node.js. It comes with the following PHP extensions:

• SQLite
• Libzip
• Libpng
• CLI
• OpenSSL
• MySQL

It uses the host filesystem directly and can access the network if you plug in a custom WS proxy.

Here's how to use it:

import { PHP } from '@php-wasm/node';
const php = PHP.load('8.0', {
	requestHandler: {
		documentRoot: new URL('./', import.meta.url).pathname,
	},
});

// Create and run a script directly
php.writeFile('./index.php', `<?php echo "Hello " . $_POST['name']; ?>`);
await php.run({ scriptPath: './index.php' });

// Or use the familiar HTTP concepts:
const response = await php.request({
	method: 'POST',
	url: '/index.php',
	data: { name: 'John' },
});
console.log(response.text);

Attribution

@php-wasm/node started as a fork of the original PHP to WebAssembly build published by Oraoto in https://github.com/oraoto/pib and modified by Sean Morris in https://github.com/seanmorris/php-wasm.

Changelog

[v0.7.0] (2024-04-24)

Breaking Changes

PHP WebAssembly

• Breaking: Remove PHPBrowser. (#1302)

Enhancements

• Bump TypeScript to 5.4.5. (#1299)
• Semaphore: Add timeout option. (#1300)

Blueprints

• Builder: Fix stuck loader bar. (#1284)
• Remove setPhpIniEntry step. (#1288)

Tools

GitHub integration

• GitHub: Don't delete all the files when exporting a theme. (#1308)
• Urlencode branch name. (#1275)

Blueprints

• Blueprints builder: Support ?blueprint-url. (#1309)

Documentation

• Use new learning resources in Playground documentation. (#1276)

PHP WebAssembly

• Browser: Remove setSpawnHandler function from the public API. (#1303)
• PHP: Add a cwd argument to hotSwapPHPRuntime(). (#1304)
• PHP: Remove addServerGlobalEntry() method, accept $_SERVER as php.run() property. (#1286)
• PHPRequestHandler: Add a generic PHP argument. (#1310)
• nit: Clean up after node PHP popen() test. (#1280)

Website

• Add more info to crash reports. (#1253)
• Memoize fetch() responses when requesting php.wasm. (#1306)
• Progress monitoring: Use a custom instantiateWasm handler to avoid monkey-patching WebAssembly.instantiateStreaming. (#1305)
• Remove sandbox attribute from iframe. (#1313)
• Service Worker: Fetch credentialless to play more nicely with server caches (#1311). (#1311)

Internal

• Automate Changelog generation after each npm release. (#1312)
• CI: Fix intermittent documentation build failures. (#1307)

Bug Fixes

• Add styles to ensure iframes are responsive. (#1267)
• Docs: Fix the Blueprint example of the Gutenberg PR preview. (#1268)
• Docs: Move Steps Shorthands to a separate page to fix Steps TOC. (#1265)

Reliability

• Add network error message. (#1281)
• Explore logging to a file. (#1292)

Various

• Add PDF to infer mime type list. (#1298)

Contributors

The following contributors merged PRs in this release:

@adamziel @bgrgicak @brandonpayton @ironnysh @peeranat-dan