\TriTan\Interfaces\PluginPluginActionFilterInterface

Register all actions and filters for the plugin.

Maintain a list of all hooks that are registered throughout the plugin, and register them with the TriTan CMS API. Call the run function to execute the list of actions and filters.

Summary

Methods

Constants

addAction()
addFilter()
add()
run()

No constants found

No protected methods found

N/A

No private methods found

N/A

File: src/Interfaces/Plugin/PluginActionFilterInterface.php
Package: \TriTan CMS

Tags

license	GPLv3
since
author	Joshua Parker joshmac3@icloud.com

Methods

addAction()

addAction(string  $hook, object  $component, string  $callback, integer  $priority = 10, integer  $accepted_args = 1)

Add a new action to the collection to be registered with TriTan CMS.

Parameters

string	$hook	The name of the TriTan CMS action that is being registered.
object	$component	A reference to the instance of the object on which the action is defined.
string	$callback	The name of the function definition on the $component.
integer	$priority	Optional. he priority at which the function should be fired. Default is 10.
integer	$accepted_args	Optional. The number of arguments that should be passed to the $callback. Default is 1.

Tags

since	0.9.9

addFilter()

addFilter(string  $hook, object  $component, string  $callback, integer  $priority = 10, integer  $accepted_args = 1)

Add a new filter to the collection to be registered with TriTan CMS.

Parameters

string	$hook	The name of the TriTan CMS filter that is being registered.
object	$component	A reference to the instance of the object on which the filter is defined.
string	$callback	The name of the function definition on the $component.
integer	$priority	Optional. he priority at which the function should be fired. Default is 10.
integer	$accepted_args	Optional. The number of arguments that should be passed to the $callback. Default is 1

Tags

since	0.9.9

add()

add(array  $hooks, string  $hook, object  $component, string  $callback, integer  $priority, integer  $accepted_args) : array

A utility function that is used to register the actions and hooks into a single collection.

Parameters

array	$hooks	The collection of hooks that is being registered (that is, actions or filters).
string	$hook	The name of the TriTan CMS filter that is being registered.
object	$component	A reference to the instance of the object on which the filter is defined.
string	$callback	The name of the function definition on the $component.
integer	$priority	The priority at which the function should be fired.
integer	$accepted_args	The number of arguments that should be passed to the $callback.

Returns

array —

The collection of actions and filters registered with TriTan CMS.

Tags

since	0.9.9

run()

run()

Register the filters and actions with TriTan CMS.

Tags

since	0.9.9