Frontity WP Plugins
How to collaborate
1. Fork this repo to your GitHub account.
2. Clone the fork in your computer.
3. Add the plugins to your WordPress installation.
You can add them using symlinks:
npm run sync ../../path/to/your/wordpress
4. Make the modifications to the code.
5. Submit a Pull Request.
WordPress Code Standards and Unit Tests
Installation in macOS
1. Install PHP.
Our recommendation is to use Homebrew:
brew install php
2. Install Composer.
Our recommendation is to use Hombrew:
brew install composer
Then, install the dependencies:
3. Install MySQL (for unit tests only)
Our recommendation is to use DBngin.
Once you've installed DBngin, create a new MySQL database (v5.7) and click on "Start".
Then, click on the terminal icon and add the line it shows
# DBngin exports export PATH=/Users/Shared/DBngin/mysql/5.7.23/bin:$PATH
5.7.23 for your MySQL version.
4. Install Xdebug (for debugging of unit tests)
Our recommendation is to use
pecl install xdebug
After the installation, add an extension with the Xdebug configuration at
[xdebug] zend_extension=/usr/local/Cellar/php/7.X/pecl/YYYYYYYY/xdebug.so xdebug.remote_enable=1 xdebug.remote_port=9000
7.X for your PHP version and YYYYYY for the folder where pecl installed Xdebug.
You may need to clean your previous PHP installation first, then install it again with brew. This post explains the process. You can skip the Nginx section.
You may need to remove the first line that the pecl installation added to your
php.ini file at
Run the code standards and beautifier
You can use these two commands to check that your code meets the WordPress standards:
npm run phpcs npm run phpcbf
Run the unit tests
The first time, you need to install the database and download WordPress
npm run install-wp-tests
This will run
bin/install-wp-tests.sh with the following parameters:
- DB_PASS='' (blank)
You can also run it manually if you prefer.
npm run phpunit to run the tests.