by Page no: P04
Table of contents
We will override a couple of plugins for our purposes:
- Twittily will become Tweet Automatically by E-llusion, that allows for multi-user tweeting
- We will extend the syndication plugin with some functionality for cutting post texts and changing URLs.
It is also called “functional plugin”. The following page comes from an important WordPress Gathering last year in Dayton. It explains functional plugins.
Idea:
The way we do it is called functional plugin or override an existing plugin.
Plugin Idea “Tweet Automatically by E-llusion”
We will use this new concept to translate the existing Twittily plugin into a “Tweet Automatically by E-llusion” plugin.
The principal ideas for a a functional plugin are:
- Create new plugin files that contains all our custom code, i.e. code that is not available in the old Tweetily plugin.
- Remove all our custom code from old Tweetily and put it into the new plugin
- Define clear interfaces/function calls to the new plugin either inside WordPress or inside the old Tweetily plugin.
- Override their callbacks
- Define custom hooks
- Communicate to the developer of Tweetily that we created a better plugin.
- (SEO relevant) Communicate to the WordPress community that we applied the functional plugin for a such important functionality like automatic Twitter posts.
Moreover, I will define some additional functionality like multi-user tweeting for our new plugin.
Video: WordCamp Dayton 2014.
The slides and our commentsOur comment: |
slide 2 |
| Our comment: | 
slide 3 |
| Our comment: | 
slide 4 |
| Our comment: | 
slide 5 |
slide 6 |
|
| Our comment: | 
slide 7 |
| Our comment: | 
slide 8 |
| Our comment: | 
slide 9 |
| Our comment: | 
slide 10 |
| Our comment: | 
slide 11 |
| Our comment: | 
slide 12 |
| Our comment: | 
slide 13 |
| Our comment: | 
slide 14 |
| Our comment: | 
slide 15 |
| Our comment: | 
slide 16 |
| Our comment: | 
slide 17 |
| Our comment: | 
slide 18 |
| Our comment: | 
slide 19 |
Examine problem to override the Social Auto Poster pluginUnfortunately, the SNAP plugin’s structure does not allow any overridings. The only problem is to take their code and improve it. Only plugins, which are build with idea of overriding can be overriding without breaking them.
|
The Right Way to Customize a WordPress Plugin
It’s very common for developers to customize and extend existing plugins to fit their own needs, which is one of the great advantages of using open-source software. They often do it by making their changes directly to the plugin, though, which creates a security vulnerability and becomes a maintenance hassle.
If you hack a plugin to make your changes, then you create a situation where, in order to upgrade, you have to go through an annoying process of manually diff’ing your version against the canonical one and then syncing them up in both directions. You could make it a little easier by using version control to create a patch against the canonical source, and then refresh it every time an update is released, but it’s still a pain, and developers rarely go to the trouble of doing that, so they miss out on security patches and new features.
Collaborate With the Developer
Before you try anything else, the first thing to do is to send a message to the developer of the plugin and let them know what kinds of changes you need, and offer to work with them to build them into the core plugin. If they’re open to it, then you can send them a patch with your changes. The great thing about this method is that everyone who uses the plugin will benefit from your work, and you’ll have contributed something back to the developer whose work you’ve benefited from.
The developer may not like the idea, though, or it may not line up with their vision for the plugin, so that won’t always work. There are still plenty of options, though.
Extend Without Modifying
The easiest situation is when you just want to add some new functionality to their plugin, but you don’t need to remove or modify anything that the plugin does. In this case, you can simply write a separate plugin that runs alongside the plugin you’re customizing.
You can see a real-world example of this by looking at the code for Google Authenticator – Encourage User Activation.
Using Custom Hooks
If you do need to change or remove functionality from the plugin, though, there’s a much better way that just hacking it, and it’s something you’re already familiar with: hooks.
Just like WordPress provides hooks to allow plugins to customize and extend it, plugins themselves can provide hooks to allow other plugins to customize them.
So, if you’re lucky, the plugin you want to extend was written by a developer who knew enough and cared enough to include custom hooks that will allow you to extend their plugin. If they did, then your job is pretty easy; you just need to write a separate plugin that runs alongside the plugin you’re customizing, and registers callbacks for the custom hooks that the plugin provides.
Unfortunately, most developers haven’t learned to add custom hooks yet, so you won’t always be able to rely on them. But even without them, there are still two more ways that you can customize the plugin that are better than just hacking it.
Overriding Their Callbacks
The plugin you want to customize integrated with WordPress by registering callback functions for Core hooks. So, you can simply remove their callbacks, and replace them with your own. Then inside your callbacks, you can call functions from the other plugin that you need in order to recreate the parts of their functionality that you want, and avoid the parts that you don’t.
If you’d like to study a real-world example of this method, check out Google Authenticator – Per User Prompt.
Sometimes overriding their hooks isn’t ideal, though, because their functions aren’t modular enough to allow you to call individual pieces that you need without also invoking the things you don’t want. Even in that situation, though, there’s still one more method you can fall back on that’s better than just hacking all your changes into the plugin.
Adding Custom Hooks
If it’d be too much work to replace their Core hook callbacks with your own, you could hack the plugin directly, but instead of putting all your changes into it, simply add the custom hooks that you need, and then put the rest of your functionality in a separate plugin.
Then, you can submit a patch to the plugin’s developer and ask them to include the custom hooks you need in the next release of the plugin. If they do, then you can freely upgrade to new releases and your custom plugin will run cleanly alongside theirs.
But even if they don’t, then you can still upgrade by manually patching your custom hooks into each new release. That’s not ideal, but it’s much better than having to patch in all of your changes, or just not upgrade at all.
15 Comments
Tags: functional plugin, Override plugin
See more for
Found this from the Child Plugins thread on WP Ideas.
I’ve been looking for some sort of functionality like a child plugin but have come to the realization, like you, that hooks and filters are the best way. That doesn’t solve the problem for the user end like you indicated. Woocommerce is a great example of a plugin that allows overrides. You can copy files from the plugin directory to a directory in your theme, and the plugin will use the theme file instead of the plugin file. They also have hooks and filters to make customization easy as well.
This is a good article, but I’m still convinced that an overriding feature, without modifying the original plugin, would be ideal, at least in the cases I’ve seen.
Is WooCommerce doing that for template files, or for any file in the plugin?
For template files, I agree that plugins should let them be overridden by the theme, and I have my plugin skeleton setup to do that. But for overriding the actual behavior of a plugin, I still think that hooks are the best way to go.
If a plugin allowed it’s regular files to be overriden (via something similar to locate_template()), then that could easily break when the plugin changes versions, etc. Another approach would be to make all functions “pluggable” like Core does with some things, but that’d be impractical for every function in a plugin. I think that being able to unhook specific functions and filter the results of others is the cleanest and most precise way to modify a plugin.
I think it would only be for template files for WC.
I agree with you that hooks and filters would be the way to go. Communicating with the developer seems like the best problem at this point, if there are none built in.
Hi Ian,
I have a question concerning customize WordPress plugins. I have a website that has 8-9 plugins that had been customized in the plugins folders. But now I can’t update those plugins since it will remove all the modified files in the plugins folder. Is there a faster way to find those code I had modified in the plugins folder and put them in the theme folder so that I can update the plugins periodically.
Thanks,
John
Hi John, the best way to find your modifications is with a diff tool like DeltaWalker (OS X) or WinMerge (Windows). It’ll let you compare the two folders side-by-side to see any differences.
I wouldn’t recommend putting your modifications in your theme, though; that’s a bad practice for many reasons. Instead, you can create a functionality plugin.
The Wordfence plugin can scan the plugin files and compare them to the WordPress plugin db and find the things that have changed.
Hello, Ian
Long thinking and reading information how integrate ability extends themes.
In result i create custom function, that receive params and include template file, but file path may be rewrited by apply_filters().
Then user can create plugin, add hook into “template file path”, and render it template.
I like that, it’s similar to something I’ve done before:
https://github.com/iandunn/WordPress-Plugin-Skeleton/blob/a7f1288cec836b5a10fc0c8485844b33787d0300/classes/wpps-module.php#L78
Hi Max, hi Ian!
Well, that’s similar to what I have done, as well:
https://github.com/hinnerk-a/wp-plugintheming/blob/master/parentplugin/classes/class-parentplugin-theme.php#L40
https://github.com/hinnerk-a/wp-plugintheming/blob/master/parentplugin/classes/class-parentplugin-theme.php#L153
A good method to put your theme path anywhere you want! I’ve extended it to loading functions files and CSS in a row instead of overriding the files.
Hi,
I have developed a child plugin problem that brings WooCommerce’s way of template overrides into separate plugins. Thus your overrides are save from being overwritten by theme updates. And they don’t have to be built-in like WooCommerce is in many themes. Additionally, my problem allows you to put the overrides into the theme’s directory, as well (like WooCommerce does in /shop/).
Those child plugins can also have special CSS loaded after the built-in CSS and a functions.php that is loaded before the parent plugin’s functions.php. Thus you can even override functions add action and filter hooks without putting them into the theme’s or the parent plugin’s directories.
My article: http://www.hinnerk-altenburg.de/weblog/child-plugins-for-wordpress-child-theme-for-plugins/
Installable example plugins: https://github.com/hinnerk-a/wp-plugintheming
I am looking forward to your feedback!
Thanks,
Hinnerk
how to customize the plugin in wordpress. please give me a code and suggest how to create plugin
Hi Sonkar, if you’re looking for help creating your first plugin, the WordPress Plugin Developer Handbook is a good place to start..