Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A hook based plugin system for Codeigniter 2.0+ that is very similar to the Wordpress hooks system.
PHP
branch: master

Merge pull request #4 from joni-lgz/master

Some errors and cleaning
latest commit c7c6b6d19b
@Vheissu authored

README.md

A hook based plugin system for Codeigniter 2.1+

Ever wanted to implement plugin functionality into your Codeigniter applications and have the ability to define hooks and add hooks to your plugins so users can control aspects of your application like Wordpress? That's where this library comes in. It's still heavily alpha, but should work. This is a complete from the ground up library that has been developed to give you the ability to define hooks including hooks with arguments.

How do I use this?

I'm glad you asked. If you are familiar with Wordpress action and filter hooks, then you'll be able to learn how to use this. Follow the below steps to start extending baby.

  • Download the files from this Github, then paste the folders into your root directory. Nothing should be overwritten (hopefully).
  • Autoload the library "plugins"
  • Start implementing your action points within your application using the do_action() function.
  • In your plugins make sure to utilise the add_action() to register callbacks to your plugin functions when do_action is called.
  • To active a plugin you simply go: activate_plugin('pluginname'); (the plugin name is the name of your plugin folder, lowercased and no spaces or characters).
  • To deactivated a plugin you simply go: deactive_plugin('pluginname'); (the plugin name is the name of your plugin folder, lowercased and no spaces or characters).
  • What next? Put the kettle on and kick the fuck back.

Example application

To see how the system works what better than an example application using a Markdown plugin I developed to show off the functionality of the library. It's located here: https://github.com/Vheissu/Ci-Plugin-System---Example-Plugin-and-Usage - there is also a Hello World application that does nothing included as well (completely free!).

FAQ's

  1. My grandma says that she doesn't understand how to use this library, where is the documentation?
    Documentation is coming shortly, it's in the process as we speak. Tell your grandma to shut up and stop running her mouth. Be warned however, it won't come in the form of Scrabble or checkers, so your grandma might find it hard to understand.

  2. I included it and I am getting lots of errors.
    You did something wrong or your server sucks or I am just in denial that there are any issues with this library. If you encounter an error and you're handy with PHP, feel free to submit a pull request.

  3. But Wordpress lets me do x, why can't this library do that?
    This is not Wordpress, if you have a request, then contact me about it. If something is missing you think a hook based plugin library should have, tell me. Speaking of which, have you seen the Wordpress code base? Wow, what a mess that is. It's like going to the toilet at a football game, shit and rubbish absolutely everywhere.

  4. Where can I get some unicorn blood? (for testing purposes of course)
    This is not a programming question, GTFO. Psst! send me an email, I can hook you up.

  5. I still don't get it. How do I use this damn library? AAAAAAAAAHHH
    THERE IS NO DOCUMENTATION. IF MY INSTRUCTIONS ARE NOT CLEAR ENOUGH, THEN QUIT PROGRAMMING OR I SHOULD QUIT IF I DIDN'T EXPLAIN SOMETHING PROPERLY. WHY AM I SHOUTING? MY CAPS LOCK KEY IS NOT BROKEN, SIR.

  6. My application is running really slowly, is this your fault?
    This is why we can't have nice things. This library will most likely not slow down your application. It works the same as Wordpress, only there is no caching at the moment of hook calls and plugin file includes (yet). So the answer is: no, it's your own fault. Although if you have 100's of plugins (which is nuts!), then yeah, you might get some slowdown. It would be like loading 2 tonnes of bricks into a Porsche, bye bye suspension.

Something went wrong with that request. Please try again.