Plugin Hooks

The easiest way to understand how the ParaInvite plugin system works is look through the files of the ParaInvite Core plugin (plg_parainvite_core.zip). After installation, the files are located in /plugins/parainvite/core.

If you need professional service to help you create your own hook with other 3rd party extensions, please contact us for a free quote.

To create your own plugin that works with ParaInvite, first create the manifest XML file:

<?xml version="1.0" encoding="utf-8"?>
<extension version="3.0" method="upgrade" type="plugin" group="parainvite">
	<name>Example</name>
	<author>Mike Feng</author>
	<creationDate>June 2016</creationDate>
	<copyright>Copyright (C) 2016 simbunch.com</copyright>
	<license>GNU General Public License version 2 or later</license>
	<authorEmail>This email address is being protected from spambots. You need JavaScript enabled to view it.</authorEmail>
	<authorUrl>www.simbunch.com</authorUrl>
	<version>1.0.0</version>
	<isapplication>true</isapplication>
	<description>This is the description for this plugin</description>
	<files>
		<filename plugin="example">example.php</filename>
		<filename>index.html</filename>
	</files>
	<languages>
		<language tag="en-GB">en-GB.plg_parainvite_example.ini</language>
		<language tag="en-GB">en-GB.plg_parainvite_example.sys.ini</language>
	</languages>
</extension>

Create a example.php where all the plugin hooks will go in. For example, you can refer to core.php in the Core plugin. Begin the class declaration with:

<?php
defined('_JEXEC') or die('Restricted access');
class plgParaInviteExample extends JPlugin {
	
	protected $autoloadLanguage = true;
	 
	function __construct(&$subject, $config) {
		parent::__construct($subject, $config);
		require_once JPATH_ROOT.'/components/com_parainvite/helpers/core.php';
	}
}
?>

The hook functions include:

onContactAdd

When contact is added during Step 2 of invite process. Called during default invitation only.

onContactsAdded

After all contacts are added during Step 2 of invite process. Called during default invitation only.

onInviteSent

When an invite is sent during Step 3 of invite process. Called during default invitation only.

onShareSent

When an invite is sent via content sharing. Called during content sharing only.

onInvitesSent

After all invites are sent during Step 3 of invite process. Called after default invitation only.

onSharesSent

After all invites are sent via content sharing. Called after content sharing only.

onInvitesResend

Called only when user resends invites from the History page. Called after all invites are sent.

onInviteAccepted

When an invited user successfully registers on your site.