Joomla! Documentation - User contributions [en]

Plugin

2008-07-31T12:55:13Z

Torkil: Changed the last of the links

[[Category:Bin]]
====== Plugins ======
Joomla! plugins enable you to execute code in response to certain events, either Joomla! core events or custom events that are triggered from your own code. This is a powerful way of extending the basic Joomla! functionality. To see where plugins fit in with the overall Joomla! architecture, look at [[http://dev.joomla.org/content/view/1137/80/|Framework overview]].

The Joomla! plugin architecture follows the [[http://en.wikipedia.org/wiki/Observer_pattern|Observer]] design pattern. The [[references:joomla.framework:application:jplugin|JPlugin]] class is derived from [[references:joomla.framework:base:jobserver|JObserver]] and provides the means to register custom plugin code with core or custom events. The [[references:joomla.framework:application:jeventdispatcher|JEventDispatcher]] class, derived from [[references:joomla.framework:base:jobservable|JObservable]], is an event handler which calls all plugins registered for a particular event, when that event is triggered.

* [[plugins:create_plugin|How to create your own plugin]]
* [[plugins:using_plugins|How to use plugins in your own code]]
* [[plugins:plugins_part2|Creating an Authentication Plugin]]

Useful reference: [[http://codex.gallery2.org/index.php/Gallery2:Embedding:Event-Based_Loose-Coupled_Integration|Gallery 2: Embedding: Event-Based Loose-Coupled Integration]]

Prior to Joomla! 1.5 plugins were known as mambots. Mambots were able to change content only and were based on certain signal words. Since then their scope has been stretched and extended to such an extent that to enhance the meaning of the new functionality the developers decided to change the name from mambots to plugins. Joomla! 1.5 includes legacy support for Joomla! 1.0 mambots.

[[Category:Development]]
[[Category:Plugins]]
======Events======
Joomla! ships with a variety of core events, organised into groups. These are described in the following topics.

* [[Reference:System_Events_for_Plugin_System|System events]]
* [[Reference:User_Events_for_Plugin_System|User events]]
* [[Reference:Editor_Events_for_Plugin_System|Editor events]]
* [[Reference:Content Events for Plugin System|Content events]]

This is an alphabetical list of the core events in Joomla! 1.5 together with the group name to which each belongs. Each event name links to more detailed information.

*[[Reference:Content Events for Plugin System#onAfterContentSave|onAfterContentSave]] (content)
*[[Reference:User_Events_for_Plugin_System#onAfterDeleteUser|onAfterDeleteUser]] (user)
*[[Reference:Content Events for Plugin System#onAfterDisplay|onAfterDisplay]] (content)
*[[Reference:Content Events for Plugin System#onAfterDisplayTitle|onAfterDisplayTitle]] (content)
*[[Reference:Content Events for Plugin System#onAfterDisplayContent|onAfterDisplayContent]] (content)
*[[Reference:System_Events_for_Plugin_System#onAfterInitialise|onAfterInitialise]] (system)
*[[Reference:System_Events_for_Plugin_System#onAfterRoute|onAfterRoute]] (system)
*[[Reference:System_Events_for_Plugin_System#onAfterDispatch|onAfterDispatch]] (system)
*[[Reference:System_Events_for_Plugin_System#onAfterRender|onAfterRender]] (system)
*[[Reference:User_Events_for_Plugin_System#onAfterStoreUser|onAfterStoreUser]] (user)
*[[Reference:User_Events_for_Plugin_System#onAuthenticate|onAuthenticate]] (authentication)
*[[Reference:User_Events_for_Plugin_System#onAuthenticateFailure|onAuthenticateFailure]] (authentication)
*[[Reference:Content Events for Plugin System#onBeforeContentSave|onBeforeContentSave]] (content)
*[[Reference:User_Events_for_Plugin_System#onBeforeDeleteUser|onBeforeDeleteUser]] (user)
*[[Reference:Content Events for Plugin System#onBeforeDisplay|onBeforeDisplay]] (content)
*[[Reference:Content Events for Plugin System#onBeforeDisplayContent|onBeforeDisplayContent]] (content)
*[[Reference:User_Events_for_Plugin_System#onBeforeStoreUser|onBeforeStoreUser]] (user)
*[[Reference:Editor_Events_for_Plugin_System#onCustomEditorButton|onCustomEditorButton]] (editors-xtd)
*[[Reference:Editor_Events_for_Plugin_System#onDisplay|onDisplay]] (editors)
*[[Reference:Editor_Events_for_Plugin_System#onGetContent|onGetContent]] (editors)
*[[Reference:Editor_Events_for_Plugin_System#onGetInsertMethod|onGetInsertMethod]] (editors)
*[[Reference:System_Events_for_Plugin_System#onGetWebServices|onGetWebServices]] (xmlrpc)
*[[Reference:Editor_Events_for_Plugin_System#onInit|onInit]] (editors)
*[[Reference:User_Events_for_Plugin_System#onLoginUser|onLoginUser]] (user)
*[[Reference:User_Events_for_Plugin_System#onLogoutUser|onLogoutUser]] (user)
*[[Reference:Content Events for Plugin System#onPrepareContent|onPrepareContent]] (content)
*[[Reference:Editor_Events_for_Plugin_System#onSave|onSave]] (editors)
*[[Reference:System_Events_for_Plugin_System#onSearch|onSearch]] (search)
*[[Reference:System_Events_for_Plugin_System#onSearchAreas|onSearchAreas]] (search)
*[[Reference:Editor_Events_for_Plugin_System#onSetContent|onSetContent]] (editors)

J1.5:Plugin/Events/User

2008-07-31T12:53:58Z

Torkil: Tutorial:User Events for Plugin System moved to Reference:User Events for Plugin System: Renaming page to the same naming convention as the other plugin type references.

[[Category:Development]]
[[Category:Plugins]]
====5.3 User Events for Plugin System====

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
==5.3.2.1 Description==
This event is triggered after the user is authenticated against the Joomla! user-base.
If one plugin returns false, the entire authentication process fails.
==5.3.2.2 Parameters==
Two parameters: credentials, and remember.\\
Credentials is an array with this structure:\\
['username']\\
['password']\\
Remember is a boolean, set to true if the login needs to be remembered by the application.
==5.3.2.3 Return Value==
Boolean
==5.3.2.4 Used in files==
*libraries/joomla/application/application.php
*plugins/user/joomla.php
==5.3.2.5 Examples==
*plugins/user/example.php

===5.3.3 onLogoutUser===
==5.3.3.1 Description==
This event is triggered before the user is logged out of the system. If one plugin
returns false, the global logout fails.
==5.3.3.2 Parameters==
Array of credentials. Structure:\\
['username']\\
['id']\\
==5.3.3.3 Return Value==
Boolean
==5.3.3.4 Used in files==
*libraries/joomla/application/application.php
*plugins/user/joomla.php
==5.3.3.5 Examples==
*plugins/user/example.php

===5.3.4 onAuthenticate===
==5.3.4.1 Description==
This event is triggered to verify that a set of login credentials is valid.
==5.3.4.2 Parameters==
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

==5.3.4.3 Return Value==
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
==5.3.4.4 Used in files==
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
==5.3.4.5 Examples==
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
==5.3.5.1 Description==
This event is triggered whenever a user authentication request is failed by any plugin.
==5.3.5.2 Parameters==
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
==5.3.5.3 Return Value==
Unknown. The return value appears to be ignored in any case.
==5.3.5.4 Used in files==
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
==5.3.6.1 Description==
This event is triggered before a new user is stored in the database.
==5.3.6.2 Parameters==
Two parameters:
*An associative array of the columns in the user table.
*A unique identifier for this user.
==5.3.6.3 Return Value==
None
==5.3.6.4 Used in files==
*libraries/joomla/user/user.php
==5.3.6.5 Examples==
*plugins/user/example.php

===5.3.7 onAfterStoreUser===
==5.3.7.1 Description==
This event is triggered after a new user has been stored in the database.
==5.3.7.2 Parameters==
Two parameters:
*An associative array of the columns in the user table.
*A unique identifier for this user.
==5.3.7.3 Return Value==
None
==5.3.7.4 Used in files==
*libraries/joomla/user/user.php
==5.3.7.5 Examples==
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
==5.3.8.1 Description==
The event is triggered when a user is about to be deleted from the system.
==5.3.8.2 Parameters==
An associative array containing user information. Structure:\\
['id']\\
==5.3.8.3 Return Value==
None.
==5.3.8.4 Used in files==
*libraries/joomla/user/user.php
*plugins/user/joomla.php
==5.3.8.5 Examples==
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
==5.3.9.1 Description==
The event is triggered after a user has been deleted from the system.
==5.3.9.2 Parameters==
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
==5.3.9.3 Return Value==
None.
==5.3.9.4 Used in files==
*libraries/joomla/user/user.php
*plugins/user/joomla.php
==5.3.9.5 Examples==
*plugins/user/example.php

Plugin

2008-07-31T12:49:35Z

Torkil: Corrected more links

[[Category:Bin]]
====== Plugins ======
Joomla! plugins enable you to execute code in response to certain events, either Joomla! core events or custom events that are triggered from your own code. This is a powerful way of extending the basic Joomla! functionality. To see where plugins fit in with the overall Joomla! architecture, look at [[http://dev.joomla.org/content/view/1137/80/|Framework overview]].

The Joomla! plugin architecture follows the [[http://en.wikipedia.org/wiki/Observer_pattern|Observer]] design pattern. The [[references:joomla.framework:application:jplugin|JPlugin]] class is derived from [[references:joomla.framework:base:jobserver|JObserver]] and provides the means to register custom plugin code with core or custom events. The [[references:joomla.framework:application:jeventdispatcher|JEventDispatcher]] class, derived from [[references:joomla.framework:base:jobservable|JObservable]], is an event handler which calls all plugins registered for a particular event, when that event is triggered.

* [[plugins:create_plugin|How to create your own plugin]]
* [[plugins:using_plugins|How to use plugins in your own code]]
* [[plugins:plugins_part2|Creating an Authentication Plugin]]

Useful reference: [[http://codex.gallery2.org/index.php/Gallery2:Embedding:Event-Based_Loose-Coupled_Integration|Gallery 2: Embedding: Event-Based Loose-Coupled Integration]]

Prior to Joomla! 1.5 plugins were known as mambots. Mambots were able to change content only and were based on certain signal words. Since then their scope has been stretched and extended to such an extent that to enhance the meaning of the new functionality the developers decided to change the name from mambots to plugins. Joomla! 1.5 includes legacy support for Joomla! 1.0 mambots.

[[Category:Development]]
[[Category:Plugins]]
======Events======
Joomla! ships with a variety of core events, organised into groups. These are described in the following topics.

* [[Reference:System_Events_for_Plugin_System|System events]]
* [[plugins:user_events|User events]]
* [[Reference:Editor_Events_for_Plugin_System|Editor events]]
* [[Reference:Content Events for Plugin System|Content events]]

This is an alphabetical list of the core events in Joomla! 1.5 together with the group name to which each belongs. Each event name links to more detailed information.

*[[Reference:Content Events for Plugin System#onAfterContentSave|onAfterContentSave]] (content)
*[[plugins:user_events#onAfterDeleteUser|onAfterDeleteUser]] (user)
*[[Reference:Content Events for Plugin System#onAfterDisplay|onAfterDisplay]] (content)
*[[Reference:Content Events for Plugin System#onAfterDisplayTitle|onAfterDisplayTitle]] (content)
*[[Reference:Content Events for Plugin System#onAfterDisplayContent|onAfterDisplayContent]] (content)
*[[Reference:System_Events_for_Plugin_System#onAfterInitialise|onAfterInitialise]] (system)
*[[Reference:System_Events_for_Plugin_System#onAfterRoute|onAfterRoute]] (system)
*[[Reference:System_Events_for_Plugin_System#onAfterDispatch|onAfterDispatch]] (system)
*[[Reference:System_Events_for_Plugin_System#onAfterRender|onAfterRender]] (system)
*[[plugins:user_events#onAfterStoreUser|onAfterStoreUser]] (user)
*[[plugins:user_events#onAuthenticate|onAuthenticate]] (authentication)
*[[plugins:user_events#onAuthenticateFailure|onAuthenticateFailure]] (authentication)
*[[Reference:Content Events for Plugin System#onBeforeContentSave|onBeforeContentSave]] (content)
*[[plugins:user_events#onBeforeDeleteUser|onBeforeDeleteUser]] (user)
*[[Reference:Content Events for Plugin System#onBeforeDisplay|onBeforeDisplay]] (content)
*[[Reference:Content Events for Plugin System#onBeforeDisplayContent|onBeforeDisplayContent]] (content)
*[[plugins:user_events#onBeforeStoreUser|onBeforeStoreUser]] (user)
*[[Reference:Editor_Events_for_Plugin_System#onCustomEditorButton|onCustomEditorButton]] (editors-xtd)
*[[Reference:Editor_Events_for_Plugin_System#onDisplay|onDisplay]] (editors)
*[[Reference:Editor_Events_for_Plugin_System#onGetContent|onGetContent]] (editors)
*[[Reference:Editor_Events_for_Plugin_System#onGetInsertMethod|onGetInsertMethod]] (editors)
*[[Reference:System_Events_for_Plugin_System#onGetWebServices|onGetWebServices]] (xmlrpc)
*[[Reference:Editor_Events_for_Plugin_System#onInit|onInit]] (editors)
*[[plugins:user_events#onLoginUser|onLoginUser]] (user)
*[[plugins:user_events#onLogoutUser|onLogoutUser]] (user)
*[[Reference:Content Events for Plugin System#onPrepareContent|onPrepareContent]] (content)
*[[Reference:Editor_Events_for_Plugin_System#onSave|onSave]] (editors)
*[[Reference:System_Events_for_Plugin_System#onSearch|onSearch]] (search)
*[[Reference:System_Events_for_Plugin_System#onSearchAreas|onSearchAreas]] (search)
*[[Reference:Editor_Events_for_Plugin_System#onSetContent|onSetContent]] (editors)

Plugin

2008-07-31T12:48:27Z

Torkil: Corrected more links

[[Category:Bin]]
====== Plugins ======
Joomla! plugins enable you to execute code in response to certain events, either Joomla! core events or custom events that are triggered from your own code. This is a powerful way of extending the basic Joomla! functionality. To see where plugins fit in with the overall Joomla! architecture, look at [[http://dev.joomla.org/content/view/1137/80/|Framework overview]].

The Joomla! plugin architecture follows the [[http://en.wikipedia.org/wiki/Observer_pattern|Observer]] design pattern. The [[references:joomla.framework:application:jplugin|JPlugin]] class is derived from [[references:joomla.framework:base:jobserver|JObserver]] and provides the means to register custom plugin code with core or custom events. The [[references:joomla.framework:application:jeventdispatcher|JEventDispatcher]] class, derived from [[references:joomla.framework:base:jobservable|JObservable]], is an event handler which calls all plugins registered for a particular event, when that event is triggered.

* [[plugins:create_plugin|How to create your own plugin]]
* [[plugins:using_plugins|How to use plugins in your own code]]
* [[plugins:plugins_part2|Creating an Authentication Plugin]]

Useful reference: [[http://codex.gallery2.org/index.php/Gallery2:Embedding:Event-Based_Loose-Coupled_Integration|Gallery 2: Embedding: Event-Based Loose-Coupled Integration]]

Prior to Joomla! 1.5 plugins were known as mambots. Mambots were able to change content only and were based on certain signal words. Since then their scope has been stretched and extended to such an extent that to enhance the meaning of the new functionality the developers decided to change the name from mambots to plugins. Joomla! 1.5 includes legacy support for Joomla! 1.0 mambots.

[[Category:Development]]
[[Category:Plugins]]
======Events======
Joomla! ships with a variety of core events, organised into groups. These are described in the following topics.

* [[plugins:system_events|System events]]
* [[plugins:user_events|User events]]
* [[Reference:Editor_Events_for_Plugin_System|Editor events]]
* [[Reference:Content Events for Plugin System|Content events]]

This is an alphabetical list of the core events in Joomla! 1.5 together with the group name to which each belongs. Each event name links to more detailed information.

*[[Reference:Content Events for Plugin System#onAfterContentSave|onAfterContentSave]] (content)
*[[plugins:user_events#onAfterDeleteUser|onAfterDeleteUser]] (user)
*[[Reference:Content Events for Plugin System#onAfterDisplay|onAfterDisplay]] (content)
*[[Reference:Content Events for Plugin System#onAfterDisplayTitle|onAfterDisplayTitle]] (content)
*[[Reference:Content Events for Plugin System#onAfterDisplayContent|onAfterDisplayContent]] (content)
*[[plugins:system_events#onAfterInitialise|onAfterInitialise]] (system)
*[[plugins:system_events#onAfterRoute|onAfterRoute]] (system)
*[[plugins:system_events#onAfterDispatch|onAfterDispatch]] (system)
*[[plugins:system_events#onAfterRender|onAfterRender]] (system)
*[[plugins:user_events#onAfterStoreUser|onAfterStoreUser]] (user)
*[[plugins:user_events#onAuthenticate|onAuthenticate]] (authentication)
*[[plugins:user_events#onAuthenticateFailure|onAuthenticateFailure]] (authentication)
*[[Reference:Content Events for Plugin System#onBeforeContentSave|onBeforeContentSave]] (content)
*[[plugins:user_events#onBeforeDeleteUser|onBeforeDeleteUser]] (user)
*[[Reference:Content Events for Plugin System#onBeforeDisplay|onBeforeDisplay]] (content)
*[[Reference:Content Events for Plugin System#onBeforeDisplayContent|onBeforeDisplayContent]] (content)
*[[plugins:user_events#onBeforeStoreUser|onBeforeStoreUser]] (user)
*[[Reference:Editor_Events_for_Plugin_System#onCustomEditorButton|onCustomEditorButton]] (editors-xtd)
*[[Reference:Editor_Events_for_Plugin_System#onDisplay|onDisplay]] (editors)
*[[Reference:Editor_Events_for_Plugin_System#onGetContent|onGetContent]] (editors)
*[[Reference:Editor_Events_for_Plugin_System#onGetInsertMethod|onGetInsertMethod]] (editors)
*[[plugins:system_events#onGetWebServices|onGetWebServices]] (xmlrpc)
*[[Reference:Editor_Events_for_Plugin_System#onInit|onInit]] (editors)
*[[plugins:user_events#onLoginUser|onLoginUser]] (user)
*[[plugins:user_events#onLogoutUser|onLogoutUser]] (user)
*[[Reference:Content Events for Plugin System#onPrepareContent|onPrepareContent]] (content)
*[[Reference:Editor_Events_for_Plugin_System#onSave|onSave]] (editors)
*[[plugins:system_events#onSearch|onSearch]] (search)
*[[plugins:system_events#onSearchAreas|onSearchAreas]] (search)
*[[Reference:Editor_Events_for_Plugin_System#onSetContent|onSetContent]] (editors)

Plugin

2008-07-31T12:45:35Z

Torkil: Corrected links to point to Reference pages

[[Category:Bin]]
====== Plugins ======
Joomla! plugins enable you to execute code in response to certain events, either Joomla! core events or custom events that are triggered from your own code. This is a powerful way of extending the basic Joomla! functionality. To see where plugins fit in with the overall Joomla! architecture, look at [[http://dev.joomla.org/content/view/1137/80/|Framework overview]].

The Joomla! plugin architecture follows the [[http://en.wikipedia.org/wiki/Observer_pattern|Observer]] design pattern. The [[references:joomla.framework:application:jplugin|JPlugin]] class is derived from [[references:joomla.framework:base:jobserver|JObserver]] and provides the means to register custom plugin code with core or custom events. The [[references:joomla.framework:application:jeventdispatcher|JEventDispatcher]] class, derived from [[references:joomla.framework:base:jobservable|JObservable]], is an event handler which calls all plugins registered for a particular event, when that event is triggered.

* [[plugins:create_plugin|How to create your own plugin]]
* [[plugins:using_plugins|How to use plugins in your own code]]
* [[plugins:plugins_part2|Creating an Authentication Plugin]]

Useful reference: [[http://codex.gallery2.org/index.php/Gallery2:Embedding:Event-Based_Loose-Coupled_Integration|Gallery 2: Embedding: Event-Based Loose-Coupled Integration]]

Prior to Joomla! 1.5 plugins were known as mambots. Mambots were able to change content only and were based on certain signal words. Since then their scope has been stretched and extended to such an extent that to enhance the meaning of the new functionality the developers decided to change the name from mambots to plugins. Joomla! 1.5 includes legacy support for Joomla! 1.0 mambots.

======Events======
Joomla! ships with a variety of core events, organised into groups. These are described in the following topics.

* [[plugins:system_events|System events]]
* [[plugins:user_events|User events]]
* [[plugins:editor_events|Editor events]]
* [[Reference:Content Events for Plugin System|Content events]]

This is an alphabetical list of the core events in Joomla! 1.5 together with the group name to which each belongs. Each event name links to more detailed information.

*[[Reference:Content Events for Plugin System#onAfterContentSave|onAfterContentSave]] (content)
*[[plugins:user_events#onAfterDeleteUser|onAfterDeleteUser]] (user)
*[[Reference:Content Events for Plugin System#onAfterDisplay|onAfterDisplay]] (content)
*[[Reference:Content Events for Plugin System#onAfterDisplayTitle|onAfterDisplayTitle]] (content)
*[[Reference:Content Events for Plugin System#onAfterDisplayContent|onAfterDisplayContent]] (content)
*[[plugins:system_events#onAfterInitialise|onAfterInitialise]] (system)
*[[plugins:system_events#onAfterRoute|onAfterRoute]] (system)
*[[plugins:system_events#onAfterDispatch|onAfterDispatch]] (system)
*[[plugins:system_events#onAfterRender|onAfterRender]] (system)
*[[plugins:user_events#onAfterStoreUser|onAfterStoreUser]] (user)
*[[plugins:user_events#onAuthenticate|onAuthenticate]] (authentication)
*[[plugins:user_events#onAuthenticateFailure|onAuthenticateFailure]] (authentication)
*[[Reference:Content Events for Plugin System#onBeforeContentSave|onBeforeContentSave]] (content)
*[[plugins:user_events#onBeforeDeleteUser|onBeforeDeleteUser]] (user)
*[[Reference:Content Events for Plugin System#onBeforeDisplay|onBeforeDisplay]] (content)
*[[Reference:Content Events for Plugin System#onBeforeDisplayContent|onBeforeDisplayContent]] (content)
*[[plugins:user_events#onBeforeStoreUser|onBeforeStoreUser]] (user)
*[[plugins:editor_events#onCustomEditorButton|onCustomEditorButton]] (editors-xtd)
*[[plugins:editor_events#onDisplay|onDisplay]] (editors)
*[[plugins:editor_events#onGetContent|onGetContent]] (editors)
*[[plugins:editor_events#onGetInsertMethod|onGetInsertMethod]] (editors)
*[[plugins:system_events#onGetWebServices|onGetWebServices]] (xmlrpc)
*[[plugins:editor_events#onInit|onInit]] (editors)
*[[plugins:user_events#onLoginUser|onLoginUser]] (user)
*[[plugins:user_events#onLogoutUser|onLogoutUser]] (user)
*[[Reference:Content Events for Plugin System#onPrepareContent|onPrepareContent]] (content)
*[[plugins:editor_events#onSave|onSave]] (editors)
*[[plugins:system_events#onSearch|onSearch]] (search)
*[[plugins:system_events#onSearchAreas|onSearchAreas]] (search)
*[[plugins:editor_events#onSetContent|onSetContent]] (editors)

Plugins:content events

2008-07-31T12:43:45Z

Torkil: Redirecting to Reference:Content Events for Plugin System

#REDIRECT [[Reference:Content_Events_for_Plugin_System]]

J1.5:Plugin/Events/Content

2008-07-31T12:39:14Z

Torkil:

{{incomplete}}
[[Category:Development]]
[[Category:Plugins]]
====5.5 Content Events for Plugin System====
===5.5.1 Overview===
Content events are triggered during the content creation process. This may occur
in views in the com_content component, or in other components or modules.

Note: This article does not yet describe the events onBeforeContentSave and onAfterContentSave that were added in [http://www.joomla.org/content/view/5180/1/1/1/#Content_Trigger_Additions Joomla 1.5.4]

===5.5.2 onBeforeDisplay===
==5.5.2.1 Description==
This event is triggered when the framework is ready to create content. When this event
triggers, all features that can affect the presentation format are loaded.
==5.5.2.2 Parameters==
None.
==5.5.2.3 Return Value==
None.
==5.5.2.4 Used in files==
*index.php
*administrator/index.php
*components/com_content/views/article/view.html.php
*components/com_content/views/category/view.html.php
*components/com_content/views/frontpage/view.html.php
*components/com_content/views/section/view.html.php
*modules/mod_newsflash/helper.php
*plugins/content/pagenavigation.php
*plugins/content/vote.php

===5.5.3 onAfterDisplay===
==5.5.3.1 Description==
This event is triggered when the framework has finished creating content.
==5.5.3.2 Parameters==
None.
==5.5.3.3 Return Value==
None.
==5.5.3.4 Used in files==
*index.php
*administrator/index.php
*components/com_content/views/article/view.html.php
*components/com_content/views/category/view.html.php
*components/com_content/views/frontpage/view.html.php
*components/com_content/views/section/view.html.php
*modules/mod_newsflash/helper.php

===5.5.4 onPrepareContent===
==5.5.4.1 Description==
This is the first stage in preparing content for output and is the most common point
for content orientated plugins to do their work. Since the article and related parameters
are passed by reference, event handlers can modify them prior to display.
==5.5.4.2 Parameters==
*article A reference to the article that is being rendered by the view.
*params A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.
*limitstart An integer that determines the "page" of the content that is to be generated. Note that in the context of views that might not generate HTML output, a page is a reasonably abstract concept that depends on the context.
==5.5.4.3 Return Value==
None. Results are returned by modifying the referenced arguments.
==5.5.4.4 Used in files==
*components/com_content/views/article/view.html.php
*components/com_content/views/article/view.pdf.php
*components/com_content/views/category/view.html.php
*components/com_content/views/frontpage/view.html.php
*components/com_content/views/section/view.html.php
*plugins/content/code.php
*plugins/content/emailcloak.php
*plugins/content/geshi.php
*plugins/content/image.php
*plugins/content/loadmodule.php
*plugins/content/pagebreak.php
*plugins/content/sef.php

===5.5.5 onAfterDisplayTitle===
==5.5.5.1 Description==
This is a request for information that should be placed between the content title and
the content body.
==5.5.5.2 Parameters==
See the onPrepareContent event for additional discussion of these parameters. Note that
unlike onPrepareContent, these parameters are passed by value.
*article The article that is being rendered by the view.
*params An associative array of relevant parameters.
*limitstart An integer that determines the "page" of the content that is to be generated.
==5.5.5.3 Return Value==
An array. In XHTML/HTML views, this is is an array of strings, each of which becomes a line in the output stream.
==5.5.5.4 Used in files==
*components/com_content/views/article/view.html.php
*components/com_content/views/category/view.html.php
*components/com_content/views/frontpage/view.html.php
*components/com_content/views/section/view.html.php
*modules/mod_newsflash/helper.php
==5.5.5.5 See Also==
*components/com_content/views/article/tmpl/default.php

===5.5.6 onBeforeDisplayContent===
==5.5.6.1 Description==
This is a request for information that should be placed immediately before the generated content. For views that generate XHTML/HTML, this might include the use of styles that are specified as part of the content or related parameters.
==5.5.6.2 Parameters==
See the onPrepareContent event for additional discussion of these parameters. Note that
unlike onPrepareContent, these parameters are passed by value.
*article The article that is being rendered by the view.
*params An associative array of relevant parameters.
*limitstart An integer that determines the "page" of the content that is to be generated.
==5.5.6.3 Return Value==
An array. In XHTML/HTML views, this is is an array of strings, each of which becomes a line in the output stream.
==5.5.6.4 Used in files==
*components/com_content/views/article/view.html.php
*components/com_content/views/category/view.html.php
*components/com_content/views/frontpage/view.html.php
*components/com_content/views/section/view.html.php
*modules/mod_newsflash/helper.php
==5.5.6.5 See Also==
*components/com_content/views/article/tmpl/default.php

===5.5.7 onAfterDisplayContent===
==5.5.7.1 Description==
This is a request for information that should be placed immediately after the generated content. For views that generate XHTML/HTML, this might include the closure of styles that are specified as part of the content or related parameters.
==5.5.7.2 Parameters==
See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.
*article The article that is being rendered by the view.
*params An associative array of relevant parameters.
*limitstart An integer that determines the "page" of the content that is to be generated.
==5.5.7.3 Return Value==
An array. In XHTML/HTML views, this is is an array of strings, each of which becomes a line in the output stream.
==5.5.7.4 Used in files==
*components/com_content/views/article/view.html.php
*components/com_content/views/category/view.html.php
*components/com_content/views/frontpage/view.html.php
*components/com_content/views/section/view.html.php
==5.5.7.5 See Also==
*components/com_content/views/article/tmpl/default.php

== Overskrift ==

J1.5:Plugin/Events/Content

2008-07-31T12:38:14Z

Torkil: /* 5.5.1 Overview */

[[Category:Development]]
[[Category:Plugins]]
====5.5 Content Events for Plugin System====
===5.5.1 Overview===
Content events are triggered during the content creation process. This may occur
in views in the com_content component, or in other components or modules.

Note: This article does not yet describe the events onBeforeContentSave and onAfterContentSave that were added in [http://www.joomla.org/content/view/5180/1/1/1/#Content_Trigger_Additions Joomla 1.5.4]

===5.5.2 onBeforeDisplay===
==5.5.2.1 Description==
This event is triggered when the framework is ready to create content. When this event
triggers, all features that can affect the presentation format are loaded.
==5.5.2.2 Parameters==
None.
==5.5.2.3 Return Value==
None.
==5.5.2.4 Used in files==
*index.php
*administrator/index.php
*components/com_content/views/article/view.html.php
*components/com_content/views/category/view.html.php
*components/com_content/views/frontpage/view.html.php
*components/com_content/views/section/view.html.php
*modules/mod_newsflash/helper.php
*plugins/content/pagenavigation.php
*plugins/content/vote.php

===5.5.3 onAfterDisplay===
==5.5.3.1 Description==
This event is triggered when the framework has finished creating content.
==5.5.3.2 Parameters==
None.
==5.5.3.3 Return Value==
None.
==5.5.3.4 Used in files==
*index.php
*administrator/index.php
*components/com_content/views/article/view.html.php
*components/com_content/views/category/view.html.php
*components/com_content/views/frontpage/view.html.php
*components/com_content/views/section/view.html.php
*modules/mod_newsflash/helper.php

===5.5.4 onPrepareContent===
==5.5.4.1 Description==
This is the first stage in preparing content for output and is the most common point
for content orientated plugins to do their work. Since the article and related parameters
are passed by reference, event handlers can modify them prior to display.
==5.5.4.2 Parameters==
*article A reference to the article that is being rendered by the view.
*params A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.
*limitstart An integer that determines the "page" of the content that is to be generated. Note that in the context of views that might not generate HTML output, a page is a reasonably abstract concept that depends on the context.
==5.5.4.3 Return Value==
None. Results are returned by modifying the referenced arguments.
==5.5.4.4 Used in files==
*components/com_content/views/article/view.html.php
*components/com_content/views/article/view.pdf.php
*components/com_content/views/category/view.html.php
*components/com_content/views/frontpage/view.html.php
*components/com_content/views/section/view.html.php
*plugins/content/code.php
*plugins/content/emailcloak.php
*plugins/content/geshi.php
*plugins/content/image.php
*plugins/content/loadmodule.php
*plugins/content/pagebreak.php
*plugins/content/sef.php

===5.5.5 onAfterDisplayTitle===
==5.5.5.1 Description==
This is a request for information that should be placed between the content title and
the content body.
==5.5.5.2 Parameters==
See the onPrepareContent event for additional discussion of these parameters. Note that
unlike onPrepareContent, these parameters are passed by value.
*article The article that is being rendered by the view.
*params An associative array of relevant parameters.
*limitstart An integer that determines the "page" of the content that is to be generated.
==5.5.5.3 Return Value==
An array. In XHTML/HTML views, this is is an array of strings, each of which becomes a line in the output stream.
==5.5.5.4 Used in files==
*components/com_content/views/article/view.html.php
*components/com_content/views/category/view.html.php
*components/com_content/views/frontpage/view.html.php
*components/com_content/views/section/view.html.php
*modules/mod_newsflash/helper.php
==5.5.5.5 See Also==
*components/com_content/views/article/tmpl/default.php

===5.5.6 onBeforeDisplayContent===
==5.5.6.1 Description==
This is a request for information that should be placed immediately before the generated content. For views that generate XHTML/HTML, this might include the use of styles that are specified as part of the content or related parameters.
==5.5.6.2 Parameters==
See the onPrepareContent event for additional discussion of these parameters. Note that
unlike onPrepareContent, these parameters are passed by value.
*article The article that is being rendered by the view.
*params An associative array of relevant parameters.
*limitstart An integer that determines the "page" of the content that is to be generated.
==5.5.6.3 Return Value==
An array. In XHTML/HTML views, this is is an array of strings, each of which becomes a line in the output stream.
==5.5.6.4 Used in files==
*components/com_content/views/article/view.html.php
*components/com_content/views/category/view.html.php
*components/com_content/views/frontpage/view.html.php
*components/com_content/views/section/view.html.php
*modules/mod_newsflash/helper.php
==5.5.6.5 See Also==
*components/com_content/views/article/tmpl/default.php

===5.5.7 onAfterDisplayContent===
==5.5.7.1 Description==
This is a request for information that should be placed immediately after the generated content. For views that generate XHTML/HTML, this might include the closure of styles that are specified as part of the content or related parameters.
==5.5.7.2 Parameters==
See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.
*article The article that is being rendered by the view.
*params An associative array of relevant parameters.
*limitstart An integer that determines the "page" of the content that is to be generated.
==5.5.7.3 Return Value==
An array. In XHTML/HTML views, this is is an array of strings, each of which becomes a line in the output stream.
==5.5.7.4 Used in files==
*components/com_content/views/article/view.html.php
*components/com_content/views/category/view.html.php
*components/com_content/views/frontpage/view.html.php
*components/com_content/views/section/view.html.php
==5.5.7.5 See Also==
*components/com_content/views/article/tmpl/default.php

Plugins:content events

2008-07-31T12:35:18Z

Torkil:

[[Category:Development]]
[[Category:Plugins]]
== Content events ==

=== Overview ===
For a more detailed overview go to [[Reference:Content_Events_for_Plugin_System]]

=== onAfterContentSave ===
This event was added in [http://www.joomla.org/content/view/5180/1/1/1/#Content_Trigger_Additions Joomla 1.5.4] and it is triggered after content is saved.

=== onAfterDisplayTitle ===

=== onAfterDisplayContent ===

=== onBeforeContentSave ===
This event was added in [http://www.joomla.org/content/view/5180/1/1/1/#Content_Trigger_Additions Joomla 1.5.4] and it is triggered before content is saved.

=== onBeforeDisplay ===

=== onBeforeDisplayContent ===

=== onPrepareContent ===

User:Torkil

2008-07-31T12:25:37Z

Torkil: New page: I'm Torkil, and I try to contribute here every now and then :) I am watching changes to this page, so you could leave me a message right here if you wanted to. Oh the magic of wikis.

I'm Torkil, and I try to contribute here every now and then :)

I am watching changes to this page, so you could leave me a message right here if you wanted to. Oh the magic of wikis.

Plugins:content events

2008-07-31T12:22:37Z

Torkil: Initial setup of this page, not much content here yet.

[[Category:Development]]
[[Category:Plugins]]
== Content events ==

=== Overview ===

=== onAfterContentSave ===
This event was added in [http://www.joomla.org/content/view/5180/1/1/1/#Content_Trigger_Additions Joomla 1.5.4] and it is triggered after content is saved.

=== onAfterDisplayTitle ===

=== onAfterDisplayContent ===

=== onBeforeContentSave ===
This event was added in [http://www.joomla.org/content/view/5180/1/1/1/#Content_Trigger_Additions Joomla 1.5.4] and it is triggered before content is saved.

=== onBeforeDisplay ===

=== onBeforeDisplayContent ===

=== onPrepareContent ===

J1.5:Plugin/Events/System

2008-07-31T12:09:09Z

Torkil: /* Overview */

[[Category:Development]]
[[Category:Plugins]]
===Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins, look [[plugins:create_plugin|here]].

This topic is aimed at "global" system events, including those triggered on every page load (onAfterInitialise, onAfterRoute, onAfterDispatch, onAfterRender), those supporting search within multiple plugins (onSearch, onSearchArea) and those supporting the presentation of web services (onGetWebServices). Visit [[Tutorial:Plugins|the plugins tutorial]] for a complete list over available core events.

=== onAfterInitialise ===
'''Description'''

This event is triggered after the framework has loaded and the applicaiton initialise method has been called.

'''Parameters'''

None.

'''Return Value'''

None.

'''Called in files'''

*index.php
*administrator/index.php

===onAfterRoute===
'''Description'''

This event is triggered after the framework has loaded and initialised and the router has route the client request.

Routing is the process of examining the request environment to determine which component should receive the request. This component optional parameters are then set in the request object to be processed when the application is being dispatched.

When this event triggers the router has parsed the route and pushed the request parameters into JRequest for retrieval by the application.

'''Parameters'''

None.

'''Return Value'''

None.

'''Used in files'''

* index.php
* administrator/index.php

===onAfterDispatch===
'''Description'''
This event is triggered after the framework has dispatched the application.

Dispatching is the process of pulling the option from the request object and mapping them to a component. If the component do not exist, it handles determining a default component to dispatch.

When this event is triggered the output of the component is available in the document buffer.

'''Parameters'''

None.

'''Return Value'''

None.

'''Used in files'''

* index.php
* administrator/index.php

===onAfterRender===
'''Description'''
This event is triggered after the framework has rendered the application.

Rendering is the process of pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the into the JResponse buffer.

When this event is triggered the output of the application is available in the response buffer.

'''Parameters'''

None.

'''Return Value'''

None.

'''Used in files'''

* index.php
* administrator/index.php

===onSearch===
'''Description'''

This event is triggered by a variety of search related operations. It is a request for a
plugin to return the result of a search request. The rows must return the following fields, which are used in a common display routine:

* href
* title
* section
* created
* text
* browsernav

'''Parameters'''

* The target search string.
* A string matching option (exact|any|all).
* A string ordering option (newest|oldest|popular|alpha|category)
* An array if restricted to areas, null if search all.

'''Return Value'''

Array of stdClass objects with members as described above.

'''Used in files'''

* administrator/components/com_statistics/admin.statistics.php
* components/com_search/search.php
* plugins/search/categories.php
* plugins/search/contacts.php
* plugins/search/content.php
* plugins/search/newsfeeds.php
* plugins/search/sections.php
* plugins/search/weblinks.php
* plugins/xmlrpc/joomla.php

===onSearchAreas===
'''Description'''

This appears to be a request for plugins to identify which "areas" they provide
search facilities for.

'''Parameters'''

None.

'''Return Value'''

An associative array of area names, indexed by the area identifier. For example, array( 'categories' => 'Categories' ).

'''Used in files'''

* components/com_search/search.php
* plugins/search/categories.php
* plugins/search/contacts.php
* plugins/search/content.php
* plugins/search/newsfeeds.php
* plugins/search/sections.php
* plugins/search/weblinks.php

===onGetWebServices===

'''Description'''

This is an introspection request for plugins that provide web services.

'''Parameters'''

None.

'''Return Value'''

An array of associative arrays. The outer array is indexed by the service method name and
contains an array with the following elements:

* ['function'] The method to be invoked, typically a string like 'ClassName::staticMethod'
* ['docstring'] A human-readable definition of the method's purpose.
* ['signature'] An array identifying the types of the method's parameters. See the global variables $xmlrpc* for more information.

'''Used in files'''

* plugins/xmlrpc/blogger.php
* plugins/xmlrpc/joomla.php
* xmlrpc/index.php

===Example===

This is an example system plugin. Please note that because system plugins are loaded before any other event group, they may also contain any other event.

The following class would be located in the file <code>/plugins/system/example.php</code>.

<pre><?php
// no direct access
defined( '_JEXEC' ) or die( 'Restricted access' );

jimport( 'joomla.plugin.plugin' );

/**
* Example system plugin
*/
class plgSystemExample extends JPlugin
{
/**
* Constructor
*
* For php4 compatability we must not use the __constructor as a constructor for plugins
* because func_get_args ( void ) returns a copy of all passed arguments NOT references.
* This causes problems with cross-referencing necessary for the observer design pattern.
*
* @access protected
* @param object $subject The object to observe
* @param array $config An array that holds the plugin configuration
* @since 1.0
*/
function plgSystemCache( &$subject, $config )
{
parent::__construct( $subject, $config );

// Do some extra initialisation in this constructor if required
}

/**
* Do something onAfterInitialise
*/
function onAfterInitialise()
{
}

/**
* Do something onAfterRoute
*/
function onAfterRoute()
{
}

/**
* Do something onAfterDispatch
*/
function onAfterDispatch()
{
}

/**
* Do something onAfterRender
*/
function onAfterRender()
{
}
}</pre>

The following XML document would be located in the file <code>/plugins/system/example.xml</code>.

<pre><?xml version="1.0" encoding="utf-8"?>
<install version="1.5" type="plugin" group="system">
<name>System - Example</name>
<author>Author</author>
<creationDate>Month 2008</creationDate>
<copyright>Copyright (C) 2008 Holder. All rights reserved.</copyright>
<license>GNU General Public License</license>
<authorEmail>email</authorEmail>
<authorUrl>url</authorUrl>
<version>1.0.1</version>
<description>An example system plugin</description>
<files>
<filename plugin="example">example.php</filename>
</files>
<params>
<param name="example"
type="text"
default=""
label="Example"
description="An example text parameter" />
</params>
</install></pre>

Plugin

2008-07-31T12:03:01Z

Torkil: Added onBeforeContentSave and onAfterContentSave to the list.

[[Category:Bin]]
====== Plugins ======
Joomla! plugins enable you to execute code in response to certain events, either Joomla! core events or custom events that are triggered from your own code. This is a powerful way of extending the basic Joomla! functionality. To see where plugins fit in with the overall Joomla! architecture, look at [[http://dev.joomla.org/content/view/1137/80/|Framework overview]].

The Joomla! plugin architecture follows the [[http://en.wikipedia.org/wiki/Observer_pattern|Observer]] design pattern. The [[references:joomla.framework:application:jplugin|JPlugin]] class is derived from [[references:joomla.framework:base:jobserver|JObserver]] and provides the means to register custom plugin code with core or custom events. The [[references:joomla.framework:application:jeventdispatcher|JEventDispatcher]] class, derived from [[references:joomla.framework:base:jobservable|JObservable]], is an event handler which calls all plugins registered for a particular event, when that event is triggered.

* [[plugins:create_plugin|How to create your own plugin]]
* [[plugins:using_plugins|How to use plugins in your own code]]
* [[plugins:plugins_part2|Creating an Authentication Plugin]]

Useful reference: [[http://codex.gallery2.org/index.php/Gallery2:Embedding:Event-Based_Loose-Coupled_Integration|Gallery 2: Embedding: Event-Based Loose-Coupled Integration]]

Prior to Joomla! 1.5 plugins were known as mambots. Mambots were able to change content only and were based on certain signal words. Since then their scope has been stretched and extended to such an extent that to enhance the meaning of the new functionality the developers decided to change the name from mambots to plugins. Joomla! 1.5 includes legacy support for Joomla! 1.0 mambots.

======Events======
Joomla! ships with a variety of core events, organised into groups. These are described in the following topics.

* [[plugins:system_events|System events]]
* [[plugins:user_events|User events]]
* [[plugins:editor_events|Editor events]]
* [[plugins:content_events|Content events]]

This is an alphabetical list of the core events in Joomla! 1.5 together with the group name to which each belongs. Each event name links to more detailed information.

*[[plugins:content_events#onAfterContentSave|onAfterContentSave]] (content)
*[[plugins:user_events#onAfterDeleteUser|onAfterDeleteUser]] (user)
*[[plugins:content_events#onAfterDisplay|onAfterDisplay]] (content)
*[[plugins:content_events#onAfterDisplayTitle|onAfterDisplayTitle]] (content)
*[[plugins:content_events#onAfterDisplayContent|onAfterDisplayContent]] (content)
*[[plugins:system_events#onAfterInitialise|onAfterInitialise]] (system)
*[[plugins:system_events#onAfterRoute|onAfterRoute]] (system)
*[[plugins:system_events#onAfterDispatch|onAfterDispatch]] (system)
*[[plugins:system_events#onAfterRender|onAfterRender]] (system)
*[[plugins:user_events#onAfterStoreUser|onAfterStoreUser]] (user)
*[[plugins:user_events#onAuthenticate|onAuthenticate]] (authentication)
*[[plugins:user_events#onAuthenticateFailure|onAuthenticateFailure]] (authentication)
*[[plugins:content_events#onBeforeContentSave|onBeforeContentSave]] (content)
*[[plugins:user_events#onBeforeDeleteUser|onBeforeDeleteUser]] (user)
*[[plugins:content_events#onBeforeDisplay|onBeforeDisplay]] (content)
*[[plugins:content_events#onBeforeDisplayContent|onBeforeDisplayContent]] (content)
*[[plugins:user_events#onBeforeStoreUser|onBeforeStoreUser]] (user)
*[[plugins:editor_events#onCustomEditorButton|onCustomEditorButton]] (editors-xtd)
*[[plugins:editor_events#onDisplay|onDisplay]] (editors)
*[[plugins:editor_events#onGetContent|onGetContent]] (editors)
*[[plugins:editor_events#onGetInsertMethod|onGetInsertMethod]] (editors)
*[[plugins:system_events#onGetWebServices|onGetWebServices]] (xmlrpc)
*[[plugins:editor_events#onInit|onInit]] (editors)
*[[plugins:user_events#onLoginUser|onLoginUser]] (user)
*[[plugins:user_events#onLogoutUser|onLogoutUser]] (user)
*[[plugins:content_events#onPrepareContent|onPrepareContent]] (content)
*[[plugins:editor_events#onSave|onSave]] (editors)
*[[plugins:system_events#onSearch|onSearch]] (search)
*[[plugins:system_events#onSearchAreas|onSearchAreas]] (search)
*[[plugins:editor_events#onSetContent|onSetContent]] (editors)