https://docs.sandbox.joomla.org/api.php?action=feedcontributions&feedformat=atom&user=Phproberto 2026-05-14T23:51:12Z User contributions MediaWiki 1.43.0 https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Content&diff=122323 2014-07-15T18:21:56Z

<p>Phproberto: /* Used in files */</p> <hr /> <div>{{version/tutor|2.5,3.x|alt=1.5|altlink=J1.5:Plugin/Events/Content|alttitle=this guide for old event names}}<br /> 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.<br /> <br /> ==onContentPrepare==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; 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-&gt;text).<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.<br /> *&lt;code&gt;page&lt;/code&gt; An integer that determines the &quot;page&quot; 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.<br /> <br /> ===Return Value===<br /> None. Results are returned by modifying the referenced arguments. Sometimes a boolean might be returned to check for success or failure of the event.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/emailcloak/emailcloak.php#L31 plugins/content/emailcloak/emailcloak.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterTitle==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/vote/vote.php#L29 plugins/content/vote/vote.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A JRegistry object of merged article and menu item params.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeSave==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ==onContentAfterSave==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ==onContentPrepareForm==<br /> ===Description===<br /> Called before a JForm is rendered. It can be used to modify the JForm object in memory before rendering. For example, use JForm-&gt;loadFile() to add fields or JForm-&gt;removeField() to remove fields. Or use JForm-&gt;setFieldAttribute() or other JForm methods to modify fields for the form.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;form&lt;/code&gt; The JForm object to be displayed. Use the $form-&gt;getName() method to check whether this is the form you want to work with.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L168 plugins/user/profile/profile.php]<br /> <br /> ==onContentPrepareData==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L51 plugins/user/profile/profile.php]<br /> <br /> ==onContentBeforeDelete==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; A reference to the JTableContent object that is being deleted which holds the article data.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/joomla/joomla.php#L89 plugins/content/joomla/joomla.php]<br /> <br /> ==onContentAfterDelete==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that has been deleted which holds the article data.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L61 content/finder/finder.php]<br /> <br /> ==onContentChangeState==<br /> ===Description===<br /> This is an event that is called after content has its state change (e.g. Published to Unpublished).<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;$pks&lt;/code&gt; An array of primary key ids of the content that has changed state.<br /> *&lt;code&gt;$value&lt;/code&gt; The value of the state that the content has been changed to.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L80 content/finder/finder.php]<br /> <br /> ==onContentSearch==<br /> ===Description===<br /> <br /> This event is triggered by a variety of search related operations. It is a request for a<br /> plugin to return the result of a search request. The rows must return the following fields, which are used in a common display routine:<br /> <br /> * browsernav<br /> * catslug<br /> * created<br /> * href<br /> * section<br /> * slug<br /> * text<br /> * title<br /> <br /> ===Parameters===<br /> <br /> * &lt;code&gt;$text&lt;/code&gt; The target search string.<br /> * &lt;code&gt;$phrase&lt;/code&gt; A string matching option (exact|any|all). Default is &quot;any&quot;.<br /> * &lt;code&gt;$ordering&lt;/code&gt; A string ordering option (newest|oldest|popular|alpha|category). Default is &quot;newest&quot;.<br /> * &lt;code&gt;$areas&lt;/code&gt; An array if restricted to areas, null if search all.<br /> <br /> ===Return Value===<br /> <br /> Array of stdClass objects with members as described above.<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/administrator/components/com_search/models/searches.php#L158 administrator/components/com_search/models/searches.php]&lt;/tt&gt;<br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/components/com_search/models/search.php#L154 components/com_search/models/search.php]&lt;/tt&gt;<br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/search/categories/categories.php#L62 plugins/search/categories/categories.php]&lt;/tt&gt;<br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/search/contacts/contacts.php#L60 plugins/search/contacts/contacts.php]&lt;/tt&gt;<br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/search/content/content.php#L53 plugins/search/content/content.php]&lt;/tt&gt;<br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/search/newsfeeds/newsfeeds.php#L60 plugins/search/newsfeeds/newsfeeds.php]&lt;/tt&gt;<br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/search/tags/tags.php#L60 plugins/search/tags/tags.php]&lt;/tt&gt;<br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/search/weblinks/weblinks.php#L62 plugins/search/weblinks/weblinks.php]&lt;/tt&gt;<br /> <br /> ==onContentSearchAreas==<br /> ===Description===<br /> <br /> This appears to be a request for plugins to identify which &quot;areas&quot; they provide<br /> search facilities for.<br /> <br /> ===Parameters===<br /> <br /> None.<br /> <br /> ===Return Value===<br /> <br /> An associative array of area names, indexed by the area identifier. For example, array( 'categories' =&gt; 'Categories' ).<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;components/com_search/models/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Content&diff=122322 2014-07-15T18:15:29Z

<p>Phproberto: /* Used in files */</p> <hr /> <div>{{version/tutor|2.5,3.x|alt=1.5|altlink=J1.5:Plugin/Events/Content|alttitle=this guide for old event names}}<br /> 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.<br /> <br /> ==onContentPrepare==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; 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-&gt;text).<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.<br /> *&lt;code&gt;page&lt;/code&gt; An integer that determines the &quot;page&quot; 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.<br /> <br /> ===Return Value===<br /> None. Results are returned by modifying the referenced arguments. Sometimes a boolean might be returned to check for success or failure of the event.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/emailcloak/emailcloak.php#L31 plugins/content/emailcloak/emailcloak.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterTitle==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/vote/vote.php#L29 plugins/content/vote/vote.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A JRegistry object of merged article and menu item params.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeSave==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ==onContentAfterSave==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ==onContentPrepareForm==<br /> ===Description===<br /> Called before a JForm is rendered. It can be used to modify the JForm object in memory before rendering. For example, use JForm-&gt;loadFile() to add fields or JForm-&gt;removeField() to remove fields. Or use JForm-&gt;setFieldAttribute() or other JForm methods to modify fields for the form.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;form&lt;/code&gt; The JForm object to be displayed. Use the $form-&gt;getName() method to check whether this is the form you want to work with.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L168 plugins/user/profile/profile.php]<br /> <br /> ==onContentPrepareData==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L51 plugins/user/profile/profile.php]<br /> <br /> ==onContentBeforeDelete==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; A reference to the JTableContent object that is being deleted which holds the article data.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/joomla/joomla.php#L89 plugins/content/joomla/joomla.php]<br /> <br /> ==onContentAfterDelete==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that has been deleted which holds the article data.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L61 content/finder/finder.php]<br /> <br /> ==onContentChangeState==<br /> ===Description===<br /> This is an event that is called after content has its state change (e.g. Published to Unpublished).<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;$pks&lt;/code&gt; An array of primary key ids of the content that has changed state.<br /> *&lt;code&gt;$value&lt;/code&gt; The value of the state that the content has been changed to.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L80 content/finder/finder.php]<br /> <br /> ==onContentSearch==<br /> ===Description===<br /> <br /> This event is triggered by a variety of search related operations. It is a request for a<br /> plugin to return the result of a search request. The rows must return the following fields, which are used in a common display routine:<br /> <br /> * browsernav<br /> * catslug<br /> * created<br /> * href<br /> * section<br /> * slug<br /> * text<br /> * title<br /> <br /> ===Parameters===<br /> <br /> * &lt;code&gt;$text&lt;/code&gt; The target search string.<br /> * &lt;code&gt;$phrase&lt;/code&gt; A string matching option (exact|any|all). Default is &quot;any&quot;.<br /> * &lt;code&gt;$ordering&lt;/code&gt; A string ordering option (newest|oldest|popular|alpha|category). Default is &quot;newest&quot;.<br /> * &lt;code&gt;$areas&lt;/code&gt; An array if restricted to areas, null if search all.<br /> <br /> ===Return Value===<br /> <br /> Array of stdClass objects with members as described above.<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/administrator/components/com_search/models/searches.php#L158 administrator/components/com_search/models/searches.php]&lt;/tt&gt;<br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/components/com_search/models/search.php#L154 components/com_search/models/search.php]&lt;/tt&gt;<br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/search/categories/categories.php#L62 plugins/search/categories/categories.php]&lt;/tt&gt;<br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/search/contacts/contacts.php#L60 plugins/search/contacts/contacts.php]&lt;/tt&gt;<br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/search/content/content.php#L53 plugins/search/content/content.php]&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> ==onContentSearchAreas==<br /> ===Description===<br /> <br /> This appears to be a request for plugins to identify which &quot;areas&quot; they provide<br /> search facilities for.<br /> <br /> ===Parameters===<br /> <br /> None.<br /> <br /> ===Return Value===<br /> <br /> An associative array of area names, indexed by the area identifier. For example, array( 'categories' =&gt; 'Categories' ).<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;components/com_search/models/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Content&diff=122321 2014-07-15T18:13:22Z

<p>Phproberto: /* Used in files */</p> <hr /> <div>{{version/tutor|2.5,3.x|alt=1.5|altlink=J1.5:Plugin/Events/Content|alttitle=this guide for old event names}}<br /> 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.<br /> <br /> ==onContentPrepare==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; 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-&gt;text).<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.<br /> *&lt;code&gt;page&lt;/code&gt; An integer that determines the &quot;page&quot; 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.<br /> <br /> ===Return Value===<br /> None. Results are returned by modifying the referenced arguments. Sometimes a boolean might be returned to check for success or failure of the event.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/emailcloak/emailcloak.php#L31 plugins/content/emailcloak/emailcloak.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterTitle==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/vote/vote.php#L29 plugins/content/vote/vote.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A JRegistry object of merged article and menu item params.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeSave==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ==onContentAfterSave==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ==onContentPrepareForm==<br /> ===Description===<br /> Called before a JForm is rendered. It can be used to modify the JForm object in memory before rendering. For example, use JForm-&gt;loadFile() to add fields or JForm-&gt;removeField() to remove fields. Or use JForm-&gt;setFieldAttribute() or other JForm methods to modify fields for the form.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;form&lt;/code&gt; The JForm object to be displayed. Use the $form-&gt;getName() method to check whether this is the form you want to work with.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L168 plugins/user/profile/profile.php]<br /> <br /> ==onContentPrepareData==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L51 plugins/user/profile/profile.php]<br /> <br /> ==onContentBeforeDelete==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; A reference to the JTableContent object that is being deleted which holds the article data.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/joomla/joomla.php#L89 plugins/content/joomla/joomla.php]<br /> <br /> ==onContentAfterDelete==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that has been deleted which holds the article data.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L61 content/finder/finder.php]<br /> <br /> ==onContentChangeState==<br /> ===Description===<br /> This is an event that is called after content has its state change (e.g. Published to Unpublished).<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;$pks&lt;/code&gt; An array of primary key ids of the content that has changed state.<br /> *&lt;code&gt;$value&lt;/code&gt; The value of the state that the content has been changed to.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L80 content/finder/finder.php]<br /> <br /> ==onContentSearch==<br /> ===Description===<br /> <br /> This event is triggered by a variety of search related operations. It is a request for a<br /> plugin to return the result of a search request. The rows must return the following fields, which are used in a common display routine:<br /> <br /> * browsernav<br /> * catslug<br /> * created<br /> * href<br /> * section<br /> * slug<br /> * text<br /> * title<br /> <br /> ===Parameters===<br /> <br /> * &lt;code&gt;$text&lt;/code&gt; The target search string.<br /> * &lt;code&gt;$phrase&lt;/code&gt; A string matching option (exact|any|all). Default is &quot;any&quot;.<br /> * &lt;code&gt;$ordering&lt;/code&gt; A string ordering option (newest|oldest|popular|alpha|category). Default is &quot;newest&quot;.<br /> * &lt;code&gt;$areas&lt;/code&gt; An array if restricted to areas, null if search all.<br /> <br /> ===Return Value===<br /> <br /> Array of stdClass objects with members as described above.<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/administrator/components/com_search/models/searches.php#L158 administrator/components/com_search/models/searches.php]&lt;/tt&gt;<br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/components/com_search/models/search.php#L154 components/com_search/models/search.php]&lt;/tt&gt;<br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/search/categories/categories.php#L62 plugins/search/categories/categories.php]&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> ==onContentSearchAreas==<br /> ===Description===<br /> <br /> This appears to be a request for plugins to identify which &quot;areas&quot; they provide<br /> search facilities for.<br /> <br /> ===Parameters===<br /> <br /> None.<br /> <br /> ===Return Value===<br /> <br /> An associative array of area names, indexed by the area identifier. For example, array( 'categories' =&gt; 'Categories' ).<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;components/com_search/models/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Content&diff=122320 2014-07-15T18:11:12Z

<p>Phproberto: /* Used in files */</p> <hr /> <div>{{version/tutor|2.5,3.x|alt=1.5|altlink=J1.5:Plugin/Events/Content|alttitle=this guide for old event names}}<br /> 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.<br /> <br /> ==onContentPrepare==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; 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-&gt;text).<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.<br /> *&lt;code&gt;page&lt;/code&gt; An integer that determines the &quot;page&quot; 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.<br /> <br /> ===Return Value===<br /> None. Results are returned by modifying the referenced arguments. Sometimes a boolean might be returned to check for success or failure of the event.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/emailcloak/emailcloak.php#L31 plugins/content/emailcloak/emailcloak.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterTitle==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/vote/vote.php#L29 plugins/content/vote/vote.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A JRegistry object of merged article and menu item params.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeSave==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ==onContentAfterSave==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ==onContentPrepareForm==<br /> ===Description===<br /> Called before a JForm is rendered. It can be used to modify the JForm object in memory before rendering. For example, use JForm-&gt;loadFile() to add fields or JForm-&gt;removeField() to remove fields. Or use JForm-&gt;setFieldAttribute() or other JForm methods to modify fields for the form.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;form&lt;/code&gt; The JForm object to be displayed. Use the $form-&gt;getName() method to check whether this is the form you want to work with.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L168 plugins/user/profile/profile.php]<br /> <br /> ==onContentPrepareData==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L51 plugins/user/profile/profile.php]<br /> <br /> ==onContentBeforeDelete==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; A reference to the JTableContent object that is being deleted which holds the article data.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/joomla/joomla.php#L89 plugins/content/joomla/joomla.php]<br /> <br /> ==onContentAfterDelete==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that has been deleted which holds the article data.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L61 content/finder/finder.php]<br /> <br /> ==onContentChangeState==<br /> ===Description===<br /> This is an event that is called after content has its state change (e.g. Published to Unpublished).<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;$pks&lt;/code&gt; An array of primary key ids of the content that has changed state.<br /> *&lt;code&gt;$value&lt;/code&gt; The value of the state that the content has been changed to.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L80 content/finder/finder.php]<br /> <br /> ==onContentSearch==<br /> ===Description===<br /> <br /> This event is triggered by a variety of search related operations. It is a request for a<br /> plugin to return the result of a search request. The rows must return the following fields, which are used in a common display routine:<br /> <br /> * browsernav<br /> * catslug<br /> * created<br /> * href<br /> * section<br /> * slug<br /> * text<br /> * title<br /> <br /> ===Parameters===<br /> <br /> * &lt;code&gt;$text&lt;/code&gt; The target search string.<br /> * &lt;code&gt;$phrase&lt;/code&gt; A string matching option (exact|any|all). Default is &quot;any&quot;.<br /> * &lt;code&gt;$ordering&lt;/code&gt; A string ordering option (newest|oldest|popular|alpha|category). Default is &quot;newest&quot;.<br /> * &lt;code&gt;$areas&lt;/code&gt; An array if restricted to areas, null if search all.<br /> <br /> ===Return Value===<br /> <br /> Array of stdClass objects with members as described above.<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/administrator/components/com_search/models/searches.php#L158 administrator/components/com_search/models/searches.php]&lt;/tt&gt;<br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/components/com_search/models/search.php#L154 components/com_search/models/search.php]&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> ==onContentSearchAreas==<br /> ===Description===<br /> <br /> This appears to be a request for plugins to identify which &quot;areas&quot; they provide<br /> search facilities for.<br /> <br /> ===Parameters===<br /> <br /> None.<br /> <br /> ===Return Value===<br /> <br /> An associative array of area names, indexed by the area identifier. For example, array( 'categories' =&gt; 'Categories' ).<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;components/com_search/models/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Content&diff=122319 2014-07-15T18:10:08Z

<p>Phproberto: /* Used in files */</p> <hr /> <div>{{version/tutor|2.5,3.x|alt=1.5|altlink=J1.5:Plugin/Events/Content|alttitle=this guide for old event names}}<br /> 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.<br /> <br /> ==onContentPrepare==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; 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-&gt;text).<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.<br /> *&lt;code&gt;page&lt;/code&gt; An integer that determines the &quot;page&quot; 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.<br /> <br /> ===Return Value===<br /> None. Results are returned by modifying the referenced arguments. Sometimes a boolean might be returned to check for success or failure of the event.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/emailcloak/emailcloak.php#L31 plugins/content/emailcloak/emailcloak.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterTitle==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/vote/vote.php#L29 plugins/content/vote/vote.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A JRegistry object of merged article and menu item params.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeSave==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ==onContentAfterSave==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ==onContentPrepareForm==<br /> ===Description===<br /> Called before a JForm is rendered. It can be used to modify the JForm object in memory before rendering. For example, use JForm-&gt;loadFile() to add fields or JForm-&gt;removeField() to remove fields. Or use JForm-&gt;setFieldAttribute() or other JForm methods to modify fields for the form.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;form&lt;/code&gt; The JForm object to be displayed. Use the $form-&gt;getName() method to check whether this is the form you want to work with.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L168 plugins/user/profile/profile.php]<br /> <br /> ==onContentPrepareData==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L51 plugins/user/profile/profile.php]<br /> <br /> ==onContentBeforeDelete==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; A reference to the JTableContent object that is being deleted which holds the article data.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/joomla/joomla.php#L89 plugins/content/joomla/joomla.php]<br /> <br /> ==onContentAfterDelete==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that has been deleted which holds the article data.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L61 content/finder/finder.php]<br /> <br /> ==onContentChangeState==<br /> ===Description===<br /> This is an event that is called after content has its state change (e.g. Published to Unpublished).<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;$pks&lt;/code&gt; An array of primary key ids of the content that has changed state.<br /> *&lt;code&gt;$value&lt;/code&gt; The value of the state that the content has been changed to.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L80 content/finder/finder.php]<br /> <br /> ==onContentSearch==<br /> ===Description===<br /> <br /> This event is triggered by a variety of search related operations. It is a request for a<br /> plugin to return the result of a search request. The rows must return the following fields, which are used in a common display routine:<br /> <br /> * browsernav<br /> * catslug<br /> * created<br /> * href<br /> * section<br /> * slug<br /> * text<br /> * title<br /> <br /> ===Parameters===<br /> <br /> * &lt;code&gt;$text&lt;/code&gt; The target search string.<br /> * &lt;code&gt;$phrase&lt;/code&gt; A string matching option (exact|any|all). Default is &quot;any&quot;.<br /> * &lt;code&gt;$ordering&lt;/code&gt; A string ordering option (newest|oldest|popular|alpha|category). Default is &quot;newest&quot;.<br /> * &lt;code&gt;$areas&lt;/code&gt; An array if restricted to areas, null if search all.<br /> <br /> ===Return Value===<br /> <br /> Array of stdClass objects with members as described above.<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/administrator/components/com_search/models/searches.php#L158 administrator/components/com_search/models/searches.php]&lt;/tt&gt;<br /> * &lt;tt&gt;components/com_search/models/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> ==onContentSearchAreas==<br /> ===Description===<br /> <br /> This appears to be a request for plugins to identify which &quot;areas&quot; they provide<br /> search facilities for.<br /> <br /> ===Parameters===<br /> <br /> None.<br /> <br /> ===Return Value===<br /> <br /> An associative array of area names, indexed by the area identifier. For example, array( 'categories' =&gt; 'Categories' ).<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;components/com_search/models/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Content&diff=122318 2014-07-15T17:49:33Z

<p>Phproberto: /* Description */</p> <hr /> <div>{{version/tutor|2.5,3.x|alt=1.5|altlink=J1.5:Plugin/Events/Content|alttitle=this guide for old event names}}<br /> 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.<br /> <br /> ==onContentPrepare==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; 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-&gt;text).<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.<br /> *&lt;code&gt;page&lt;/code&gt; An integer that determines the &quot;page&quot; 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.<br /> <br /> ===Return Value===<br /> None. Results are returned by modifying the referenced arguments. Sometimes a boolean might be returned to check for success or failure of the event.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/emailcloak/emailcloak.php#L31 plugins/content/emailcloak/emailcloak.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterTitle==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/vote/vote.php#L29 plugins/content/vote/vote.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A JRegistry object of merged article and menu item params.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeSave==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ==onContentAfterSave==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ==onContentPrepareForm==<br /> ===Description===<br /> Called before a JForm is rendered. It can be used to modify the JForm object in memory before rendering. For example, use JForm-&gt;loadFile() to add fields or JForm-&gt;removeField() to remove fields. Or use JForm-&gt;setFieldAttribute() or other JForm methods to modify fields for the form.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;form&lt;/code&gt; The JForm object to be displayed. Use the $form-&gt;getName() method to check whether this is the form you want to work with.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L168 plugins/user/profile/profile.php]<br /> <br /> ==onContentPrepareData==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L51 plugins/user/profile/profile.php]<br /> <br /> ==onContentBeforeDelete==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; A reference to the JTableContent object that is being deleted which holds the article data.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/joomla/joomla.php#L89 plugins/content/joomla/joomla.php]<br /> <br /> ==onContentAfterDelete==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that has been deleted which holds the article data.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L61 content/finder/finder.php]<br /> <br /> ==onContentChangeState==<br /> ===Description===<br /> This is an event that is called after content has its state change (e.g. Published to Unpublished).<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;$pks&lt;/code&gt; An array of primary key ids of the content that has changed state.<br /> *&lt;code&gt;$value&lt;/code&gt; The value of the state that the content has been changed to.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L80 content/finder/finder.php]<br /> <br /> ==onContentSearch==<br /> ===Description===<br /> <br /> This event is triggered by a variety of search related operations. It is a request for a<br /> plugin to return the result of a search request. The rows must return the following fields, which are used in a common display routine:<br /> <br /> * browsernav<br /> * catslug<br /> * created<br /> * href<br /> * section<br /> * slug<br /> * text<br /> * title<br /> <br /> ===Parameters===<br /> <br /> * &lt;code&gt;$text&lt;/code&gt; The target search string.<br /> * &lt;code&gt;$phrase&lt;/code&gt; A string matching option (exact|any|all). Default is &quot;any&quot;.<br /> * &lt;code&gt;$ordering&lt;/code&gt; A string ordering option (newest|oldest|popular|alpha|category). Default is &quot;newest&quot;.<br /> * &lt;code&gt;$areas&lt;/code&gt; An array if restricted to areas, null if search all.<br /> <br /> ===Return Value===<br /> <br /> Array of stdClass objects with members as described above.<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;administrator/components/com_search/models/searches.php&lt;/tt&gt;<br /> * &lt;tt&gt;components/com_search/models/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> ==onContentSearchAreas==<br /> ===Description===<br /> <br /> This appears to be a request for plugins to identify which &quot;areas&quot; they provide<br /> search facilities for.<br /> <br /> ===Parameters===<br /> <br /> None.<br /> <br /> ===Return Value===<br /> <br /> An associative array of area names, indexed by the area identifier. For example, array( 'categories' =&gt; 'Categories' ).<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;components/com_search/models/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Content&diff=122317 2014-07-15T17:42:45Z

<p>Phproberto: /* Parameters */</p> <hr /> <div>{{version/tutor|2.5,3.x|alt=1.5|altlink=J1.5:Plugin/Events/Content|alttitle=this guide for old event names}}<br /> 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.<br /> <br /> ==onContentPrepare==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; 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-&gt;text).<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.<br /> *&lt;code&gt;page&lt;/code&gt; An integer that determines the &quot;page&quot; 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.<br /> <br /> ===Return Value===<br /> None. Results are returned by modifying the referenced arguments. Sometimes a boolean might be returned to check for success or failure of the event.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/emailcloak/emailcloak.php#L31 plugins/content/emailcloak/emailcloak.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterTitle==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/vote/vote.php#L29 plugins/content/vote/vote.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A JRegistry object of merged article and menu item params.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeSave==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ==onContentAfterSave==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ==onContentPrepareForm==<br /> ===Description===<br /> Called before a JForm is rendered. It can be used to modify the JForm object in memory before rendering. For example, use JForm-&gt;loadFile() to add fields or JForm-&gt;removeField() to remove fields. Or use JForm-&gt;setFieldAttribute() or other JForm methods to modify fields for the form.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;form&lt;/code&gt; The JForm object to be displayed. Use the $form-&gt;getName() method to check whether this is the form you want to work with.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L168 plugins/user/profile/profile.php]<br /> <br /> ==onContentPrepareData==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L51 plugins/user/profile/profile.php]<br /> <br /> ==onContentBeforeDelete==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; A reference to the JTableContent object that is being deleted which holds the article data.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/joomla/joomla.php#L89 plugins/content/joomla/joomla.php]<br /> <br /> ==onContentAfterDelete==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that has been deleted which holds the article data.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L61 content/finder/finder.php]<br /> <br /> ==onContentChangeState==<br /> ===Description===<br /> This is an event that is called after content has its state change (e.g. Published to Unpublished).<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;$pks&lt;/code&gt; An array of primary key ids of the content that has changed state.<br /> *&lt;code&gt;$value&lt;/code&gt; The value of the state that the content has been changed to.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L80 content/finder/finder.php]<br /> <br /> ==onContentSearch==<br /> ===Description===<br /> <br /> This event is triggered by a variety of search related operations. It is a request for a<br /> plugin to return the result of a search request. The rows must return the following fields, which are used in a common display routine:<br /> <br /> * href<br /> * title<br /> * section<br /> * created<br /> * text<br /> * browsernav<br /> <br /> ===Parameters===<br /> <br /> * &lt;code&gt;$text&lt;/code&gt; The target search string.<br /> * &lt;code&gt;$phrase&lt;/code&gt; A string matching option (exact|any|all). Default is &quot;any&quot;.<br /> * &lt;code&gt;$ordering&lt;/code&gt; A string ordering option (newest|oldest|popular|alpha|category). Default is &quot;newest&quot;.<br /> * &lt;code&gt;$areas&lt;/code&gt; An array if restricted to areas, null if search all.<br /> <br /> ===Return Value===<br /> <br /> Array of stdClass objects with members as described above.<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;administrator/components/com_search/models/searches.php&lt;/tt&gt;<br /> * &lt;tt&gt;components/com_search/models/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> ==onContentSearchAreas==<br /> ===Description===<br /> <br /> This appears to be a request for plugins to identify which &quot;areas&quot; they provide<br /> search facilities for.<br /> <br /> ===Parameters===<br /> <br /> None.<br /> <br /> ===Return Value===<br /> <br /> An associative array of area names, indexed by the area identifier. For example, array( 'categories' =&gt; 'Categories' ).<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;components/com_search/models/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Content&diff=122316 2014-07-15T17:41:39Z

<p>Phproberto: /* Parameters */</p> <hr /> <div>{{version/tutor|2.5,3.x|alt=1.5|altlink=J1.5:Plugin/Events/Content|alttitle=this guide for old event names}}<br /> 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.<br /> <br /> ==onContentPrepare==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; 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-&gt;text).<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.<br /> *&lt;code&gt;page&lt;/code&gt; An integer that determines the &quot;page&quot; 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.<br /> <br /> ===Return Value===<br /> None. Results are returned by modifying the referenced arguments. Sometimes a boolean might be returned to check for success or failure of the event.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/emailcloak/emailcloak.php#L31 plugins/content/emailcloak/emailcloak.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterTitle==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/vote/vote.php#L29 plugins/content/vote/vote.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A JRegistry object of merged article and menu item params.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeSave==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ==onContentAfterSave==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ==onContentPrepareForm==<br /> ===Description===<br /> Called before a JForm is rendered. It can be used to modify the JForm object in memory before rendering. For example, use JForm-&gt;loadFile() to add fields or JForm-&gt;removeField() to remove fields. Or use JForm-&gt;setFieldAttribute() or other JForm methods to modify fields for the form.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;form&lt;/code&gt; The JForm object to be displayed. Use the $form-&gt;getName() method to check whether this is the form you want to work with.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L168 plugins/user/profile/profile.php]<br /> <br /> ==onContentPrepareData==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L51 plugins/user/profile/profile.php]<br /> <br /> ==onContentBeforeDelete==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; A reference to the JTableContent object that is being deleted which holds the article data.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/joomla/joomla.php#L89 plugins/content/joomla/joomla.php]<br /> <br /> ==onContentAfterDelete==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that has been deleted which holds the article data.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L61 content/finder/finder.php]<br /> <br /> ==onContentChangeState==<br /> ===Description===<br /> This is an event that is called after content has its state change (e.g. Published to Unpublished).<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;$pks&lt;/code&gt; An array of primary key ids of the content that has changed state.<br /> *&lt;code&gt;$value&lt;/code&gt; The value of the state that the content has been changed to.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L80 content/finder/finder.php]<br /> <br /> ==onContentSearch==<br /> ===Description===<br /> <br /> This event is triggered by a variety of search related operations. It is a request for a<br /> plugin to return the result of a search request. The rows must return the following fields, which are used in a common display routine:<br /> <br /> * href<br /> * title<br /> * section<br /> * created<br /> * text<br /> * browsernav<br /> <br /> ===Parameters===<br /> <br /> * &lt;code&gt;$text&lt;/code&gt; The target search string.<br /> * &lt;code&gt;$phrase&lt;/code&gt; A string matching option (exact|any|all).<br /> * &lt;code&gt;$ordering&lt;/code&gt; A string ordering option (newest|oldest|popular|alpha|category)<br /> * &lt;code&gt;$areas&lt;/code&gt; An array if restricted to areas, null if search all.<br /> <br /> ===Return Value===<br /> <br /> Array of stdClass objects with members as described above.<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;administrator/components/com_search/models/searches.php&lt;/tt&gt;<br /> * &lt;tt&gt;components/com_search/models/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> ==onContentSearchAreas==<br /> ===Description===<br /> <br /> This appears to be a request for plugins to identify which &quot;areas&quot; they provide<br /> search facilities for.<br /> <br /> ===Parameters===<br /> <br /> None.<br /> <br /> ===Return Value===<br /> <br /> An associative array of area names, indexed by the area identifier. For example, array( 'categories' =&gt; 'Categories' ).<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;components/com_search/models/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Content&diff=122315 2014-07-15T17:40:00Z

<p>Phproberto: /* Used in files */</p> <hr /> <div>{{version/tutor|2.5,3.x|alt=1.5|altlink=J1.5:Plugin/Events/Content|alttitle=this guide for old event names}}<br /> 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.<br /> <br /> ==onContentPrepare==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; 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-&gt;text).<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.<br /> *&lt;code&gt;page&lt;/code&gt; An integer that determines the &quot;page&quot; 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.<br /> <br /> ===Return Value===<br /> None. Results are returned by modifying the referenced arguments. Sometimes a boolean might be returned to check for success or failure of the event.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/emailcloak/emailcloak.php#L31 plugins/content/emailcloak/emailcloak.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterTitle==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/vote/vote.php#L29 plugins/content/vote/vote.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A JRegistry object of merged article and menu item params.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeSave==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ==onContentAfterSave==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ==onContentPrepareForm==<br /> ===Description===<br /> Called before a JForm is rendered. It can be used to modify the JForm object in memory before rendering. For example, use JForm-&gt;loadFile() to add fields or JForm-&gt;removeField() to remove fields. Or use JForm-&gt;setFieldAttribute() or other JForm methods to modify fields for the form.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;form&lt;/code&gt; The JForm object to be displayed. Use the $form-&gt;getName() method to check whether this is the form you want to work with.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L168 plugins/user/profile/profile.php]<br /> <br /> ==onContentPrepareData==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L51 plugins/user/profile/profile.php]<br /> <br /> ==onContentBeforeDelete==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; A reference to the JTableContent object that is being deleted which holds the article data.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/joomla/joomla.php#L89 plugins/content/joomla/joomla.php]<br /> <br /> ==onContentAfterDelete==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that has been deleted which holds the article data.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L61 content/finder/finder.php]<br /> <br /> ==onContentChangeState==<br /> ===Description===<br /> This is an event that is called after content has its state change (e.g. Published to Unpublished).<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;$pks&lt;/code&gt; An array of primary key ids of the content that has changed state.<br /> *&lt;code&gt;$value&lt;/code&gt; The value of the state that the content has been changed to.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L80 content/finder/finder.php]<br /> <br /> ==onContentSearch==<br /> ===Description===<br /> <br /> This event is triggered by a variety of search related operations. It is a request for a<br /> plugin to return the result of a search request. The rows must return the following fields, which are used in a common display routine:<br /> <br /> * href<br /> * title<br /> * section<br /> * created<br /> * text<br /> * browsernav<br /> <br /> ===Parameters===<br /> <br /> * The target search string.<br /> * A string matching option (exact|any|all).<br /> * A string ordering option (newest|oldest|popular|alpha|category)<br /> * An array if restricted to areas, null if search all.<br /> <br /> ===Return Value===<br /> <br /> Array of stdClass objects with members as described above.<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;administrator/components/com_search/models/searches.php&lt;/tt&gt;<br /> * &lt;tt&gt;components/com_search/models/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> ==onContentSearchAreas==<br /> ===Description===<br /> <br /> This appears to be a request for plugins to identify which &quot;areas&quot; they provide<br /> search facilities for.<br /> <br /> ===Parameters===<br /> <br /> None.<br /> <br /> ===Return Value===<br /> <br /> An associative array of area names, indexed by the area identifier. For example, array( 'categories' =&gt; 'Categories' ).<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;components/com_search/models/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Content&diff=122314 2014-07-15T17:38:05Z

<p>Phproberto: /* Used in files */</p> <hr /> <div>{{version/tutor|2.5,3.x|alt=1.5|altlink=J1.5:Plugin/Events/Content|alttitle=this guide for old event names}}<br /> 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.<br /> <br /> ==onContentPrepare==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; 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-&gt;text).<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.<br /> *&lt;code&gt;page&lt;/code&gt; An integer that determines the &quot;page&quot; 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.<br /> <br /> ===Return Value===<br /> None. Results are returned by modifying the referenced arguments. Sometimes a boolean might be returned to check for success or failure of the event.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/emailcloak/emailcloak.php#L31 plugins/content/emailcloak/emailcloak.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterTitle==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; An associative array of relevant parameters.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ===Example===<br /> *&lt;tt&gt;[https://github.com/joomla/joomla-cms/blob/master/plugins/content/vote/vote.php#L29 plugins/content/vote/vote.php]&lt;/tt&gt;<br /> <br /> ==onContentAfterDisplay==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;&amp;article&lt;/code&gt; The article that is being rendered by the view.<br /> *&lt;code&gt;&amp;params&lt;/code&gt; A JRegistry object of merged article and menu item params.<br /> *&lt;code&gt;limitstart&lt;/code&gt; An integer that determines the &quot;page&quot; of the content that is to be generated.<br /> <br /> ===Return Value===<br /> String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.<br /> <br /> ==onContentBeforeSave==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ==onContentAfterSave==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that is being saved which holds the article data.<br /> *&lt;code&gt;isNew&lt;/code&gt; A boolean which is set to true if the content is about to be created.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ==onContentPrepareForm==<br /> ===Description===<br /> Called before a JForm is rendered. It can be used to modify the JForm object in memory before rendering. For example, use JForm-&gt;loadFile() to add fields or JForm-&gt;removeField() to remove fields. Or use JForm-&gt;setFieldAttribute() or other JForm methods to modify fields for the form.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;form&lt;/code&gt; The JForm object to be displayed. Use the $form-&gt;getName() method to check whether this is the form you want to work with.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L168 plugins/user/profile/profile.php]<br /> <br /> ==onContentPrepareData==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; An object containing the data for the form.<br /> <br /> ===Return Value===<br /> *&lt;code&gt;boolean&lt;/code&gt; True if method succeeds.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/user/profile/profile.php#L51 plugins/user/profile/profile.php]<br /> <br /> ==onContentBeforeDelete==<br /> ===Description===<br /> 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 &lt;code&gt;JModelLegacy&lt;/code&gt; for example the error will then be set by calling &lt;code&gt;$this-&gt;setError($table-&gt;getError);&lt;/code&gt; to be displayed to user.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;data&lt;/code&gt; A reference to the JTableContent object that is being deleted which holds the article data.<br /> <br /> ===Return Value===<br /> Boolean. Result will affect the saving process. See description for details.<br /> <br /> ===Example===<br /> *[https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/joomla/joomla.php#L89 plugins/content/joomla/joomla.php]<br /> <br /> ==onContentAfterDelete==<br /> ===Description===<br /> 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.<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;article&lt;/code&gt; A reference to the JTableContent object that has been deleted which holds the article data.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L61 content/finder/finder.php]<br /> <br /> ==onContentChangeState==<br /> ===Description===<br /> This is an event that is called after content has its state change (e.g. Published to Unpublished).<br /> <br /> ===Parameters===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> *&lt;code&gt;$pks&lt;/code&gt; An array of primary key ids of the content that has changed state.<br /> *&lt;code&gt;$value&lt;/code&gt; The value of the state that the content has been changed to.<br /> <br /> ===Return Value===<br /> None. Result will be omitted.<br /> <br /> ===Example===<br /> [https://www.github.com/joomla/joomla-cms/tree/master/plugins/content/finder/finder.php#L80 content/finder/finder.php]<br /> <br /> ==onContentSearch==<br /> ===Description===<br /> <br /> This event is triggered by a variety of search related operations. It is a request for a<br /> plugin to return the result of a search request. The rows must return the following fields, which are used in a common display routine:<br /> <br /> * href<br /> * title<br /> * section<br /> * created<br /> * text<br /> * browsernav<br /> <br /> ===Parameters===<br /> <br /> * The target search string.<br /> * A string matching option (exact|any|all).<br /> * A string ordering option (newest|oldest|popular|alpha|category)<br /> * An array if restricted to areas, null if search all.<br /> <br /> ===Return Value===<br /> <br /> Array of stdClass objects with members as described above.<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;administrator/components/com_statistics/admin.statistics.php&lt;/tt&gt;<br /> * &lt;tt&gt;components/com_search/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/sections.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/xmlrpc/joomla.php&lt;/tt&gt;<br /> <br /> ==onContentSearchAreas==<br /> ===Description===<br /> <br /> This appears to be a request for plugins to identify which &quot;areas&quot; they provide<br /> search facilities for.<br /> <br /> ===Parameters===<br /> <br /> None.<br /> <br /> ===Return Value===<br /> <br /> An associative array of area names, indexed by the area identifier. For example, array( 'categories' =&gt; 'Categories' ).<br /> <br /> ===Used in files===<br /> <br /> * &lt;tt&gt;components/com_search/models/search.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/categories.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/contacts.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/content.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/newsfeeds.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/tags/tags.php&lt;/tt&gt;<br /> * &lt;tt&gt;plugins/search/weblinks.php&lt;/tt&gt;<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Captcha&diff=122311 2014-07-15T17:33:30Z

<p>Phproberto: /* Called in files */</p> <hr /> <div>{{page|needs completion|This page need completing to be a useful doc reference.}}<br /> <br /> Events of Captcha<br /> <br /> == onInit ==<br /> <br /> === Description ===<br /> Event called to initialise the captcha<br /> === Parameters ===<br /> * &lt;code&gt;$id&lt;/code&gt; DOM id of the field that will contain the captcha<br /> <br /> === Return Value ===<br /> Boolean True on success, false otherwise<br /> === Called in files ===<br /> * &lt;code&gt;libraries/cms/captcha/captcha.php&lt;/code&gt;<br /> <br /> == onDisplay ==<br /> <br /> === Description ===<br /> <br /> === Parameters ===<br /> <br /> === Return Value ===<br /> <br /> === Called in files ===<br /> <br /> == onCheckAnswer ==<br /> <br /> === Description ===<br /> <br /> === Parameters ===<br /> <br /> === Return Value ===<br /> <br /> === Called in files ===<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Captcha&diff=122310 2014-07-15T17:26:00Z

<p>Phproberto: /* Parameters */</p> <hr /> <div>{{page|needs completion|This page need completing to be a useful doc reference.}}<br /> <br /> Events of Captcha<br /> <br /> == onInit ==<br /> <br /> === Description ===<br /> Event called to initialise the captcha<br /> === Parameters ===<br /> * &lt;code&gt;$id&lt;/code&gt; DOM id of the field that will contain the captcha<br /> <br /> === Return Value ===<br /> Boolean True on success, false otherwise<br /> === Called in files ===<br /> <br /> == onDisplay ==<br /> <br /> === Description ===<br /> <br /> === Parameters ===<br /> <br /> === Return Value ===<br /> <br /> === Called in files ===<br /> <br /> == onCheckAnswer ==<br /> <br /> === Description ===<br /> <br /> === Parameters ===<br /> <br /> === Return Value ===<br /> <br /> === Called in files ===<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Captcha&diff=122309 2014-07-15T17:25:50Z

<p>Phproberto: /* Parameters */</p> <hr /> <div>{{page|needs completion|This page need completing to be a useful doc reference.}}<br /> <br /> Events of Captcha<br /> <br /> == onInit ==<br /> <br /> === Description ===<br /> Event called to initialise the captcha<br /> === Parameters ===<br /> * &lt;code&gt;$id&lt;/code&gt;DOM id of the field that will contain the captcha<br /> <br /> === Return Value ===<br /> Boolean True on success, false otherwise<br /> === Called in files ===<br /> <br /> == onDisplay ==<br /> <br /> === Description ===<br /> <br /> === Parameters ===<br /> <br /> === Return Value ===<br /> <br /> === Called in files ===<br /> <br /> == onCheckAnswer ==<br /> <br /> === Description ===<br /> <br /> === Parameters ===<br /> <br /> === Return Value ===<br /> <br /> === Called in files ===<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Captcha&diff=122307 2014-07-15T17:25:22Z

<p>Phproberto: /* onInit */</p> <hr /> <div>{{page|needs completion|This page need completing to be a useful doc reference.}}<br /> <br /> Events of Captcha<br /> <br /> == onInit ==<br /> <br /> === Description ===<br /> Event called to initialise the captcha<br /> === Parameters ===<br /> DOM id of the field that will contain the captcha<br /> === Return Value ===<br /> Boolean True on success, false otherwise<br /> === Called in files ===<br /> <br /> == onDisplay ==<br /> <br /> === Description ===<br /> <br /> === Parameters ===<br /> <br /> === Return Value ===<br /> <br /> === Called in files ===<br /> <br /> == onCheckAnswer ==<br /> <br /> === Description ===<br /> <br /> === Parameters ===<br /> <br /> === Return Value ===<br /> <br /> === Called in files ===<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Quickicon&diff=122305 2014-07-15T17:20:13Z

<p>Phproberto: </p> <hr /> <div>Events of Quickicon<br /> <br /> == onGetIcons ==<br /> <br /> === Description ===<br /> This method is called when the Quick Icons module is constructing its set of icons. You can return an array which defines a single icon and it will be rendered right after the stock Quick Icons.<br /> <br /> === Parameters ===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> <br /> === Return Value ===<br /> A list of icon definition associative arrays, consisting of the keys link, image, text and access.<br /> <br /> '''Example''':<br /> &lt;source lang=&quot;php&quot;&gt;<br /> $return = array(<br /> array(<br /> 'link' =&gt; 'index.php?option=com_joomlaupdate',<br /> 'image' =&gt; 'joomla',<br /> 'icon' =&gt; 'header/icon-48-download.png',<br /> 'text' =&gt; JText::_('PLG_QUICKICON_JOOMLAUPDATE_CHECKING'),<br /> 'id' =&gt; 'plg_quickicon_joomlaupdate',<br /> 'group' =&gt; 'MOD_QUICKICON_MAINTENANCE'<br /> )<br /> );<br /> &lt;/source&gt;<br /> <br /> === Called in files ===<br /> * &lt;code&gt;administrator/modules/mod_quickicon/helper.php&lt;/code&gt;<br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Quickicon&diff=122304 2014-07-15T17:19:33Z

<p>Phproberto: /* Called in files */</p> <hr /> <div>{{page|needs completion|This page need completing to be a useful doc reference.}}<br /> <br /> Events of Quickicon<br /> <br /> == onGetIcons ==<br /> <br /> === Description ===<br /> This method is called when the Quick Icons module is constructing its set of icons. You can return an array which defines a single icon and it will be rendered right after the stock Quick Icons.<br /> <br /> === Parameters ===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> <br /> === Return Value ===<br /> A list of icon definition associative arrays, consisting of the keys link, image, text and access.<br /> <br /> '''Example''':<br /> &lt;source lang=&quot;php&quot;&gt;<br /> $return = array(<br /> array(<br /> 'link' =&gt; 'index.php?option=com_joomlaupdate',<br /> 'image' =&gt; 'joomla',<br /> 'icon' =&gt; 'header/icon-48-download.png',<br /> 'text' =&gt; JText::_('PLG_QUICKICON_JOOMLAUPDATE_CHECKING'),<br /> 'id' =&gt; 'plg_quickicon_joomlaupdate',<br /> 'group' =&gt; 'MOD_QUICKICON_MAINTENANCE'<br /> )<br /> );<br /> &lt;/source&gt;<br /> <br /> === Called in files ===<br /> * &lt;code&gt;administrator/modules/mod_quickicon/helper.php&lt;/code&gt;<br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Quickicon&diff=122303 2014-07-15T17:19:10Z

<p>Phproberto: /* Called in files */</p> <hr /> <div>{{page|needs completion|This page need completing to be a useful doc reference.}}<br /> <br /> Events of Quickicon<br /> <br /> == onGetIcons ==<br /> <br /> === Description ===<br /> This method is called when the Quick Icons module is constructing its set of icons. You can return an array which defines a single icon and it will be rendered right after the stock Quick Icons.<br /> <br /> === Parameters ===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> <br /> === Return Value ===<br /> A list of icon definition associative arrays, consisting of the keys link, image, text and access.<br /> <br /> '''Example''':<br /> &lt;source lang=&quot;php&quot;&gt;<br /> $return = array(<br /> array(<br /> 'link' =&gt; 'index.php?option=com_joomlaupdate',<br /> 'image' =&gt; 'joomla',<br /> 'icon' =&gt; 'header/icon-48-download.png',<br /> 'text' =&gt; JText::_('PLG_QUICKICON_JOOMLAUPDATE_CHECKING'),<br /> 'id' =&gt; 'plg_quickicon_joomlaupdate',<br /> 'group' =&gt; 'MOD_QUICKICON_MAINTENANCE'<br /> )<br /> );<br /> &lt;/source&gt;<br /> <br /> === Called in files ===<br /> &lt;code&gt;administrator/modules/mod_quickicon/helper.php&lt;/code&gt;<br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Quickicon&diff=122302 2014-07-15T17:18:06Z

<p>Phproberto: /* Return Value */</p> <hr /> <div>{{page|needs completion|This page need completing to be a useful doc reference.}}<br /> <br /> Events of Quickicon<br /> <br /> == onGetIcons ==<br /> <br /> === Description ===<br /> This method is called when the Quick Icons module is constructing its set of icons. You can return an array which defines a single icon and it will be rendered right after the stock Quick Icons.<br /> <br /> === Parameters ===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> <br /> === Return Value ===<br /> A list of icon definition associative arrays, consisting of the keys link, image, text and access.<br /> <br /> '''Example''':<br /> &lt;source lang=&quot;php&quot;&gt;<br /> $return = array(<br /> array(<br /> 'link' =&gt; 'index.php?option=com_joomlaupdate',<br /> 'image' =&gt; 'joomla',<br /> 'icon' =&gt; 'header/icon-48-download.png',<br /> 'text' =&gt; JText::_('PLG_QUICKICON_JOOMLAUPDATE_CHECKING'),<br /> 'id' =&gt; 'plg_quickicon_joomlaupdate',<br /> 'group' =&gt; 'MOD_QUICKICON_MAINTENANCE'<br /> )<br /> );<br /> &lt;/source&gt;<br /> <br /> === Called in files ===<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Quickicon&diff=122301 2014-07-15T17:17:31Z

<p>Phproberto: /* Return Value */</p> <hr /> <div>{{page|needs completion|This page need completing to be a useful doc reference.}}<br /> <br /> Events of Quickicon<br /> <br /> == onGetIcons ==<br /> <br /> === Description ===<br /> This method is called when the Quick Icons module is constructing its set of icons. You can return an array which defines a single icon and it will be rendered right after the stock Quick Icons.<br /> <br /> === Parameters ===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> <br /> === Return Value ===<br /> A list of icon definition associative arrays, consisting of the keys link, image, text and access.<br /> <br /> '''Example''':<br /> &lt;source lang=&quot;php&quot;&gt;<br /> return array(<br /> array(<br /> 'link' =&gt; 'index.php?option=com_joomlaupdate',<br /> 'image' =&gt; 'joomla',<br /> 'icon' =&gt; 'header/icon-48-download.png',<br /> 'text' =&gt; JText::_('PLG_QUICKICON_JOOMLAUPDATE_CHECKING'),<br /> 'id' =&gt; 'plg_quickicon_joomlaupdate',<br /> 'group' =&gt; 'MOD_QUICKICON_MAINTENANCE'<br /> )<br /> );<br /> &lt;/source&gt;<br /> <br /> === Called in files ===<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Quickicon&diff=122300 2014-07-15T17:13:32Z

<p>Phproberto: /* Parameters */</p> <hr /> <div>{{page|needs completion|This page need completing to be a useful doc reference.}}<br /> <br /> Events of Quickicon<br /> <br /> == onGetIcons ==<br /> <br /> === Description ===<br /> This method is called when the Quick Icons module is constructing its set of icons. You can return an array which defines a single icon and it will be rendered right after the stock Quick Icons.<br /> <br /> === Parameters ===<br /> *&lt;code&gt;context&lt;/code&gt; 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.<br /> <br /> === Return Value ===<br /> <br /> === Called in files ===<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Plugin/Events/Quickicon&diff=122299 2014-07-15T17:11:53Z

<p>Phproberto: /* Description */</p> <hr /> <div>{{page|needs completion|This page need completing to be a useful doc reference.}}<br /> <br /> Events of Quickicon<br /> <br /> == onGetIcons ==<br /> <br /> === Description ===<br /> This method is called when the Quick Icons module is constructing its set of icons. You can return an array which defines a single icon and it will be rendered right after the stock Quick Icons.<br /> <br /> === Parameters ===<br /> <br /> === Return Value ===<br /> <br /> === Called in files ===<br /> <br /> &lt;noinclude&gt;[[Category:Plugin Development]][[Category:Specifications]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Display_error_messages_and_notices&diff=79945 2013-01-17T09:07:47Z

<p>Phproberto: Fix missin quote</p> <hr /> <div>{{RightTOC}}<br /> Errors, warnings and notices can be displayed from any component, module, plugin or template using the methods outlined below.<br /> &lt;source lang=&quot;php&quot;&gt;<br /> // Get a handle to the Joomla! application object<br /> $application = JFactory::getApplication();<br /> <br /> // Add a message to the message queue<br /> $application-&gt;enqueueMessage(JText::_('SOME_ERROR_OCCURRED'), 'error');<br /> <br /> /** Alternatively you may use chaining */<br /> JFactory::getApplication()-&gt;enqueueMessage(JText::_('SOME_ERROR_OCCURRED'), 'error');<br /> &lt;/source&gt;<br /> <br /> The second argument to the [[JApplication/enqueueMessage|enqueueMessage]] function is the type of the message. The default is 'message', but 'error' results in a different style for the message. The message will be displayed in place of a special &lt;tt&gt;jdoc:include&lt;/tt&gt; statement in your template. Place the following in your template at the location where you want messages to appear.<br /> &lt;source lang=&quot;php&quot;&gt;<br /> &lt;jdoc:include type=&quot;message&quot; /&gt;<br /> &lt;/source&gt;<br /> <br /> == Message ==<br /> &lt;div style=&quot;background-color: #c3d2e5; color: #0055bb; border-top: 3px solid #84a7db; border-bottom: 3px solid #84a7db; padding-left: 1em; font-weight: bold;&quot;&gt;<br /> Message<br /> &lt;/div&gt;<br /> &lt;source lang=&quot;php&quot;&gt;<br /> JFactory::getApplication()-&gt;enqueueMessage('Message');<br /> &lt;/source&gt;<br /> <br /> == Notice ==<br /> <br /> &lt;div style=&quot;background-color: #efe7b8; color: #c00; border-top: 3px solid #f0dc7e; border-bottom: 3px solid #f0dc7e; padding-left: 1em; font-weight: bold;&quot;&gt;<br /> Notice<br /> &lt;/div&gt;<br /> &lt;source lang=&quot;php&quot;&gt;<br /> JError::raiseNotice( 100, 'Notice' );<br /> &lt;/source&gt;<br /> <br /> == Warning ==<br /> <br /> &lt;div style=&quot;background-color: #e6c0c0; color: #c00; border-top: 3px solid #DE7A7B; border-bottom: 3px solid #DE7A7B; padding-left: 1em; font-weight: bold;&quot;&gt;<br /> Warning<br /> &lt;/div&gt;<br /> &lt;source lang=&quot;php&quot;&gt;<br /> JError::raiseWarning( 100, 'Warning' );<br /> &lt;/source&gt;<br /> <br /> == Error ==<br /> &lt;source lang=&quot;php&quot;&gt;<br /> JError::raiseError( 4711, 'A severe error occurred' );<br /> &lt;/source&gt;<br /> <br /> == Joomla! 3.x is bootstraped ==<br /> Since Joomla! {{JVer|3.0}} will use bootstraped templates, the messages will use the standard boostrap CSS styles for Alerts.<br /> <br /> See: http://twitter.github.com/bootstrap/components.html#alerts<br /> <br /> The general syntax remains:<br /> <br /> &lt;source lang=&quot;php&quot;&gt;<br /> JFactory::getApplication()-&gt;enqueueMessage('Your Message', 'type');<br /> &lt;/source&gt;<br /> <br /> Where '''type''' can be one of<br /> <br /> * EMPTY - yellow<br /> * 'info' - blue<br /> * 'error' - red<br /> * 'success' - green<br /> <br /> == Success ==<br /> Note the new style in Joomla! 3 using the type '''success''' which is now used instead of the former &quot;Message&quot;.<br /> <br /> &lt;div style=&quot;background-color: #dff0d8; color: #468847; border-top: 3px solid #468847; border-bottom: 3px solid #468847; padding-left: 1em; font-weight: bold;&quot;&gt;<br /> Success<br /> &lt;/div&gt;<br /> <br /> &lt;source lang=&quot;php&quot;&gt;<br /> JFactory::getApplication()-&gt;enqueueMessage('Success');<br /> &lt;/source&gt;<br /> <br /> == See also ==<br /> * [[JError]]<br /> * [[JApplication]]<br /> * [http://api.joomla.org/1.5/Joomla-Framework/Application/JApplication.html JApplication on api.joomla.org]<br /> <br /> &lt;noinclude&gt;[[Category:Development]]&lt;/noinclude&gt;<br /> [[Category:Tutorials]][[Category:Component Development]]</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Potential_backward_compatibility_issues_in_Joomla_3_and_Joomla_Platform_12.2&diff=76421 2012-10-11T15:07:56Z

<p>Phproberto: Add onContentBeforeSave &amp; onContentAfterSave events modifications</p> <hr /> <div>{{incomplete}}{{RightTOC}}This document tracks potential backward compatibility issues for Joomla 3.0 and Joomla Platform 12.1, which is included in Joomla 3.0. Listed are issues which potentially break extensions.<br /> Please help make this document complete.<br /> <br /> The base of this comparison is Joomla 2.5/Platform 11.4.<br /> <br /> Backwards compatibility issues were also tracked for Joomla 2.5: [[Potential backward compatibility issues in Joomla 2.5 and Joomla Platform 11.4]]<br /> <br /> = Platform =<br /> The platform removed a larger number of deprecated classes and methods. For most extensions written for Joomla 2.5, the required changes should be reasonably small. Note that there are still deprecated classes in the platform that will be removed in future versions -- developers should stop using them where possible.<br /> <br /> == Updated System Requirements ==<br /> The system requirements have changed in the following points:<br /> *PHP 5.3.1<br /> *register_globals must be off<br /> *magic_quotes_gpc must be off<br /> <br /> == General changes ==<br /> *Almost all functions, methods, members and classes marked as deprecated in Platform 11.4 have been removed. They won't be listed in this document.<br /> *Appending ?no_html to an URL to get a RAW view is not supported anymore (this was an old Joomla 1.0 feature).<br /> *The DS constant has been removed. If you really need it you can use DIRECTORY_SEPARATOR instead.<br /> *Many more function arguments have been type hinted, including existing classes. Make sure you're always passing values of the correct type.<br /> *The name of modules now have to start with &quot;mod_&quot;.<br /> *Extensions need to set the registeredurlparams now, the fall back on the URL has been removed.<br /> *Some cookies are only accessible through HTTP (not via JavaScript). For example; the session cookie.<br /> *Due to upcoming changes to the MVC implementation in the platform, JModel, JView, and JController are re-used as the names of the new interfaces. For now, use JModelLegacy, JViewLegacy and JControllerLegacy instead.<br /> *JFolder and JFile now require you to do your own jimport statement (You always had to do that, just before it was rather likely something else had loaded them before)<br /> *Joomla! 3.0 usually throws exceptions instead of returning JError or JException. Please see [[Exceptions and Logging in Joomla 1.7 and Joomla Platform 11.1]] for more information.<br /> <br /> == Changes to extension installation ==<br /> *Use of the &lt;install&gt; base tag (from 1.5) is no longer supported; use &lt;extension&gt; instead.<br /> *Suppport for install_script and uninstall_script, and the methods com_install and com_uninstall in these scripts, has been removed; use scriptfile instead.<br /> *In language extensions, support for client=&quot;both&quot; has been removed; prepare each client as a separate extension and optionally bundle them as a package extension instead.<br /> *File paths for plugins no longer support the old 1.5 method (i.e. plugins/system/cache.php); each plugin must now be in its own folder (i.e. plugins/system/cache/cache.php).<br /> <br /> == Changes to Components ==<br /> *In admin components the admin.*.php and toolbar.*.php are not automatically included anymore (this was a Joomla 1.0 legacy feature).<br /> <br /> == Moved files ==<br /> All classes listed here should now be autoloadable. Explicit requires and includes have to be modified or removed.<br /> <br /> == Plugin Events ==<br /> * onContentBeforeSave event now receives $article by value not by reference. Sample definition: public function onContentBeforeSave($context, $article, $isNew).<br /> * onContentAfterSave event now receives $article by value not by reference. Sample definition: public function onContentAfterSave($context, $article, $isNew).<br /> <br /> == Renamed classes ==<br /> *JFTP is now called JClientFtp<br /> *JLDAP is now called JClientLdap<br /> *JWebClient is now called JApplicationWebClient<br /> <br /> == Removed classes ==<br /> *JParameter (use JForm instead)<br /> *JElement and its subclasses<br /> *JFormFieldEditors (use JFormFieldPlugins instead)<br /> *JHtmlImage<br /> *JRules (use JAccessRules instead)<br /> *JSimpleXML<br /> *JPane<br /> <br /> == Changes to classes ==<br /> <br /> === Base classes ===<br /> <br /> ==== JFactory ====<br /> *JFactory::getXMLParser() has been removed. For RSS and Atom use cases, use JFactory::getFeedParser() instead. To read XML files or strings use JFactory::getXML().<br /> *JFactory::_createConfig() has been removed. Use JFactory::createConfig() instead.<br /> *JFactory::_createSession() has been removed. Use JFactory::createSession() instead.<br /> *JFactory::_createDbo() has been removed. Use JFactory::createDbo() instead.<br /> *JFactory::_createMailer() has been removed. Use JFactory::createMailer() instead.<br /> *JFactory::_createDocument() has been removed. Use JFactory::createDocument() instead.<br /> <br /> === Application ===<br /> <br /> ==== JApplicationHelper ====<br /> *JApplicationHelper::getPath() has been removed. No replacement.<br /> *JApplicationHelper::_checkPath() has been removed. No replacement.<br /> <br /> === Component ===<br /> <br /> ==== JComponentHelper ====<br /> *The behavior of JComponentHelper::isEnabled() has been changed to match developer expectations.<br /> <br /> === MVC ===<br /> <br /> ==== JController ====<br /> *JController::$_acoSection has been removed.<br /> *JController::$_acoSectionValue has been removed.<br /> *JController::authorize() has been removed. Use JController::authorise() instead.<br /> *JController::setAccessControl() has been removed. Use JAccess.<br /> <br /> ==== JControllerLegacy ====<br /> * JControllerLegacy::display() needs an extra parameter: ($cachable = false, $urlparams = false).<br /> <br /> ==== JModelAdmin ====<br /> * JModelAdmin::generateNewTitle() is backwards incompatible with Joomla! 2.5 (first parameter has been removed).<br /> * JModelAdmin::prepareTable(): first parameter isn't reference anymore.<br /> <br /> === Archive ===<br /> <br /> ==== Adapters ====<br /> *JArchiveBzip2 does not extend JObject anymore. You must not use any of JObject's methods.<br /> *JArchiveGzip does not extend JObject anymore. You must not use any of JObject's methods.<br /> *JArchiveTar does not extend JObject anymore. You must not use any of JObject's methods.<br /> *JArchiveZip does not extend JObject anymore. You must not use any of JObject's methods.<br /> <br /> === Base ===<br /> <br /> ==== JObject ====<br /> *JObject::toString() has been removed. Use JObject::__toString() instead.<br /> <br /> === Client ===<br /> <br /> ==== JClientLdap (formerly JLDAP) ====<br /> *JClientLdap does not extend JObject anymore. You must not use any of JObject's methods.<br /> <br /> === Database ===<br /> JDatabase had been renamed JDatabaseDriver. JDatabase is still around (but deprecated) and is the base of JDatabaseDriver, this way type hints and instance of checks keep working.<br /> <br /> Due to lazy-connecting, a connection is only opened when running a query or explicitly calling JDatabaseDriver::connected(). Beware of that when checking JDatabaseDriver::connected().<br /> <br /> ==== JDatabase ====<br /> *JDatabase::$hasQuoted has been removed.<br /> *JDatabase::$quoted has been removed.<br /> *JDatabase::addQuoted() has been removed.<br /> *JDatabase::hasUTF() has been removed.<br /> *JDatabase::debug() has been removed. Use JDatabase::setDebug() instead.<br /> *JDatabase::explain() has been removed.<br /> *JDatabase::getEscaped() has been removed. Use JDatabase::escape() instead.<br /> *JDatabase::getTableFields() has been removed. Use JDatabase::getTableColumns() instead.<br /> *JDatabase::getTicker() has been removed. Use JDatabase::count() instead.<br /> *JDatabase::isQuoted() has been removed.<br /> *JDatabase::loadResultArray() has been removed. Use JDatabase::loadColumn() instead.<br /> *JDatabase::nameQuote() has been removed. Use JDatabase::quoteName() instead.<br /> *JDatabase::queryBatch() has been removed.<br /> <br /> === Document ===<br /> <br /> ==== JDocument ====<br /> *JDocument::setMetaData() the $sync argument has been removed. It was broken beyond repair.<br /> <br /> ==== JDocumentRenderer ====<br /> *JDocumentRenderer does not extend JObject anymore. You must not use any of JObject's methods.<br /> <br /> ==== JDocumentFeed ====<br /> *JFeedItem does not extend JObject anymore. You must not use any of JObject's methods.<br /> *JFeedEnclosure does not extend JObject anymore. You must not use any of JObject's methods.<br /> *JFeedImage does not extend JObject anymore. You must not use any of JObject's methods.<br /> <br /> ==== JDocumentOpenSearch ====<br /> *JOpenSearchUrl does not extend JObject anymore. You must not use any of JObject's methods.<br /> *JOpenSearchImage does not extend JObject anymore. You must not use any of JObject's methods.<br /> <br /> ==== JDocumentXml ====<br /> *JDocumentXml::$_name has been renamed to JDocumentXml::$name.<br /> <br /> === Environment ===<br /> <br /> ==== JBrowser ====<br /> *JBrowser does not extend JObject anymore. You must not use any of JObject's methods.<br /> *JBrowser::setQuirk() has been removed.<br /> *JBrowser::hasQuirk() has been removed.<br /> *JBrowser::getQuirk() has been removed.<br /> *JBrowser::setFeature() has been removed.<br /> *JBrowser::hasFeature() has been removed.<br /> *JBrowser::getFeature() has been removed.<br /> *JBrowser::$_majorVersion has been renamed to JBrowser::$majorVersion.<br /> *JBrowser::$_minorVersion has been renamed to JBrowser::$minorVersion.<br /> *JBrowser::$_browser has been renamed to JBrowser::$browser.<br /> *JBrowser::$_agent has been renamed to JBrowser::$agent.<br /> *JBrowser::$_lowerAgent has been renamed to JBrowser::$lowerAgent.<br /> *JBrowser::$_accept has been renamed to JBrowser::$accept.<br /> *JBrowser::$_accept_parsed has been renamed to JBrowser::$acceptParsed.<br /> *JBrowser::$_platform has been renamed to JBrowser::$platform.<br /> *JBrowser::$_robots has been renamed to JBrowser::$robots.<br /> *JBrowser::$_mobile has been renamed to JBrowser::$mobile.<br /> *JBrowser::$_images has been renamed to JBrowser::$images.<br /> <br /> ==== JRequest ====<br /> *JRequest::clean() has been removed.<br /> *JRequest::_cleanVar() is now protected.<br /> <br /> ==== JUri ====<br /> *JURI has been renamed to JUri. Autoloader is still able to regognise the old capitalized name.<br /> *JUri does not extend JObject anymore. You must not use any of JObject's methods.<br /> *JUri::$_uri has been renamed to JUri::$uri.<br /> *JUri::$_scheme has been renamed to JUri::$scheme.<br /> *JUri::$_host has been renamed to JUri::$host.<br /> *JUri::$_port has been renamed to JUri::$port.<br /> *JUri::$_user has been renamed to JUri::$user.<br /> *JUri::$_pass has been renamed to JUri::$pass.<br /> *JUri::$_path has been renamed to JUri::$path.<br /> *JUri::$_query has been renamed to JUri::$query.<br /> *JUri::$_fragment has been renamed to JUri::$fragment.<br /> *JUri::$_vars has been renamed to JUri::$vars.<br /> <br /> === Error ===<br /> <br /> ==== JError ====<br /> *JError has been deprecated. Use Exceptions instead.<br /> *'''WARNING''': Many functions that were previously returning JError or false are now throwing exceptions.<br /> <br /> Please see [[Exceptions and Logging in Joomla 1.7 and Joomla Platform 11.1]] for more information.<br /> <br /> ==== JProfiler ====<br /> *JProfiler does not extend JObject anymore. You must not use any of JObject's methods.<br /> *JProfiler::$_start has been renamed to JProfiler::$start.<br /> *JProfiler::$_prefix has been renamed to JProfiler::$prefix.<br /> *JProfiler::$_buffer has been renamed to JProfiler::$buffer.<br /> *JProfiler::$_previous_time has been renamed to JProfiler::$previousTime.<br /> *JProfiler::$_previous_mem has been renamed to JProfiler::$previousMem.<br /> *JProfiler::$_iswin has been renamed to JProfiler::$isWin.<br /> <br /> === Filesystem ===<br /> <br /> ==== JStream ====<br /> *JStream::$_fh has been renamed to JStream::$fh.<br /> *JStream::$_filesize has been renamed to JStream::$filesize.<br /> *JStream::$_context has been renamed to JStream::$context.<br /> *JStream::$_contextOptions has been renamed to JStream::$contextOptions.<br /> *JStream::$_openmode has been renamed to JStream::$openmode.<br /> <br /> ==== JStreamString ====<br /> *JStream::$_currentstring has been renamed to JStream::$currentString.<br /> *JStream::$_path has been renamed to JStream::$path.<br /> *JStream::$_mode has been renamed to JStream::$mode.<br /> *JStream::$_options has been renamed to JStream::$options.<br /> *JStream::$_opened_path has been renamed to JStream::$openedPath.<br /> *JStream::$_pos has been renamed to JStream::$pos.<br /> *JStream::$_len has been renamed to JStream::$len.<br /> *JStream::$_stat has been renamed to JStream::$stat.<br /> <br /> === Filter ===<br /> <br /> ==== JFilterInput ====<br /> *JFilterInput does not extend JObject anymore. You must not use any of JObject's methods.<br /> <br /> === HTML ===<br /> <br /> ==== JHtml ====<br /> *JHTML has been renamed to JHtml. Autoloader is still able to regognise the old capitalized name.<br /> *JHtml::_includeRelativeFiles() has been removed. Use JHtml::includeRelativeFiles() instead.<br /> *JHtml::core() has been removed. Use JHtmlBehavior::framework() instead.<br /> *JHtml::script() doesn't support a string as the second parameter anymore. This used to be the path to the file in Joomla 1.5 and has been removed now.<br /> *JHtml::stylesheet() doesn't support a string as the second parameter anymore. This used to be the path to the file in Joomla 1.5 and has been removed now.<br /> <br /> ==== JHtmlAccess ====<br /> *JHtmlAccess::assetgroups() the argument $config has been removed. It was previously unused.<br /> <br /> ==== JHtmlBehavior ====<br /> *JHtmlBehavior::mootools() has been removed. Use JHtmlBehavior::framework() instead.<br /> *JHtmlBehavior::noframes() the argument $location has been removed. It was previously unused.<br /> <br /> ==== JHtmlList ====<br /> *JHtmlList::ordering() the argument $chop has been removed. It was previously unused.<br /> *JHtmlList::users(), the argument $reg has been removed.<br /> <br /> ==== JHtmlSelect ====<br /> *JHtmlSelect::$_optionDefaults has been renamed to JHtmlSelect::$optionDefaults.<br /> <br /> ==== JToolBar ====<br /> *JToolBar does not extend JObject anymore. You must not use any of JObject's methods.<br /> *JToolBar no longer supports the 'X' functions (eg, addNewX, editListX) that hide the main menu before doing the function.<br /> <br /> ==== JButton ====<br /> *JButton does not extend JObject anymore. You must not use any of JObject's methods.<br /> <br /> ==== JPagination ====<br /> *JPagination::$_viewall has been renamed to JPagination::$viewall.<br /> *JPagination::$_additionalUrlParams has been renamed to JPagination::$additionalUrlParams.<br /> <br /> === Installer ===<br /> <br /> ==== JInstaller ====<br /> *JInstaller::getOverwrite() has been removed. Use JInstaller::isOverwrite() instead.<br /> *JInstaller::getUpgrade() has been removed. Use JInstaller::isUpgrade() instead.<br /> *JInstaller::$_paths has been renamed to JInstaller::$paths.<br /> *JInstaller::$_upgrade has been renamed to JInstaller::$upgrade.<br /> *JInstaller::$_overwrite has been renamed to JInstaller::$overwrite.<br /> *JInstaller::$_stepStack has been renamed to JInstaller::$stepStack.<br /> <br /> ==== JInstallerLanguage ====<br /> *JInstallerLanguage::$_core as been renamed to JInstallerLanguage::$core.<br /> <br /> === Language ===<br /> <br /> ==== JLanguage ====<br /> *JLanguage::getPluralSufficesCallback() has been removed. Use JLanguage::getPluralSuffixesCallback() instead.<br /> *JLanguage::_parseLanguageFiles() has been removed. Use JLanguage::parseLanguageFiles() instead.<br /> *JLanguage::_parseXMLLanguageFiles() has been removed. Use JLanguage::parseXMLLanguageFiles() instead.<br /> *JLanguage::_parseXMLLanguageFile() has been removed. Use JLanguage::parseXMLLanguageFile() instead.<br /> *JLanguage::loadLanguage() the argument $overwrite has been removed. It was previously unused.<br /> <br /> === Registry ===<br /> <br /> ==== JRegistry ====<br /> *JRegistry::loadXML() has been removed. Use JRegistry::loadString() instead.<br /> *JRegistry::loadINI() has been removed. Use JRegistry::loadString() instead.<br /> *JRegistry::loadJSON() has been removed. Use JRegistry::loadString() instead.<br /> *JRegistry::makeNameSpace() has been removed. No replacement.<br /> *JRegistry::getNameSpaces() has been removed. No replacement.<br /> *JRegistry::getValue() has been removed. Use JRegistry::get() instead.<br /> *JRegistry::setValue() has been removed. Use JRegistry::set() instead.<br /> *JRegistry::loadSetupFile() has been removed. No replacement.<br /> <br /> ==== JRegistryFormatINI ====<br /> *JRegistryFormatINI::stringToObject() the second argument ($option) may not be a boolean anymore.<br /> <br /> ==== JRegistryFormatJSON ====<br /> *JRegistryFormatJSON::stringToObject() the second argument ($option) may not be a boolean anymore.<br /> <br /> === Session ===<br /> <br /> ==== JSessionStorageDatabase ====<br /> *JSessionStorageDatabase::$_data has been renamed to JSessionStorageDatabase::$data.<br /> <br /> === Table ===<br /> <br /> ==== JTable ====<br /> *JTable::getInstance() parameters are now case sensitive, e.g. 'MenuType'.<br /> *JTable::canDelete() has been removed.<br /> *JTable::toXML() has been removed.<br /> <br /> === Updater ===<br /> <br /> ==== JUpdate ====<br /> *JUpdate::$_xml_parser has been renamed to JUpdate::$xmlParser.<br /> *JUpdate::$_stack has been renamed to JUpdate::$stack.<br /> *JUpdate::$_state_store has been renamed to JUpdate::$stateStore.<br /> *JUpdate::$_current_update has been renamed to JUpdate::$currentUpdate.<br /> <br /> ==== JUpdater ====<br /> *JUpdater::arrayUnique() has been removed. Use JArrayHelper::arrayUnique() instead.<br /> <br /> === User ===<br /> <br /> ==== JAuthentication ====<br /> *The constant JAUTHENTICATE_STATUS_SUCCESS has been removed. Use JAuthentication::STATUS_SUCCESS instead.<br /> *The constant JAUTHENTICATE_STATUS_CANCEL has been removed. No replacement.<br /> *The constant JAUTHENTICATE_STATUS_FAILURE has been removed. Use JAuthentication::STATUS_FAILURE instead.<br /> *JAuthentication::$_observers has been renamed to JAuthentication::$observers.<br /> *JAuthentication::$_state has been renamed to JAuthentication::$state.<br /> *JAuthentication::$_methods has been renamed to JAuthentication::$methods.<br /> <br /> ==== JUser ====<br /> *JUser::getParameters() has been removed.<br /> *Juser::authorisedLevels() has been removed. Use JUser::getAuthorisedViewLevels() instead.<br /> *Juser::authorize() has been removed. Use JUser::authorise() instead.<br /> *JUser::$usertype has been removed.<br /> <br /> === Utility ===<br /> <br /> ==== JBuffer ====<br /> *JBuffer::$_buffers has been renamed to JBuffer::$buffers.<br /> <br /> ==== JDate ====<br /> *JDate::toMysql() has been removed. Use JDate::toSql() instead.<br /> *JDate::toFormat() has been removed. Use JDate::format() instead.<br /> *JDate::setOffset() has been removed.<br /> *JDate::$offsets has been removed.<br /> *JDate::__construct() doesn't accept an numeric value for $tz anymore.<br /> *JDate::$_tz has been renamed to JDate::$tz.<br /> <br /> ==== JUtility ====<br /> *JUtility::sendMail() has been removed. Use JMail::sendMail() instead.<br /> *JUtility::sendAdminMail() has been removed. Use JMail::sendAdminMail() instead.<br /> *JUtility::getHash() has been removed. Use JApplication::getHash() instead.<br /> *JUtility::getToken() has been removed. Use JSession::getFormToken() instead.<br /> *JUtility::isWinOS() has been removed. Use JApplication::isWinOS() instead.<br /> *JUtility::dump() has been removed. No replacement.<br /> *JUtility::array_unshift_ref() has been removed. No replacement.<br /> *JUtility::array_unshift_ref() has been removed. No replacement.<br /> <br /> ==== JXMLElement ====<br /> *JXMLElement::data() has been removed.<br /> *JXMLElement::getAttribute() has been removed. Use SimpleXMLElement::attributes() instead.<br /> <br /> == JavaScript ==<br /> *Compatibility with MooTools 1.2 has been removed.<br /> *Forms that have name=&quot;adminForm&quot; now also require id=&quot;adminForm&quot;.<br /> *checkAll() has been removed. Use Joomla.checkAll() instead.<br /> *isChecked() has been removed. Use Joomla.isChecked() instead.<br /> *popupWindow() has been removed. Use Joomla.popupWindow() instead.<br /> *tableOrdering() has been removed. Use Joomla.tableOrdering() instead.<br /> <br /> = CMS =<br /> <br /> == General changes ==<br /> *JUtility is not always loaded. If you need it you have to add jimport('joomla.utilities.utility'); to your code.<br /> <br /> == Changes to classes ==<br /> <br /> === Component Classes ===<br /> *MenusModelItem::getItem() no longer returns a JObject but a stdClass.<br /> <br /> === Help ===<br /> <br /> ==== JHelp ====<br /> *JHelp::createSiteList() the argument $selected has been removed. It was unused.<br /> <br /> <br /> [[Category:Compatibility]]<br /> [[Category:Development]]<br /> [[Category:Platform]]</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Checkbox_form_field_type&diff=76153 2012-10-03T16:29:38Z

<p>Phproberto: Add information about how to set the uncheck status</p> <hr /> <div>The '''checkbox''' form field type provides a single checkbox. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.<br /> <br /> * '''type''' (mandatory) must be checkbox<br /> * '''name''' (mandatory) is the unique name of the parameter.<br /> * '''label''' (mandatory) (translatable) is the descriptive title of the field.<br /> * '''value''' (optional) is the default value of the checkbox. If exist the checkbox will be checked by default.<br /> * '''default''' (optional) is the default value (usually 0 or 1).<br /> * '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the label.<br /> * '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'inputbox'.<br /> &lt;noinclude&gt;<br /> Example XML field definition:<br /> <br /> &lt;source lang=&quot;xml&quot;&gt;&lt;field name=&quot;show_title&quot; type=&quot;checkbox&quot; label=&quot;Show title&quot; description=&quot;Show the title of the item&quot; value=&quot;1&quot; /&gt;&lt;/source&gt;<br /> <br /> Example XML field definition (unchecked):<br /> <br /> &lt;source lang=&quot;xml&quot;&gt;&lt;field name=&quot;show_title&quot; type=&quot;checkbox&quot; label=&quot;Show title&quot; description=&quot;Show the title of the item&quot; value=&quot;1&quot; default=&quot;0&quot; /&gt;&lt;/source&gt;<br /> <br /> === See also ===<br /> * [[Standard form field types|List of standard form field types]]<br /> [[Category:Standard form field types]]&lt;/noinclude&gt;</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Package&diff=67392 2012-05-28T23:13:59Z

<p>Phproberto: Added template subpackage example</p> <hr /> <div>== What is a package? ==<br /> <br /> A package is a extension that is used to install multiple extensions in one go. This is used if you have for example a component and a module that are depending on each other. Combining them in a package will let the user install and uninstall both extensions in one go. Package extensions can be used with Joomla [[File:Compat icon 1 6.png]] and higher.<br /> <br /> == How do I create a package? ==<br /> <br /> A package extension is created by zipping all zip files of the extensions together with a xml manifest file. For example if you have a package composed by:<br /> <br /> * '''component''' helloworld<br /> * '''module''' helloworld<br /> * '''library''' helloworld <br /> * '''system plugin''' helloworld <br /> * '''template''' helloworld<br /> <br /> The package should have the following tree in your zipfile:<br /> <br /> -- pkg_helloworld.xml<br /> -- packages &lt;dir&gt;<br /> |-- com_helloworld.zip<br /> |-- mod_helloworld.zip<br /> |-- lib_helloworld.zip<br /> |-- plg_sys_helloworld.zip<br /> |-- tpl_helloworld.zip<br /> <br /> The pkg_helloworld.xml could have the following contents:<br /> <br /> &lt;source lang=&quot;xml&quot;&gt;<br /> &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; ?&gt;<br /> &lt;extension type=&quot;package&quot; version=&quot;1.6&quot;&gt;<br /> &lt;name&gt;Hello World Package&lt;/name&gt;<br /> &lt;author&gt;Hello World Package Team&lt;/author&gt;<br /> &lt;creationDate&gt;May 2012&lt;/creationDate&gt;<br /> &lt;packagename&gt;helloworld&lt;/packagename&gt;<br /> &lt;version&gt;1.0.0&lt;/version&gt;<br /> &lt;url&gt;http://www.yoururl.com/&lt;/url&gt;<br /> &lt;packager&gt;Hello World Package Team&lt;/packager&gt;<br /> &lt;packagerurl&gt;http://www.yoururl.com/&lt;/packagerurl&gt;<br /> &lt;description&gt;Example package to combine multiple extensions&lt;/description&gt;<br /> &lt;update&gt;http://www.updateurl.com/update&lt;/update&gt;<br /> &lt;files folder=&quot;packages&quot;&gt;<br /> &lt;file type=&quot;component&quot; id=&quot;helloworld&quot; &gt;com_helloworld.zip&lt;/file&gt;<br /> &lt;file type=&quot;module&quot; id=&quot;helloworld&quot; client=&quot;site&quot;&gt;mod_helloworld.zip&lt;/file&gt;<br /> &lt;file type=&quot;library&quot; id=&quot;helloworld&quot;&gt;lib_helloworld.zip&lt;/file&gt;<br /> &lt;file type=&quot;plugin&quot; id=&quot;helloworld&quot; group=&quot;system&quot;&gt;plg_sys_helloworld.zip&lt;/file&gt;<br /> &lt;file type=&quot;template&quot; id=&quot;helloworld&quot; client=&quot;site&quot;&gt;tpl_helloworld.zip&lt;/file&gt;<br /> &lt;/files&gt;<br /> &lt;/extension&gt;<br /> &lt;/source&gt;<br /> <br /> When you zip this and try to install it, you will see that every extension will be installed. Also the package will be visible in the extension list to uninstall all the extension of this package. <br /> <br /> Remember to use the package uninstaller instead of individual subpackage uninstallers to avoid orphan extension entries in the extension manager.<br /> <br /> [[Category:Extensions| Package]]</div>

Phproberto https://docs.sandbox.joomla.org/index.php?title=Package&diff=67391 2012-05-28T23:09:00Z

<p>Phproberto: Added library and system plugin examples. Fix bad ids that cause issues uninstalling package. Also added author and creation date that will be shown in extension manager</p> <hr /> <div>== What is a package? ==<br /> <br /> A package is a extension that is used to install multiple extensions in one go. This is used if you have for example a component and a module that are depending on each other. Combining them in a package will let the user install and uninstall both extensions in one go. Package extensions can be used with Joomla [[File:Compat icon 1 6.png]] and higher.<br /> <br /> == How do I create a package? ==<br /> <br /> A package extension is created by zipping all zip files of the extensions together with a xml manifest file. For example if you have a package composed by:<br /> <br /> * '''component''' helloworld<br /> * '''module''' helloworld<br /> * '''library''' helloworld <br /> * '''system plugin''' helloworld <br /> <br /> The package should have the following tree in your zipfile:<br /> <br /> -- pkg_helloworld.xml<br /> -- packages &lt;dir&gt;<br /> |-- com_helloworld.zip<br /> |-- mod_helloworld.zip<br /> |-- lib_helloworld.zip<br /> |-- plg_sys_helloworld.zip<br /> <br /> The pkg_helloworld.xml could have the following contents:<br /> <br /> &lt;source lang=&quot;xml&quot;&gt;<br /> &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; ?&gt;<br /> &lt;extension type=&quot;package&quot; version=&quot;1.6&quot;&gt;<br /> &lt;name&gt;Hello World Package&lt;/name&gt;<br /> &lt;author&gt;Hello World Package Team&lt;/author&gt;<br /> &lt;creationDate&gt;May 2012&lt;/creationDate&gt;<br /> &lt;packagename&gt;helloworld&lt;/packagename&gt;<br /> &lt;version&gt;1.0.0&lt;/version&gt;<br /> &lt;url&gt;http://www.yoururl.com/&lt;/url&gt;<br /> &lt;packager&gt;Hello World Package Team&lt;/packager&gt;<br /> &lt;packagerurl&gt;http://www.yoururl.com/&lt;/packagerurl&gt;<br /> &lt;description&gt;Example package to combine multiple extensions&lt;/description&gt;<br /> &lt;update&gt;http://www.updateurl.com/update&lt;/update&gt;<br /> &lt;files folder=&quot;packages&quot;&gt;<br /> &lt;file type=&quot;component&quot; id=&quot;helloworld&quot; &gt;com_helloworld.zip&lt;/file&gt;<br /> &lt;file type=&quot;module&quot; id=&quot;helloworld&quot; client=&quot;site&quot;&gt;mod_helloworld.zip&lt;/file&gt;<br /> &lt;file type=&quot;library&quot; id=&quot;helloworld&quot;&gt;lib_helloworld.zip&lt;/file&gt;<br /> &lt;file type=&quot;plugin&quot; id=&quot;helloworld&quot; group=&quot;system&quot;&gt;plg_sys_helloworld.zip&lt;/file&gt;<br /> &lt;/files&gt;<br /> &lt;/extension&gt;<br /> &lt;/source&gt;<br /> <br /> When you zip this and try to install it, you will see that every extension will be installed. Also the package will be visible in the extension list to uninstall all the extension of this package. <br /> <br /> Remember to use the package uninstaller instead of individual subpackage uninstallers to avoid orphan extension entries in the extension manager.<br /> <br /> [[Category:Extensions| Package]]</div>

Phproberto