Download the PHP package vinkla/wordplate without Composer

On this page you can find all versions of the php package vinkla/wordplate. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package wordplate

WordPlate

WordPlate

WordPlate is a boilerplate for WordPress, built with Composer and designed with sensible defaults.

Build Status Monthly Downloads Latest Version

Features

Installation

Before using WordPlate, make sure you have PHP 8.2 and MySQL 8.0 installed on your computer. You'll also need to have Composer, a package manager for PHP, installed on your computer.

To install WordPlate, open your terminal and enter the following command:

After installing WordPlate, you'll need to update the database credentials in the .env file. This file is located in the root directory of your project. Open the file and update the following lines with your database credentials:

To run your WordPlate application, you may serve it using PHP's built-in web server. Open your terminal and navigate to the public directory of your project. Then, enter the following command:

Finally, open your web browser and visit the following URLs to view your WordPlate application:

Configuration

Public Directory

After installing WordPlate, you'll need to configure your web server's document or web root to be the public directory. This is where the main entry point for your application, index.php, is located.

By setting the public directory as your web server's document root, you ensure that all HTTP requests are routed through the front controller, which handles the requests and returns the appropriate responses.

This configuration helps to improve the security and performance of your application by preventing direct access to files outside of the public directory.

Environment Configuration

WordPlate makes it easy to manage different configuration values based on the environment where your application is running. For example, you may need to use a different database locally than you do on your production server.

To accomplish this, WordPlate uses the vlucas/phpdotenv PHP package. When you install WordPlate, a .env.example file is included in the root directory of your application. If you installed WordPlate via Composer, this file will automatically be renamed to .env. Otherwise, you should rename the file manually.

It's important to note that your .env file should not be committed to your application's source control. This is because each developer or server using your application may require a different environment configuration. Additionally, committing your .env file to source control would be a security risk in the event that an intruder gains access to your repository, as any sensitive credentials would be exposed.

To learn more about managing environment variables in WordPlate, you can refer to Laravel's documentation on the topic:

Salt Keys

It's important to add salt keys to your environment file. These keys are used to encrypt sensitive data, such as user sessions, and help to ensure the security of your application.

If you don't set the salt keys, your user sessions and other encrypted data may be vulnerable to attacks. To make it easier to generate secure salt keys, we've created a salt key generator that you can use. If you haven't already done so, copy the .env.example file to a new file named .env. Then visit the generator and copy the randomly generated keys to your .env file.

Plugins

WordPress Packagist

WordPlate includes integration with WordPress Packagist, a Composer repository that mirrors the WordPress plugin and theme directories. With this integration, you can install and manage plugins using Composer.

To install a plugin, use wpackagist-plugin as the vendor name and the plugin slug as the package name. For example, to install the clean-image-filenames plugin, you would use the following command:

The installed packages will be located in the public/plugins directory.

Here's an example of what your composer.json file might look like:

For more information and examples, please visit the WordPress Packagist website.

Must Use Plugins

Must-use plugins (also known as mu-plugins) are a type of WordPress plugin that is installed in a special directory inside the content folder. These plugins are automatically enabled on all sites in the WordPress installation.

To install plugins into the mu-plugins directory, add the plugin name to the installer-paths of your composer.json file:

To install the plugin, use wpackagist-plugin as the vendor name and the plugin slug as the package name:

The plugin will be installed in the public/mu-plugins directory.

For more information on the must-use plugin autoloader, please refer to the Bedrock documentation.

Included Plugins

Headache

An easy-to-swallow painkiller plugin for WordPress. It is included by default in WordPlate. It removes a lot of default WordPress stuff you just can't wait to get rid of. It removes meta tags such as feeds, version numbers and emojis.

Clean Image Filenames

The plugin automatically converts language accent characters in filenames when uploading to the media library. Characters are converted into browser and server friendly, non-accent characters.

Vite.js

Vite is a build tool that aims to provide a faster and leaner development experience for modern web projects. Vite is opinionated and comes with sensible defaults out of the box, but is also highly extensible via its Plugin API and JavaScript API with full typing support.

To get started with Vite, please visit the documentation.

Mail

To set up custom SMTP credentials for sending emails in your WordPlate application, you need to configure the required environment variables in your .env file.

If you're using a local email service like Mailpit, you need to disable encryption by setting the MAIL_ENCRYPTION environment variable to null.

FAQ

Can I add WordPress constants to the environment file? This is possible by updating the `public/wp-config.php` file after the WordPlate application have been created. ` Then you may add the constant to the `.env` file. `
Can I install languages with Composer? If you want to install language packs using Composer, we recommend looking at the [WP Languages](https://wp-languages.github.io/) project.
Can I rename the public directory? Update your `.gitignore`, `composer.json`, `.vite.config.js`, and `wp-cli.yml` files with the new path to the `public` directory. Then, run `composer update` in the root of your project.
Can I rename the WordPress directory? By default WordPlate will put the WordPress in `public/wordpress`. If you want to change this there are a couple of steps you need to go through. Let's say you want to change the default WordPress location to `public/wp`: 1. Update the `wordpress-install-dir` path in your `composer.json` file. 1. Update `wordpress` to `wp` in `wordplate/public/.gitignore`. 1. Update the last line in the `public/index.php` file to: 1. Update the `WP_DIR` environment variable in the `.env` file to `wp`. 1. If you're using WP-CLI, update the path in the `wp-cli.yml` file to `public/wp`. 1. Remove the `public/wordpress` directory if it exist and then run `composer update`.
Can I rename the theme directory? For most applications you may leave the theme directory as it is. If you want to rename the `wordplate` theme to something else you'll also need to update the `WP_DEFAULT_THEME` environment variable in the `.env` file.
Can I use WordPlate with Laravel Herd or Valet? If you're using Laravel Herd or Valet together with WordPlate, you may use our [custom driver](https://laravel.com/docs/11.x/valet#custom-valet-drivers):
Can I use WordPlate with Tinkerwell? If you're using Tinkerwell together with WordPlate, you may use our [custom driver](https://tinkerwell.app/docs/4/extending-tinkerwell/custom-drivers):

Upgrade Guide

Upgrading from 11 to 12 1. The `wordplate/framework` package has been archived. Update the `composer.json` file: 1. Replace your `public/wp-config.php` file with [the one in this repository](public/wp-config.php). Remember to save any custom constants defined in your `wp-config.php` file. 1. Add the [`src/helpers.php`](src/helpers.php) file from this repository and autoload it in the `composer.json` file: 1. Run `composer update` in the root of your project.
Upgrading from 10 to 11 1. WordPlate now requires PHP 8.0 or later. 1. Bump the version number in the `composer.json` file to `^11.0`. 1. Run `composer update` in the root of your project.
Upgrading from 9 to 10 1. WordPlate now requires PHP 7.4 or later. 1. Bump the version number in the `composer.json` file to `^10.0`. 1. Rename `WP_ENV` to `WP_ENVIRONMENT_TYPE` in the environment file. 1. Rename `WP_THEME` to `WP_DEFAULT_THEME` in the environment file. 1. Rename `WP_URL` to `WP_HOME` in the environment file (if it exists). 1. If you're using the `WP_CACHE` environment variable you'll need to define it in the `public/wp-config.php` file: ` 1. Optional: Rename `WP_PREFIX` to `DB_TABLE_PREFIX` in the following files: - `.env` - `.env.example` - `public/wp-config.php` 1. Run `composer update` in the root of your project.
Upgrading from 8 to 9 1. Bump the version number in the `composer.json` file to `^9.0`. 1. Copy the `public/mu-plugins/mu-plugins.php` file into your project. 1. Update the `public/.gitignore` file to allow the new `mu-plugins.php` file: ` 1. Run `composer update` in the root of your project.
Upgrading from 7 to 8 1. WordPlate now requires PHP 7.2 or later. 1. Bump the version number in the `composer.json` file to `^8.0`. > [!Note] > WordPlate 8.0 requires WordPress 5.3 or later. 1. Laravel's helper functions is now optional in WordPlate. If you want to use the functions, install the [`laravel/helpers`](https://github.com/laravel/helpers#readme) package, with Composer, in the root of your project: 1. Laravel's collections are now optional in WordPlate. If you want to use collections, install the [`tightenco/collect`](https://github.com/tightenco/collect#readme) package, with Composer, in the root of your project: 1. The `mix` helper function is now optional in WordPlate. If you want to use the function, install the [`ibox/mix-function`](https://github.com/juanem1/mix-function#readme) package, with Composer, in the root of your project: 1. Replace any usage of `asset`, `stylesheet_url` and `template_url` functions with WordPress's [`get_theme_file_uri`](https://developer.wordpress.org/reference/functions/get_theme_file_uri/) function. 1. Replace any usage of `stylesheet_path` and `template_path` functions with WordPress's [`get_theme_file_path`](https://developer.wordpress.org/reference/functions/get_theme_file_path/) function . 1. The `base_path` and `template_slug` functions have been removed. 1. Run `composer update` in the root of your project.
Upgrading from 6 to 7 1. Bump the version number in the `composer.json` file to `^7.0`. > [!Note] > WordPlate 7.0 requires WordPress 5.0 or later. 1. Update the `realpath(__DIR__)` to `realpath(__DIR__.'/../')` in the `wp-config.php` file. 1. If your public directory isn't named `public`, add the following line to the `wp-config.php` file: 1. Run `composer update` in the root of your project.
Upgrading from 5 to 6 1. Bump the version number in the `composer.json` file to `^6.0`. 1. Update the `realpath(__DIR__.'/../')` to `realpath(__DIR__)` in the `wp-config.php` file. 1. Run `composer update` in the root of your project.
Upgrading from 4 to 5 1. Bump the version number in the `composer.json` file to `^5.0`. 1. Copy and paste the contents of the [`wp-config.php`](https://github.com/vinkla/wordplate/blob/e301f9b093efdbd1bdeeb61e2f99f86e23c36fb2/public/wp-config.php) file into your application. > [!Note] > Make sure you don't overwrite any of your custom constants. 1. Run `composer update` in the root of your project.

Acknowledgements

WordPlate wouldn't be possible without these amazing open-source projects.

License

The WordPlate package is open-sourced software licensed under the MIT license.


All versions of wordplate with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
composer/installers Version ^2.2
roots/bedrock-autoloader Version ^1.0.4
roots/wordpress Version ^6.5
roots/wp-password-bcrypt Version ^1.1
symfony/http-foundation Version ^7.0
vinkla/headache Version ^3.3
vlucas/phpdotenv Version ^5.6
wpackagist-plugin/clean-image-filenames Version ^1.4
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package vinkla/wordplate contains the following files

Loading the files please wait ....