Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/donnikitos/vite-plugin-php
Vite's speed and tooling to preprocess PHP-files!
https://github.com/donnikitos/vite-plugin-php
php php-loader vite vite-loader vite-php vite-plugin vitejs
Last synced: 5 days ago
JSON representation
Vite's speed and tooling to preprocess PHP-files!
- Host: GitHub
- URL: https://github.com/donnikitos/vite-plugin-php
- Owner: donnikitos
- License: mit
- Created: 2023-03-13T11:46:48.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-11T20:30:47.000Z (2 months ago)
- Last Synced: 2025-01-08T18:08:35.496Z (13 days ago)
- Topics: php, php-loader, vite, vite-loader, vite-php, vite-plugin, vitejs
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/vite-plugin-php
- Size: 235 KB
- Stars: 41
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-vite - vite-plugin-php - Load and process PHP-entry files instead of default index.html. (Plugins / Framework-agnostic Plugins)
- awesome-vite - vite-plugin-php - Load and process PHP-entry files instead of default index.html. (Plugins / Framework-agnostic Plugins)
README
# vite-plugin-php
[](https://www.npmjs.com/package/vite-plugin-php) [](https://github.com/donnikitos/vite-plugin-php) [](https://github.com/donnikitos/vite-plugin-php/blob/master/LICENSE)
 [](https://github.com/donnikitos/vite-plugin-php/issues)
Use Vite's speed and tooling to process PHP-files!
```js
// vite.config.js
import { defineConfig } from 'vite';
import usePHP from 'vite-plugin-php';
export default defineConfig({
plugins: [usePHP()],
});
```
Check out the [starter repo](https://github.com/nititech/php-vite-starter) for an easy and convenient start:
## ⚡ Latest changes
| Version | Feature |
| ------- | ----------------------------------------------------------------------------------------------------------- |
| 1.0.66 | Fixed file monitoring on Windows |
| 1.0.65 | Fixed request body forwarding for all request methods |
| 1.0.62 | HTML transforms are now only applied to HTML contents during dev |
| 1.0.60 | Fixed inline module transpiling -> PHP code is being properly inserted into transpiled inline module chunks |
| 1.0.55 | Fixed pure PHP file processing |
| 1.0.50 | Using native Rollup pipeline to generate bundle -> proper error messages during build |
| 1.0.40 | Vite's "HTML Env Replacement" feature in transpiled PHP files |
| 1.0.30 | Proper PHP header forwarding during development |
| 1.0.20 | URL rewrite functionality to mimic mod_rewrite & friends |
| 1.0.11 | Improved Windows support |
## Write some PHP code in your `index.php`
```php
="Render some text with PHP!";?>
```
The plugin will serve you the processed `index.php` as usual, including all imported and preprocessed files that are supported by Vite and other loaders.
## Configuration
The configuration takes following properties:
```ts
type UsePHPConfig = {
binary?: string;
entry?: string | string[];
rewriteUrl?: (requestUrl: URL) => URL | undefined;
tempDir?: string;
cleanup?: {
dev?: boolean;
build?: boolean;
};
};
```
By default the plugin is trying to access the system `php`-binary and load the `index.php` file as the main entry point.
However you have the possibility to use an other binary or even compile multiple entry-points:
```js
usePHP({
binary: '/opt/lampp/bin/php-8.1.10',
entry: ['index.php', 'about.php', 'contact.php'],
});
```
Should you have multiple entry-points, you will be able to access each one according to this chart:
| Entry file | Accessible routes | Build file |
| ----------------- | ------------------------------------- | ------------------- |
| index.php | `/` `/index` `/index.php` | `index.php` |
| about.php | `/about` `/about.php` | `about.php` |
| about/details.php | `/about/details` `/about/details.php` | `about/details.php` |
| contact.php | `/contact` `/contact.php` | `contact.php` |
| shop/index.php | `/shop/` `/shop/index.php` | `shop/index.php` |
| ... | ... | ... |
Since version 1.0.6 you can specify wildcard entry points:
```js
usePHP({
binary: '/opt/lampp/bin/php-8.1.10',
entry: [
'index.php',
'about.php',
'contact.php',
'pages/**/*.php',
'partials/*.php',
],
});
```
These entries will also render according to the routing table above.
##### Rewrite urls
If you are using some sort of Apaches _mod_rewrite_ magic or nginx rewrite rules you can simulate them with the newly added in `rewriteUrl` property.
The rewriteUrl function has one parameter - the requested URL given as URL object - and return either a modified URL object or undefined:
```js
usePHP({
entry: ['index.php', 'partials/**/*.php'],
rewriteUrl(requestUrl) {
if (['.js', '.css'].some((s) => requestUrl.pathname.includes(s))) {
return;
}
requestUrl.search = '_request_=' + requestUrl.pathname;
requestUrl.pathname = 'index.php';
return requestUrl;
},
});
```
⚠️ **Attention:** If using the rewriteUrl property you will need to exclude (_return undefined_) assets like CSS, JavaScript, Images, etc.., that match your transpiled php file names, on your own!
## Specific oddities
#### Inline modules
⚠️ PHP will work somehow unintuitive in inlined modules.
E.g. you have a page with some variables:
```php
console.log('<?=$var; ?>');
```
This will not work. `$var` will be undefined in the module since the script is being transpiled into a separate file and included separately.
Same applies to other server variables like `$_GET`, `$_POST` and so on - they will not have the same value as the main PHP file.
#### Dynamically included asset processing
Vite won't be able to process PHP-computed styles, scripts or images:
```php
```
## Issues
If you encounter any other bugs or need some other features feel free to open an [issue](https://github.com/donnikitos/vite-plugin-php/issues).
## Support
Love open source? Enjoying my project?\
Your support can keep the momentum going! Consider a donation to fuel the creation of more innovative open source software.
via Ko-Fi
Buy me a coffee
via PayPal
