Dirk: Fixed HTML tag mismatch

2009-02-06T13:34:00Z

Fixed HTML tag mismatch

Dirk: PLG itemSaved

2009-02-06T09:46:42Z

PLG itemSaved

New page

= Introduction =

The motivation for <code>PLG_itemSaved</code> is to have a call that plugins can hook into whenever Geeklog (or another plugin) saves one of its items (article, comment, ...) so that plugins can perform actions on their own if they want to track changes on an item.

The original implementation, however, was very complex and included a rollback mechanism that was called when one of the plugins indicated a problem. As a result, it was only ever implemented for stories (and not even correctly at that ...).

So as of Geeklog 1.6.0, this API has been simplified and implemented not only for stories but also for Events, Links, Polls, and Static Pages (more to come).

= The API =

<pre>function PLG_itemSaved($id, $type, $old_id = '')</pre>

where <code>$id</code> is the unique ID of the item being saved. If the item's ID is changed with this save operation, then <code>$id</code> will contain the new ID and <code>$old_id</code> contains the previous ID (otherwise it's empty).

<code>$type</code> is the item's type, e.g. <code>'article'</code> for a story. For plugins, the item's type is usually identical with the plugin's internal name, e.g. <code>'links'</code> for a link from the Links plugin.

== Subtypes ==

''(not finalized yet)''

For plugins that support more than one type of item (e.g. the Links plugin, which has links and link categories), the type can consist of two parts: The main type (identical with the plugin's name) and a subtype, separated by a dot <code>'.'</code>, e.g.

<code>links.category</code>

== Return value ==

The return value of <code>PLG_itemSaved</code> is <code>void</code>, i.e. it does not return anything (actually, it does currently return <code>false</code> for backward compatibility with the old API implementation but that should not be relied upon).

= PLG_itemDeleted =

When an item is deleted, <code>PLG_itemDeleted</code> is called (<code>PLG_itemSaved</code> is ''not'' called for deleted items):

<pre>function PLG_itemDeleted($id, $type)</code>

[[Category:Plugin Development]]</pre>

@@ Line 31: / Line 31: @@
 When an item is deleted, <code>PLG_itemDeleted</code> is called (<code>PLG_itemSaved</code> is ''not'' called for deleted items):
-<pre>function PLG_itemDeleted($id, $type)</code>
+<pre>function PLG_itemDeleted($id, $type)</pre>
-[[Category:Plugin Development]]</pre>
+[[Category:Plugin Development]]

PLG itemSaved - Revision history

Dirk: Fixed HTML tag mismatch

Dirk: PLG itemSaved