# Patched Plugins

Sometimes a plugin you rely on doesn't work quite right and they either aren't on github or are just ignoring your submitted PR. In this scenario it's useful to 'patch' the plugin, i.e. make direct changes to the source of the plugin.

Doing this directly in wp-content/plugins isn't safe because it can get reverted to the source easily with a composer install or update.

Therefore, we offer a way of safely patching plugins by using a similar method to how we deal with premium plugins. By patching and thus installing from the patched-plugins directly we are controlling the patch in a confined way, with a neat install and upgrade path.

IMPORTANT: When we patch the plugin in this way, we are diverging from the original source and thus aren't able to easily install updates. Therefore, patching a plugin should be considered a last resort or a temporary measure until you're able to get back to the source.

To patch a plugin, take the following steps:

• Move the plugin to patched-plugins

mv wp-content/plugins/plugin patched-plugins/plugin

• Make the change/patch required and record the diff to a file. This diff should be saved with the plugin, so that if we update the plugin to a newer version we can either re-apply the patch, or if it's been fixed upstream move back to the un-patched version.

• Edit patched-plugins/plugin/composer.json (or add one if it doesn't exist, see further down for an example) to include a patched version number, and ensure the namespace is set to wp-patched-plugins/.

• Remove the original package

composer remove vendor/plugin
composer require wp-patched-plugins/plugin-name

• Add a composer.json into the directory, that should look like the following (note, if the plugin already has a composer.json you can just use that, just make sure you use the name from within their composer.json):

{
    "name": "wp-patched-plugins/plugin-name",
    "type": "wordpress-plugin",
    "require": {
        "composer/installers": "~1.0"
    },
    "version": "<plugin-version>"
}