Actions

Difference between revisions of "Plugin/Events/Content"

From Joomla! Documentation

< Plugin‎ | Events
(onContentChangeState added)
(Description: Update description)
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
 
{{version/tutor|2.5,3.x|alt=1.5|altlink=J1.5:Plugin/Events/Content|alttitle=this guide for old event names!}}
 
{{version/tutor|2.5,3.x|alt=1.5|altlink=J1.5:Plugin/Events/Content|alttitle=this guide for old event names!}}
{{RightTOC}}
 
 
Content events are triggered during the content creation process. The majority of these events are called in many views many components and modules - they are generally not specific for the com_content component. This list gives a brief description of each event, what their parameters are, and some examples of their use in core plugins.
 
Content events are triggered during the content creation process. The majority of these events are called in many views many components and modules - they are generally not specific for the com_content component. This list gives a brief description of each event, what their parameters are, and some examples of their use in core plugins.
  
Line 22: Line 21:
 
==onContentAfterTitle==
 
==onContentAfterTitle==
 
===Description===
 
===Description===
This event only exists in Joomla {{JVer|3.x}}. This is a request for information that should be placed between the content title and the content body. Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose. This event is only called in com_content for use in handling the introtext in com_content.
+
This event only exists in Joomla {{JVer|3.x}}. This is a request for information that should be placed between the content title and the content body. Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose. Note this event has special purpose in com_content for use in handling the introtext.
  
 
===Parameters===
 
===Parameters===
Line 158: Line 157:
  
 
===Example===
 
===Example===
[https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#80 content/finder/finder.php]
+
[https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L80 content/finder/finder.php]
  
 
==onContentSearch==
 
==onContentSearch==

Revision as of 07:51, 30 August 2013

Content events are triggered during the content creation process. The majority of these events are called in many views many components and modules - they are generally not specific for the com_content component. This list gives a brief description of each event, what their parameters are, and some examples of their use in core plugins.

Contents

onContentPrepare

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.

Parameters

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
  • &article A reference to the article that is being rendered by the view (For example: the text of a com_content article can be found with $article->text).
  • &row A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.
  • &params A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.
  • page 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.

Return Value

None. Results are returned by modifying the referenced arguments. Sometimes a boolean might be returned to check for success or failure of the event.

Example

onContentAfterTitle

Description

This event only exists in Joomla Joomla 3.x. This is a request for information that should be placed between the content title and the content body. Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose. Note this event has special purpose in com_content for use in handling the introtext.

Parameters

See the onPrepareContent event for additional discussion of these parameters.

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
  • &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.

Return Value

String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.

onContentBeforeDisplay

Description

This is a request for information that should be placed immediately before the generated content. For views that generate HTML, this might include the use of styles that are specified as part of the content or related parameters. Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose.

Parameters

See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
  • &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.

Return Value

String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.

Example

onContentAfterDisplay

Description

This is a request for information that should be placed immediately after the generated content. For views that generate HTML, this might include the closure of styles that are specified as part of the content or related parameters. Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose.

Parameters

See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
  • &article The article that is being rendered by the view.
  • &params A JRegistry object of merged article and menu item params.
  • limitstart An integer that determines the "page" of the content that is to be generated.

Return Value

String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.

onContentBeforeSave

Description

This is an event that is called right before the content is saved into the database. You can abort the save by returning false. In the case of JModelLegacy for example the error will then be set by calling $this->setError($table->getError); to be displayed to user.

Parameters

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
  • article A reference to the JTableContent object that is being saved which holds the article data.
  • isNew A boolean which is set to true if the content is about to be created.

Return Value

Boolean. Result will affect the saving process. See description for details.

onContentAfterSave

Description

This is an event that is called after the content is saved into the database. Even though article object is passed by reference, changes will not be saved since storing data into database phase is past. An example use case would be redirecting user to the appropriate place after saving.

Parameters

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
  • article A reference to the JTableContent object that is being saved which holds the article data.
  • isNew A boolean which is set to true if the content is about to be created.

Return Value

None. Result will be omitted.

onContentPrepareForm

Description

Called before a JForm is rendered. It can be used to modify the JForm object in memory before rendering. For example, use JForm->loadFile() to add fields or JForm->removeField() to remove fields. Or use JForm->setFieldAttribute() or other JForm methods to modify fields for the form.

Parameters

  • form The JForm object to be displayed. Use the $form->getName() method to check whether this is the form you want to work with.
  • data An object containing the data for the form.

Return Value

  • boolean True if method succeeds.

Example

onContentPrepareData

Description

Called after the data for a JForm has been retrieved. It can be used to modify the data for a JForm object in memory before rendering. This is usually used in tandem with the onContentPrepareForm method - this event adds the data to the already altered JForm.

Parameters

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
  • data An object containing the data for the form.

Return Value

  • boolean True if method succeeds.

Example

onContentBeforeDelete

Description

This is an event that is called right before the content is deleted from the database. You can abort the delete by returning false. In the case of JModelLegacy for example the error will then be set by calling $this->setError($table->getError); to be displayed to user.

Parameters

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
  • data A reference to the JTableContent object that is being deleted which holds the article data.

Return Value

Boolean. Result will affect the saving process. See description for details.

Example

onContentAfterDelete

Description

This is an event that is called after the content is deleted from the database. An example use case would be redirecting user to the appropriate place after deleting.

Parameters

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
  • article A reference to the JTableContent object that has been deleted which holds the article data.

Return Value

None. Result will be omitted.

Example

content/finder/finder.php

onContentChangeState

Description

This is an event that is called after content has it's state change (e.g. Published to Unpublished).

Parameters

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
  • $pks An array of primary key ids of the content that has changed state.
  • $value The value of the state that the content has been changed to.

Return Value

None. Result will be omitted.

Example

content/finder/finder.php

onContentSearch

onContentSearchAreas