https://github.com/tyxla/php-plugin-api

Plugin API for managing actions and filters, hooking functions and consequently calling them.
https://github.com/tyxla/php-plugin-api

Last synced: about 1 month ago
JSON representation

Plugin API for managing actions and filters, hooking functions and consequently calling them.

• Host: GitHub
• URL: https://github.com/tyxla/php-plugin-api
• Owner: tyxla
• License: gpl-2.0
• Created: 2014-11-06T23:55:29.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-04-09T20:36:42.000Z (over 9 years ago)
• Last Synced: 2023-04-09T23:59:47.976Z (over 1 year ago)
• Language: PHP
• Size: 215 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
PHP Plugin API

==============

About

-----

This project provides a Plugin API for managing actions and filters, hooking functions and consequently calling them. 

It is based on the amazing plugin API system which is built into the award-winning WordPress platform.

The PHP Plugin API allows for creating actions and filters and hooking functions, class and object methods, as well as any other PHP callback. The functions or methods will then be run when the action or filter is called.

Since this library replicates the WordPress Plugin API, additional information about the plugin hooks (filters, actions) and their usage can be found here: [WordPress Plugin API](http://codex.wordpress.org/Plugin_API)

-----

Usage & Examples

-----

#### 1. Using filters - basic example

	// Define a variable.

	$title = 'Hello';

	// Add a filter function to the "custom_filter" filter.

	// This will take the current variable as a parameter and

	// will append ", World" to it, returning the changed value.

    // Note that we've used anonymous function for the second parameter, 

    // but you can use any callable value here. This gives you more control.

    Plugin_API::add_filter('custom_filter', function( $var ) {

    	return $var . ', World';

    });

    // Call the functions, hooked to the "custom_filter" filter

    // on the $title variable.

    $title = Plugin_API::apply_filters('custom_filter', $title);

    // The $title variable will now contain "Hello, World".

    echo $title;

-----

#### 2. Using actions - basic example

	// Add a function to the "custom_action" action.

    // Note that we've used anonymous function for the second parameter, 

    // but you can use any callable value here. This gives you more control.

    Plugin_API::add_filter('custom_action', function() {

    	echo 'Hello, World';

    });

    // Execute the "custom_action" action.

    // This will display "Hello, World.".

    Plugin_API::do_action('custom_action');