Class: Plugin

Source Location: /blogs/inc/_misc/_plugin.class.php

Class Plugin

Class Overview

Plugin Class

Real plugins should be derived from this class.

Located in /blogs/inc/_misc/_plugin.class.php [line 47]

Author(s):

API Tags:

Abstract:

Properties

Methods

[ Top ]

Direct descendents

Child Class	Description
autolinks_plugin
pluginname_plugin	PLUGIN_NAME Plugin
wikilinks_plugin
quicktags_plugin
basic_antispam_plugin	Basic Antispam Plugin
wacko_plugin
texturize_plugin
gmcode_plugin	Replaces GreyMatter markup in HTML (not XML).
test_plugin	TEST Plugin
bbcode_plugin
calendar_plugin	Calendar Plugin
ping_b2evonet_plugin	Pingomatic plugin.
ping_pingomatic_plugin	Pingomatic plugin.
generic_ping_plugin	Generic Ping Plugin
categories_plugin	Categories Plugin
bookmarklet_plugin	Sidebar plugin
smilies_plugin
auto_p_plugin	The Auto-P Plugin.
archives_plugin	Archives Plugin

[ Top ]

Property Summary

string	$apply_rendering	If this is a rendering plugin, when should rendering apply?
string	$author	Plugin author.
string	$code	Globally unique code for this plugin functionality. 32 chars. MUST BE SET.
string	$group	Main group of the plugin.
string	$help_url	URL for more info about the plugin, author and new versions.
string	$long_desc	Plugin long description.
string	$name	Default plugin name as it will appear in lists.
mixed	$number_of_installs	Number of allowed installs.
string	$ping_service_name	Name of the ping service (if this is a ping plugin, see Plugin::ItemSendPing())
string	$ping_service_note	Note about the ping service, used in the list of ping services in the blog settings
int	$priority	Default priority.
string	$short_desc	Plugin short description.
string	$sub_group	Sub-Group of the plugin.
string	$version	Plugin version number (max 42 chars, so obscure CVS Revision keywords get handled).

[ Top ]

Method Summary

Plugin	Plugin()	Constructor.
void	AdminAfterMenuInit()	Event handler: Gets invoked in /admin/_header.php for every backoffice page after the menu structure is build. You could use the $AdminUI object to modify it.
boolean	AdminAfterPageFooter()	Event handler: Called right after displaying the admin page footer.
void	AdminBeforeItemEditCreate()	Event handler: Called before a new item gets created (in the backoffice).
void	AdminBeforeItemEditUpdate()	Event handler: Called before an existing item gets updated (in the backoffice).
void	AdminBeginPayload()	Event handler: Gets invoked before the main payload in the backoffice.
boolean	AdminDisplayEditorButton()	Event handler: Called when displaying editor buttons.
boolean	AdminDisplayItemFormFieldset()	Event handler: Called at the end of the "Edit item" form.
boolean	AdminDisplayToolbar()	Event handler: Called when displaying editor toolbars.
boolean	AdminEndHtmlHead()	Event handler: Called when ending the admin html head section.
void	AdminTabAction()	Event handler: Method that gets invoked when our tab is selected.
boolean	AdminTabPayload()	Event handler: Gets invoked when our tab is selected and should get displayed.
void	AdminToolAction()	Event handler: Called when handling actions for the "Tools" menu.
boolean	AdminToolPayload()	Event handler: Called when displaying the block in the "Tools" menu.
void	AfterCommentDelete()	Event handler: called at the end of deleting a comment from the database.
void	AfterCommentFormInsert()	Event handler: Called when a comment form has been processed and the comment got inserted into DB.
void	AfterCommentInsert()	Event handler: called at the end of inserting a comment into the database, which means it has been created.
void	AfterCommentUpdate()	Event handler: called at the end of updating a comment in the database, which means that it has changed.
void	AfterInstall()	Event handler: Called after the plugin has been installed.
void	AfterItemDelete()	Event handler: called at the end of deleting an item/post from the database.
void	AfterItemInsert()	Event handler: called at the end of inserting a item/post into the database, which means it has been created.
void	AfterItemUpdate()	Event handler: called at the end of updating an item/post in the database, which means that it has been changed.
void	AfterLoginAnonymousUser()	Event handler: Called at the end of the login procedure, if the user is anonymous ($current_User NOT set).
void	AfterLoginRegisteredUser()	Event handler: Called at the end of the login procedure, if the $current_User is set and the user is therefor registered.
void	AfterUserDelete()	Event handler: called at the end of deleting an user from the database.
void	AfterUserInsert()	Event handler: called at the end of inserting an user account into the database, which means it has been created.
void	AfterUserRegistration()	Event handler: Called when a new user has registered and got created.
void	AfterUserUpdate()	Event handler: called at the end of updating an user account in the database, which means that it has been changed.
boolean	AlternateAuthentication()	Event handler: called at the end of the login process, if the user did not try to login (by sending "login" and "pwd"), the session has no user attached or only "login" is given.
void	AppendItemPreviewTransact()	Event handler: called when instantiating an Item for preview.
boolean	AppendUserRegistrTransact()	Event handler: Called when a new user has registered, at the end of the DB transaction that created this user.
boolean	are_events_available()	Check if the requested list of events is provided by any or one plugin.
void	BeforeBlogDisplay()	Event handler: Called before a blog gets displayed (in _blog_main.inc.php).
void	BeforeCommentFormInsert()	Event handler: Called before a comment gets inserted through the public comment form.
void	BeforeDisable()	Event handler: Your plugin gets notified here, just before it gets disabled.
true\|string	BeforeEnable()	Event handler: Called when the admin tries to enable the plugin, changes its configuration/settings and after installation.
true\|string	BeforeInstall()	Event handler: Called before the plugin is going to be installed.
void	BeforeTrackbackInsert()	Event handler: called before a trackback gets recorded.
boolean\|NULL	BeforeUninstall()	Event handler: Called before the plugin is going to be un-installed.
void	BeforeUninstallPayload()	Event handler: Gets invoked to display the payload before uninstalling the plugin.
boolean	CacheIsCollectingContent()	Event handler: gets asked for if we are generating cached content.
boolean	CacheObjects()	Event handler: called to cache object data.
boolean	CachePageContent()	Event handler: called to cache page content (get cached content or request caching).
boolean	CaptchaPayload()	Event handler: general event to inject payload for a captcha test.
boolean	CaptchaValidated()	Event handler: general event to validate a captcha which payload was added through CaptchaPayload().
void	CaptchaValidatedCleanup()	Event handler: general event to be called after an action has been taken, which involved CaptchaPayload() and CaptchaValidated().
void	code()	Template function: display plugin code
void	debug_log()	Log a debug message.
boolean	disable_event()	Disable an event.
void	DisplayCommentFormButton()	Event handler: Called in the submit button section of the frontend comment form.
void	DisplayCommentFormFieldset()	Event handler: Called at the end of the frontend comment form.
boolean	DisplayCommentToolbar()	Event handler: Called when displaying editor toolbars.
boolean	DisplayItemAsHtml()	Event handler: Called when displaying an item/post's content as HTML.
boolean	DisplayItemAsText()	Event handler: Called when displaying an item/post's content as text.
boolean	DisplayItemAsXml()	Event handler: Called when displaying an item/post's content as XML.
void	DisplayLoginFormFieldset()	Event handler: Called at the end of the "Login" form.
void	DisplayMessageFormButton()	Event handler: Called in the submit button section of the frontend message form.
void	DisplayMessageFormFieldset()	Event handler: Called at the end of the frontend message form, which allows to send an email to a user/commentator.
void	DisplayRegisterFormFieldset()	Event handler: Called at the end of the "Register as new user" form.
void	DisplaySkin()	Event handler: Display a skin. Use Plugin::GetProvidedSkins() to return a list of names that you register.
void	DisplayTrackbackAddr()	Event handler: called to display the URL that accepts trackbacks for an item.
void	DisplayValidateAccountFormFieldset()	Event handler: Called at the end of the "Validate user account" form, which gets invoked if newusers_mustvalidate is enabled and the user has not been validated yet.
boolean	enable_event()	Enable an event.
array	ExecCronJob()	Execute/handle a cron job, which has been scheduled by the admin out of the list that the Plugin provides (see GetCronJobs()).
void	FilterCommentAuthor()	Event handler: called to filter the comment's author name (blog name for trackbacks)
void	FilterCommentAuthorUrl()	Event handler: called to filter the comment's author URL
void	FilterCommentContent()	Event handler: called to filter the comment's content
boolean	FilterIpAddress()	Event handler: Called when an IP address gets displayed, typically in a protected area or for a privileged user, e.g. in the backoffice statistics menu.
void	forget_events()	Call this to unregister all your events for the current request.
array	GetCronJobs()	This method gets asked for a list of cronjobs that the plugin provides.
void	GetDbLayout()	This method should return your DB schema, consisting of a list of CREATE TABLE queries.
array	GetDefaultSettings()	Define here default settings that are then available in the backoffice.
array	GetDefaultUserSettings()	Define here default user settings that are then available in the backoffice.
array	GetDependencies()	Get the list of dependencies that the plugin has.
NULL\|array	GetExtraEvents()	This method gets asked when plugins get installed and allows you to return a list of extra events, which your plugin triggers itself (e.g. through $Plugins->trigger_event()).
array	GetHtsrvMethods()	Override this method to define methods/functions that you want to make accessible through /htsrv/call_plugin.php, which allows you to call those methods by HTTP request.
array	GetProvidedSkins()	Event handler: Gets asked about a list of skin names that the plugin handles.
integer\|NULL	GetSpamKarmaForComment()	Event handler: Called to ask the plugin for the spam karma of a comment.
string	get_class_id()	Get a string, unqiue for the plugin, usable in HTML form elements.
false\|string	get_edit_settings_link()	Get a link to edit the Plugin's settings (if the user has permission).
false\|string	get_help_file()	Get the help file for a Plugin ID. README.LOCALE.html will take precedence above the general (english) README.html.
string	get_help_link()	Get a link to a help page (with icon).
string	get_help_url()	Get the plugin's external help/website URL.
string	get_htsrv_url()	Get the URL to call a plugin method through http. This links to the /htsrv/call_plugin.php file.
string	get_plugin_url()	Get the absolute URL to the plugin's directory (where the plugins classfile is).
void	get_README_link()
string	get_sql_table()	Get canonical name for database tables a plugin uses, by adding an unique prefix for your plugin instance.
boolean\|NULL	ItemApplyAsRenderer()	Event handler: Does your Plugin want to apply as a renderer for the item?
boolean\|string	ItemCanComment()	Event handler: the plugin gets asked if an item can receive feedback/comments.
boolean	ItemSendPing()	Event handler: send a ping about a new item.
void	ItemViewsIncreased()	Event handler: Called when the view counter of an item got increased.
void	LoginAttempt()	Event handler: called when a user attemps to login.
void	Logout()	Event handler: called when a user logs out.
string	long_desc()	Template function: display long description for plug in
void	MessageFormSent()	Event handler: Called when a message form has been submitted.
void	MessageFormSentCleanup()	Event handler: Called after a message has been sent through the public email form.
void	msg()	A simple wrapper around the $Messages object with a default catgory of 'note'.
string	name()	Template function: Get displayable plugin name.
boolean	PluginInit()	Init the Plugin after it has been registered/instantiated.
void	PluginSettingsEditAction()	Event handler: Called as action before displaying the "Edit plugin" form, which includes the display of the Plugin::Settings.
void	PluginSettingsEditDisplayAfter()	Event handler: Called after the form to edit the Plugin::Settings has been displayed.
false\|NULL	PluginSettingsUpdateAction()	Event handler: Called as action just before updating the Plugin::Settings.
string\|NULL	PluginSettingsValidateSet()	Event handler: Called before displaying or setting a plugin's setting in the backoffice.
void	PluginUserSettingsEditAction()	Event handler: Called as action before displaying the "Edit user" form, which includes the display of the Plugin::UserSettings.
void	PluginUserSettingsEditDisplayAfter()	Event handler: Called after the form to edit the Plugin::UserSettings has been displayed.
false\|NULL	PluginUserSettingsUpdateAction()	Event handler: Called as action just before updating the Plugin::UserSettings.
string\|NULL	PluginUserSettingsValidateSet()	Event handler: Called before displaying or setting a plugin's user setting in the backoffice.
boolean	PluginVersionChanged()	Event handler: Called when we detect a version change (in Plugins::register()).
void	PrependItemInsertTransact()	Event handler: called at the beginning of inserting an item/post in the database.
void	PrependItemUpdateTransact()	Event handler: called at the beginning of updating an item/post in the database.
void	RegisterFormSent()	Event handler: Called when a "Register as new user" form has been submitted.
void	register_menu_entry()	Register a tab (sub-menu) for the backoffice Tools menus.
boolean	RenderItemAsHtml()	Event handler: Called when rendering item/post contents as HTML.
boolean	RenderItemAsText()	Event handler: Called when rendering item/post contents other than XML or HTML.
boolean	RenderItemAsXml()	Event handler: Called when rendering item/post contents as XML.
void	SessionLoaded()	Event handler: Called after initializing plugins, DB, Settings, Hit, .. but quite early.
void	session_delete()	Delete a value from the session data, using a unique prefix to the Plugin.
mixed\|NULL	session_get()	Get a data value for the session, using a unique prefix to the Plugin.
void	session_set()	Set a data value for the session.
void	set_param()	Set param value.
boolean	set_status()	Set the status of the plugin.
string	short_desc()	Template function: display short description for plug in
void	SkinBeginHtmlHead()	Event handler: Called at the beginning of the skin's HTML HEAD section.
void	stop_propagation()	Stop propagation of the event to next plugins (with lower priority) in events that get triggered for a batch of Plugins.
string	T_()	Translate a given string, in the Plugin's context.
void	ValidateAccountFormSent()	Event handler: Called when a "Validate user account" form has been submitted.
void	__get()	PHP5 overloading of get method to lazy-load (User)Settings.

[ Top ]

Properties

string $apply_rendering = 'never' [line 170]

If this is a rendering plugin, when should rendering apply?

Variables below MAY be overriden. This is the default value for the plugin and can be overriden in the Plugins administration for plugins that provide rendering events.

Possible values:

'stealth': gets always used, but not displayed as option
'always': gets always used, and displayed as disabled checkbox
'opt-out': enabled by default
'opt-in': disabled by default
'lazy': checkbox gets displayed, but is disabled
'never': cannot get used as a renderer

Information Tags:

Todo:

blueyed>> IMHO we would need another value, which is the same as "lazy", but does not display a checkbox, which is useful for Plugins that add themselves as renderers on Item update

Redefined in descendants as:

[ Top ]

string $author = 'Unknown author' [line 110]

Plugin author.

Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.

This is for user info only.

Redefined in descendants as:

[ Top ]

string $code = '' [line 75]

Globally unique code for this plugin functionality. 32 chars. MUST BE SET.

Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.

A common code MIGHT be shared between different plugins providing the same functionnality. This allows to replace a given renderer with another one and keep the associations with posts. Example: replacing a GIF smiley renderer with an SWF smiley renderer...

Redefined in descendants as:

autolinks_plugin::$code
pluginname_plugin::$code : Code, if this is a renderer or pingback plugin.
wikilinks_plugin::$code
quicktags_plugin::$code
basic_antispam_plugin::$code
wacko_plugin::$code
texturize_plugin::$code
gmcode_plugin::$code
test_plugin::$code
bbcode_plugin::$code
calendar_plugin::$code
ping_b2evonet_plugin::$code : Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.
ping_pingomatic_plugin::$code : Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.
generic_ping_plugin::$code : Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.
categories_plugin::$code
bookmarklet_plugin::$code
smilies_plugin::$code
auto_p_plugin::$code
archives_plugin::$code

[ Top ]

string $group [line 187]

Main group of the plugin.

Variables below MAY be overriden.

Redefined in descendants as:

[ Top ]

string $help_url = '' [line 122]

URL for more info about the plugin, author and new versions.

Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.

This is for user info only.

If empty, it defaults to 'http://manual.b2evolution.net/Plugins/[plugin_classname]', where '[plugin_classname]' is the plugin's PHP class name.

Redefined in descendants as:

[ Top ]

string $long_desc [line 147]

Plugin long description.

Variables below MAY be overriden.

This should be no longer than a line.

Redefined in descendants as:

[ Top ]

string $name = '' [line 64]

Default plugin name as it will appear in lists.

Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.

To make it available for translations set it in the constructor by using the Plugin::T_() function.

This should be no longer than 50 characters.

Redefined in descendants as:

autolinks_plugin::$name
pluginname_plugin::$name : Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.
wikilinks_plugin::$name
quicktags_plugin::$name
basic_antispam_plugin::$name : Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.
wacko_plugin::$name
texturize_plugin::$name
gmcode_plugin::$name
test_plugin::$name : Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.
bbcode_plugin::$name
calendar_plugin::$name : Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.
categories_plugin::$name : Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.
bookmarklet_plugin::$name
smilies_plugin::$name
auto_p_plugin::$name
archives_plugin::$name : Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.

[ Top ]

mixed $number_of_installs [line 179]

Number of allowed installs.

Variables below MAY be overriden.

When installing the plugin it gets checked if the plugin is already installed this many times. If so, the installation gets aborted.

Redefined in descendants as:

test_plugin::$number_of_installs

[ Top ]

string $ping_service_name [line 202]

Name of the ping service (if this is a ping plugin, see Plugin::ItemSendPing())

Variables below MAY be overriden.

[ Top ]

string $ping_service_note [line 209]

Note about the ping service, used in the list of ping services in the blog settings

Variables below MAY be overriden. (if this is a ping plugin, see Plugin::ItemSendPing())

[ Top ]

int $priority = 50 [line 85]

Default priority.

Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.

Priority determines in which order the plugins get called. Range: 1 to 100 (the lower the number, the earlier it gets called)

Redefined in descendants as:

[ Top ]

string $short_desc [line 131]

Plugin short description.

Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.

This should be no longer than a line and is limited to 255 chars.

Redefined in descendants as:

[ Top ]

string $sub_group [line 195]

Sub-Group of the plugin.

Variables below MAY be overriden.

[ Top ]

string $version = '0' [line 101]

Plugin version number (max 42 chars, so obscure CVS Revision keywords get handled).

Variables below MUST be overriden by plugin implementations, either in the subclass declaration or in the subclass constructor.

This must be compatible to PHP's http://www.php.net/version_compare, e.g. '1', '2', '1.1', '2.1b' and '10-1-1a' are fine.

This can be used by other plugins when requiring your plugin through Plugin::GetDependencies().

By increasing it you can request a call of GetDbLayout() upon instantiating. If there are DB layout changes to be made, the plugin gets changed to status "needs_config".

Redefined in descendants as:

[ Top ]

Methods

Constructor Plugin [line 312]

Plugin Plugin(
)

Constructor.

You should not use a constructor with your plugin, but the Plugin::PluginInit() method instead!

[ Top ]

AdminAfterMenuInit [line 679]

void AdminAfterMenuInit(
)

Event handler: Gets invoked in /admin/_header.php for every backoffice page after the menu structure is build. You could use the $AdminUI object to modify it.

This is the hook to register menu entries. See register_menu_entry().

Redefined in descendants as:

test_plugin::AdminAfterMenuInit() : Event handler: Gets invoked in /admin/_header.php for every backoffice page after the menu structure is build. You can use the $AdminUI object to modify it.

[ Top ]

AdminAfterPageFooter [line 704]

boolean AdminAfterPageFooter(
array
&$params 
)

Event handler: Called right after displaying the admin page footer.

Parameters:

array

&$params:

Associative array of parameters

API Tags:

Return:

did we do something?

Redefined in descendants as:

test_plugin::AdminAfterPageFooter() : Event handler: Called right after displaying the admin page footer.

[ Top ]

AdminBeforeItemEditCreate [line 1221]

void AdminBeforeItemEditCreate(
array
&$params 
)

Event handler: Called before a new item gets created (in the backoffice).

You could add a message of category "error" here, to prevent the comment from being inserted.

Parameters:

array

&$params:

Associative array of parameters 'Item': the Item which gets created (by reference)

Redefined in descendants as:

test_plugin::AdminBeforeItemEditCreate()

[ Top ]

AdminBeforeItemEditUpdate [line 1235]

void AdminBeforeItemEditUpdate(
array
&$params 
)

Event handler: Called before an existing item gets updated (in the backoffice).

You could add a message of category "error" here, to prevent the comment from being inserted.

Parameters:

array

&$params:

Associative array of parameters 'Item': the Item which gets updated (by reference)

Redefined in descendants as:

test_plugin::AdminBeforeItemEditUpdate()

[ Top ]

AdminBeginPayload [line 801]

void AdminBeginPayload(
)

Event handler: Gets invoked before the main payload in the backoffice.

Redefined in descendants as:

test_plugin::AdminBeginPayload() : Event handler: Gets invoked before the main payload in the backoffice.

[ Top ]

AdminDisplayEditorButton [line 725]

boolean AdminDisplayEditorButton(
array
$params 
)

Event handler: Called when displaying editor buttons.

This method, if implemented, should output the buttons (probably as html INPUT elements) and return true, if button(s) have been displayed.

You should provide an unique html ID with your button.

Parameters:

array

$params:

Associative array of parameters.

'target_type': either 'Comment' or 'Item'.
'edit_layout': "simple", "expert", etc. (users, hackers, plugins, etc. may create their own layouts in addition to these) NOTE: Please respect the "simple" mode, which should display only the most simple things!

API Tags:

Return:

did we display a button?

Redefined in descendants as:

test_plugin::AdminDisplayEditorButton() : Event handler: Called when displaying editor buttons.

[ Top ]

AdminDisplayItemFormFieldset [line 1206]

boolean AdminDisplayItemFormFieldset(
array
&$params 
)

Event handler: Called at the end of the "Edit item" form.

Parameters:

array

&$params:

Associative array of parameters

'Form': the Form object (by reference)
'Item': the Item which gets edited (by reference)
'edit_layout': "simple", "expert", etc. (users, hackers, plugins, etc. may create their own layouts in addition to these) NOTE: Please respect the "simple" mode, which should display only the most simple things!

API Tags:

Return:

did we display something?

Redefined in descendants as:

test_plugin::AdminDisplayItemFormFieldset()

[ Top ]

AdminDisplayToolbar [line 745]

boolean AdminDisplayToolbar(
array
&$params 
)

Event handler: Called when displaying editor toolbars.

Parameters:

array

&$params:

Associative array of parameters

'target_type': either 'Comment' or 'Item'.
'edit_layout': "simple", "expert", etc. (users, hackers, plugins, etc. may create their own layouts in addition to these) NOTE: Please respect the "simple" mode, which should display only the most simple things!

API Tags:

Return:

did we display a toolbar?

Redefined in descendants as:

quicktags_plugin::AdminDisplayToolbar() : Display a toolbar
test_plugin::AdminDisplayToolbar() : Event handler: Called when displaying editor toolbars.
smilies_plugin::AdminDisplayToolbar() : Display a toolbar in admin

[ Top ]

AdminEndHtmlHead [line 692]

boolean AdminEndHtmlHead(
array
&$params 
)

Event handler: Called when ending the admin html head section.

Parameters:

array

&$params:

Associative array of parameters

API Tags:

Return:

did we do something?

Redefined in descendants as:

test_plugin::AdminEndHtmlHead() : Event handler: Called when ending the admin html head section.

[ Top ]

AdminTabAction [line 780]

void AdminTabAction(
)

Event handler: Method that gets invoked when our tab is selected.

You should catch (your own) params (using param()) here and do actions (but no output!).

Use msg() to add messages for the user.

Redefined in descendants as:

test_plugin::AdminTabAction() : Event handler: Method that gets invoked when our tab (?tab=plug_ID_X) is selected.

[ Top ]

AdminTabPayload [line 792]

boolean AdminTabPayload(
)

Event handler: Gets invoked when our tab is selected and should get displayed.

Do your output here.

API Tags:

Return:

did we display something?

Redefined in descendants as:

test_plugin::AdminTabPayload() : Event handler: Gets invoked when our tab is selected and should get displayed.

[ Top ]

AdminToolAction [line 756]

void AdminToolAction(
)

Event handler: Called when handling actions for the "Tools" menu.

Use msg() to add messages for the user.

Redefined in descendants as:

test_plugin::AdminToolAction() : Event handler: Called when handling actions for the "Tools" menu.

[ Top ]

AdminToolPayload [line 766]

boolean AdminToolPayload(
)

Event handler: Called when displaying the block in the "Tools" menu.

API Tags:

Return:

did we display something?

Redefined in descendants as:

test_plugin::AdminToolPayload() : Event handler: Called when displaying the block in the "Tools" menu.
bookmarklet_plugin::AdminToolPayload() : We are displaying the tool menu.

[ Top ]

AfterCommentDelete [line 1434]

void AfterCommentDelete(
array
&$params 
)

Event handler: called at the end of deleting a comment from the database.

Parameters:

array

&$params:

Associative array of parameters

'Comment': the related Comment (by reference)

[ Top ]

AfterCommentFormInsert [line 1372]

void AfterCommentFormInsert(
array
&$params 
)

Event handler: Called when a comment form has been processed and the comment got inserted into DB.

Parameters:

array

&$params:

Associative array of parameters

'Comment': the Comment (by reference)
'original_comment': this is the unstripped and unformated posted comment, use with care!

[ Top ]

AfterCommentInsert [line 1422]

void AfterCommentInsert(
array
&$params 
)

Event handler: called at the end of inserting a comment into the database, which means it has been created.

Parameters:

array

&$params:

Associative array of parameters

'Comment': the related Comment (by reference)
'dbchanges': array with DB changes; a copy of Comment::dbchanges(), before they got applied (since 1.9)

[ Top ]

AfterCommentUpdate [line 1408]

void AfterCommentUpdate(
array
&$params 
)

Event handler: called at the end of updating a comment in the database, which means that it has changed.

Parameters:

array

&$params:

Associative array of parameters

'Comment': the related Comment (by reference)
'dbchanges': array with DB changes; a copy of Comment::dbchanges(), before they got applied (since 1.9)

[ Top ]

AfterInstall [line 879]

void AfterInstall(
)

Event handler: Called after the plugin has been installed.

Redefined in descendants as:

basic_antispam_plugin::AfterInstall() : Check if the deprecated hit_doublecheck_referer setting is set and then do not disable the AppendHitLog event. Also removes the old setting.
test_plugin::AfterInstall() : Event handler: Called when the plugin has been installed.

[ Top ]

AfterItemDelete [line 1169]

void AfterItemDelete(
array
&$params 
)

Event handler: called at the end of deleting an item/post from the database.

Parameters:

array

&$params:

Associative array of parameters

'Item': the related Item (by reference)

[ Top ]

AfterItemInsert [line 1157]

void AfterItemInsert(
array
&$params 
)

Event handler: called at the end of inserting a item/post into the database, which means it has been created.

Parameters:

array

&$params:

Associative array of parameters

'Item': the related Item (by reference)
'dbchanges': array with DB changes; a copy of Item::dbchanges(), before they got applied (since 1.9)

[ Top ]

AfterItemUpdate [line 1128]

void AfterItemUpdate(
array
&$params 
)

Event handler: called at the end of updating an item/post in the database, which means that it has been changed.

Parameters:

array

&$params:

Associative array of parameters

'Item': the related Item (by reference)
'dbchanges': array with DB changes; a copy of Item::dbchanges(), before they got applied (since 1.9)

[ Top ]

AfterLoginAnonymousUser [line 1763]

void AfterLoginAnonymousUser(

&$params 
)

Event handler: Called at the end of the login procedure, if the user is anonymous ($current_User NOT set).

Use this for example to read some cookie and define further handling of this visitor or force them to login, by adding a message of class "login_error", which will trigger the login screen.

Parameters:

&$params:

[ Top ]

AfterLoginRegisteredUser [line 1781]

void AfterLoginRegisteredUser(

&$params 
)

Event handler: Called at the end of the login procedure, if the $current_User is set and the user is therefor registered.

Use this for example to re-act on specific Plugin::UserSettings, e.g., call Plugin::forget_events() to de-activate the plugin for the current request.

You can also add a message of class "login_error" to prevent the user from accessing the site and triggering the login screen.

Parameters:

&$params:

[ Top ]

AfterUserDelete [line 1980]

void AfterUserDelete(
array
&$params 
)

Event handler: called at the end of deleting an user from the database.

Parameters:

array

&$params:

Associative array of parameters

'User': the related User (by reference)

Information Tags:

Since:

1.8.1

[ Top ]

AfterUserInsert [line 1967]

void AfterUserInsert(
array
&$params 
)

Event handler: called at the end of inserting an user account into the database, which means it has been created.

Parameters:

array

&$params:

Associative array of parameters

'User': the related User (by reference)

Information Tags:

Since:

1.8.1

[ Top ]

AfterUserRegistration [line 1816]

void AfterUserRegistration(
array
&$params 
)

Event handler: Called when a new user has registered and got created.

Note: if you want to modify a new user, use Plugin::AppendUserRegistrTransact() instead!

Parameters:

array

&$params:

Associative array of parameters

'User': the user object (as reference).

Redefined in descendants as:

test_plugin::AfterUserRegistration() : Event handler: called when a new user has registered.

[ Top ]

AfterUserUpdate [line 1954]

void AfterUserUpdate(
array
&$params 
)

Event handler: called at the end of updating an user account in the database, which means that it has been changed.

Parameters:

array

&$params:

Associative array of parameters

'User': the related User (by reference)

Information Tags:

Since:

1.8.1

[ Top ]

AlternateAuthentication [line 1941]

boolean AlternateAuthentication(

&$params 
)

Event handler: called at the end of the login process, if the user did not try to login (by sending "login" and "pwd"), the session has no user attached or only "login" is given.

This hook is meant to automagically login/authenticate an user by his/her IP address, special cookie, etc..

If you can authenticate the user, you'll have to attach him to the $Session, either through Session::set_user_ID() or Session::set_User().

Parameters:

&$params:

API Tags:

Return:	True, if the user has been authentificated (set in $Session)
See:	Plugin::Logout()
See:	Plugin::LoginAttempt()

Redefined in descendants as:

test_plugin::AlternateAuthentication() : Automagically login every user as "demouser" who is not logged in and does not try to currently.

[ Top ]

AppendItemPreviewTransact [line 1180]

void AppendItemPreviewTransact(
array
&$params 
)

Event handler: called when instantiating an Item for preview.

Parameters:

array

&$params:

Associative array of parameters

'Item': the related Item (by reference)

[ Top ]

AppendUserRegistrTransact [line 1801]

boolean AppendUserRegistrTransact(
array
&$params 
)

Event handler: Called when a new user has registered, at the end of the DB transaction that created this user.

If you want to modify the about-to-be-created user (if the transaction gets committed), you'll have to call User::dbupdate() on it, because he got already inserted (but the transaction is not yet committed).

Note: if you want to re-act on a new user, use Plugin::AfterUserRegistration() instead!

Parameters:

array

&$params:

Associative array of parameters

'User': the user object (as reference).

API Tags:

Return:

false if the whole transaction should get rolled back (the user does not get created).

[ Top ]

are_events_available [line 2403]

boolean are_events_available(
array|string
$events, [boolean
$by_one_plugin = false] 
)

Check if the requested list of events is provided by any or one plugin.

Parameters:

array\|string	$events:	A single event or a list thereof
boolean	$by_one_plugin:	Make sure there's at least one plugin that provides them all? This is useful for event pairs like "CaptchaPayload" and "CaptchaValidated", which should be served by the same plugin.

[ Top ]

BeforeBlogDisplay [line 813]

void BeforeBlogDisplay(

&$params 
)

Event handler: Called before a blog gets displayed (in _blog_main.inc.php).

Parameters:

&$params:

[ Top ]

BeforeCommentFormInsert [line 1359]

void BeforeCommentFormInsert(
array
&$params 
)

Event handler: Called before a comment gets inserted through the public comment form.

Use this, to validate a comment: you could add a message of category "error" here, to prevent the comment from being inserted.

Parameters:

array

&$params:

Associative array of parameters

'Comment': the Comment (by reference)
'original_comment': this is the unstripped and unformated posted comment, use with care! (by reference)
'is_preview': is this a request for previewing the comment? (boolean)

API Tags:

See:

Plugin::DisplayCommentFormFieldset()

Redefined in descendants as:

basic_antispam_plugin::BeforeCommentFormInsert() : Check for duplicate comments.

[ Top ]

BeforeDisable [line 950]

void BeforeDisable(
)

Event handler: Your plugin gets notified here, just before it gets disabled.

You cannot prevent this, but only clean up stuff, if you have to.

[ Top ]

BeforeEnable [line 938]

true|string BeforeEnable(
)

Event handler: Called when the admin tries to enable the plugin, changes its configuration/settings and after installation.

Use this, if your plugin needs configuration before it can be used.

API Tags:

Return:

True, if the plugin can be enabled/activated, a string with an error/note otherwise.

Redefined in descendants as:

basic_antispam_plugin::BeforeEnable() : Disable/Enable events according to settings.
generic_ping_plugin::BeforeEnable() : Check ping service URL and plugin code.

[ Top ]

BeforeInstall [line 870]

true|string BeforeInstall(
)

Event handler: Called before the plugin is going to be installed.

This is the hook to create any DB tables or the like.

If you just want to add a note, use Plugin::msg() (and return true).

API Tags:

Return:

True, if the plugin can be enabled/activated, a string with an error/note otherwise.

Redefined in descendants as:

test_plugin::BeforeInstall() : Event handler: Called before the plugin is installed.

[ Top ]

BeforeTrackbackInsert [line 1453]

void BeforeTrackbackInsert(
array
&$params 
)

Event handler: called before a trackback gets recorded.

Use this, to validate a trackback: you could add a message of category "error" here, to prevent the trackback from being accepted.

Parameters:

array

&$params:

Associative array of parameters

"blog_name" => "author"
"url" => "author_url"
"title"/"excerpt" => "comment"

Redefined in descendants as:

basic_antispam_plugin::BeforeTrackbackInsert() : - Check for duplicate trackbacks.

[ Top ]

BeforeUninstall [line 906]

boolean|NULL BeforeUninstall(
array
&$params 
)

Event handler: Called before the plugin is going to be un-installed.

This is the hook to remove any files or the like - tables with canonical names (see Plugin::get_sql_table(), are handled internally.

See BeforeUninstallPayload() for the corresponding payload handler, which you can request to invoke by returning NULL here.

Note: this method gets called again, if the uninstallation has to be confirmed, either because you've requested a call to BeforeUninstallPayload() or there are tables to be dropped (what the admin user has to confirm).

Parameters:

array

&$params:

Associative array of parameters. 'unattended': true if Uninstall is unattended (e.g., the /install action "deletedb" uses it). This should cleanup everything without confirmation!

API Tags:

Return:

true when it's ok to uninstall, false on failure (the plugin won't get uninstalled then). You should add the reason for it through Plugin::msg(). NULL requests to execute the BeforeUninstallPayload() method.

Redefined in descendants as:

test_plugin::BeforeUninstall() : Event handler: Called before the plugin is going to be un-installed.

[ Top ]

BeforeUninstallPayload [line 924]

void BeforeUninstallPayload(
array
&$params 
)

Event handler: Gets invoked to display the payload before uninstalling the plugin.

You have to request a call to this during the plugin uninstall procedure by returning NULL in BeforeUninstall().

Parameters:

array

&$params:

Associative array of parameters. 'Form': The Form that asks the user for confirmation (by reference). If your plugin uses canonical table names (see Plugin::get_sql_table()), there will be already a list of those tables included in it. Do not end the form, just add own inputs or hidden keys to it.

[ Top ]

CacheIsCollectingContent [line 1611]

boolean CacheIsCollectingContent(
)

Event handler: gets asked for if we are generating cached content.

This is useful to not generate a list of online users or the like.

API Tags:

See:

Plugin::CachePageContent()

[ Top ]

CacheObjects [line 1576]

boolean CacheObjects(
array
&$params 
)

Event handler: called to cache object data.

Parameters:

array

&$params:

Associative array of parameters

'action': 'delete', 'set', 'get'
'key': The key to refer to 'data'
'data': The actual data. This must be set by the plugin.

API Tags:

Return:

True if action was successful, false otherwise.

[ Top ]

CachePageContent [line 1598]

boolean CachePageContent(
array
&$params 
)

Event handler: called to cache page content (get cached content or request caching).

This method must build a unique key for the requested page (including cookie/session info) and start an output buffer, to get the content to cache.

Note, that there are special occassions when this event does not get called, because we want really fresh content always:

we're generating static pages
there gets a "dynamic object", such as "Messages" or "core.preview_Comment" transported in the session

Parameters:

array

&$params:

Associative array of parameters

'data': this must get set to the page content on cache hit

API Tags:

Return:	True if we handled the request (either returned caching data or started buffering), false if we do not want to cache this page.
See:	Plugin::CacheIsCollectingContent()

[ Top ]

CaptchaPayload [line 2004]

boolean CaptchaPayload(
array
&$params 
)

Event handler: general event to inject payload for a captcha test.

This does not get called by b2evolution itself, but provides an interface to other plugins. E.g., the dnsbl_antispam_plugin uses this event optionally to whitelist a user.

Parameters:

array

&$params:

Associative array of parameters

'Form': the form where payload should get added (by reference, OPTIONALLY!) If it's not given as param, you have to create an own form, if you need one.
'form_use_fieldset': if a "Form" param is given and we use it, should we add an own fieldset? (boolean, default "true", OPTIONALLY!)
'key': A key that is associated to the caller of the event (string, OPTIONALLY!)

API Tags:

Return:

True, if you have provided payload for a captcha test

[ Top ]

CaptchaValidated [line 2027]

boolean CaptchaValidated(
array
&$params 
)

Event handler: general event to validate a captcha which payload was added through CaptchaPayload().

This does not get called by b2evolution itself, but provides an interface to other plugins. E.g., the dnsbl_antispam_plugin uses this event optionally to whitelist a user.

NOTE: if the action is verified/completed in total, you HAVE to call CaptchaValidatedCleanup(), so that the plugin can cleanup its data and is not vulnerable against multiple usage of the same captcha!

Parameters:

array

&$params:

Associative array of parameters

'validate_error': you can optionally set this, if you want to give a reason of the failure. This is optionally and meant to be used by other plugins that trigger this event.

API Tags:

Return:

true if the catcha could be validated

[ Top ]

CaptchaValidatedCleanup [line 2042]

void CaptchaValidatedCleanup(

&$params 
)

Event handler: general event to be called after an action has been taken, which involved CaptchaPayload() and CaptchaValidated().

This is meant to cleanup generated data for the Captcha test.

This does not get called by b2evolution itself, but provides an interface to other plugins. E.g., the dnsbl_antispam_plugin uses this event optionally to whitelist a user.

Parameters:

&$params:

[ Top ]

code [line 2581]

void code(
)

Template function: display plugin code

API Tags:

Deprecated:

since 1.9

[ Top ]

debug_log [line 2304]

void debug_log(
string
$msg, [array
$add_cats = array()] 
)

Log a debug message.

This gets added to the global Debuglog with the category '[plugin_classname]_[plugin_ID]'.

NOTE: if debugging is not enabled (see $debug), $Debuglog is of class Log_noop, which means it does not accept nor display messages.

Parameters:

string	$msg:	Message to log.
array	$add_cats:	Optional list of additional categories.

[ Top ]

disable_event [line 2548]

boolean disable_event(

$event 
)

Disable an event.

This removes it from the events table.

Parameters:

$event:

API Tags:

Return:

True, if status has changed; false if it was disabled already

[ Top ]

DisplayCommentFormButton [line 1341]

void DisplayCommentFormButton(
array
&$params 
)

Event handler: Called in the submit button section of the frontend comment form.

Parameters:

array

&$params:

Associative array of parameters

'Form': the comment form generating object
'Item': the Item for which the comment is meant

[ Top ]

DisplayCommentFormFieldset [line 1328]

void DisplayCommentFormFieldset(
array
&$params 
)

Event handler: Called at the end of the frontend comment form.

You might want to use this to inject antispam payload to use in in GetSpamKarmaForComment() or modify the Comment according to it in BeforeCommentFormInsert().

Parameters:

array

&$params:

Associative array of parameters

'Form': the comment form generating object
'Item': the Item for which the comment is meant

API Tags:

See:

Plugin::BeforeCommentFormInsert(), Plugin::AfterCommentFormInsert()

[ Top ]

DisplayCommentToolbar [line 1310]

boolean DisplayCommentToolbar(
array
&$params 
)

Event handler: Called when displaying editor toolbars.

Parameters:

array

&$params:

Associative array of parameters

API Tags:

Return:

did we display a toolbar?

Redefined in descendants as:

smilies_plugin::DisplayCommentToolbar() : Event handler: Called when displaying editor toolbars.

[ Top ]

DisplayItemAsHtml [line 1058]

boolean DisplayItemAsHtml(
array
&$params 
)

Event handler: Called when displaying an item/post's content as HTML.

This is different from RenderItemAsHtml(), because it gets called on every display (while rendering gets cached).

Parameters:

array

&$params:

Associative array of parameters

'data': the data (by reference). You probably want to modify this.
'format': see format_to_output().
'Item': The Item that gets displayed (by reference).
'preview': Is this only a preview?
'dispmore': Does this include the "more" text (if available), which means "full post"?

API Tags:

Return:

Have we changed something?

Redefined in descendants as:

test_plugin::DisplayItemAsHtml() : Event handler: Called when displaying item/post contents as HTML.

[ Top ]

DisplayItemAsText [line 1098]

boolean DisplayItemAsText(
array
&$params 
)

Event handler: Called when displaying an item/post's content as text.

This is different from RenderItemAsText(), because it gets called on every display (while rendering gets cached).

Parameters:

array

&$params:

Associative array of parameters

'data': the data (by reference). You probably want to modify this.
'format': see format_to_output(). Only 'text' will arrive here.
'Item': The Item that gets displayed (by reference).
'preview': Is this only a preview?
'dispmore': Does this include the "more" text (if available), which means "full post"?

API Tags:

Return:

Have we changed something?

Redefined in descendants as:

test_plugin::DisplayItemAsText() : Event handler: Called when displaying item/post contents as text.

[ Top ]

DisplayItemAsXml [line 1078]

boolean DisplayItemAsXml(
array
&$params 
)

Event handler: Called when displaying an item/post's content as XML.

This is different from RenderItemAsXml(), because it gets called on every display (while rendering gets cached).

Parameters:

array

&$params:

Associative array of parameters

'data': the data (by reference). You probably want to modify this.
'format': see format_to_output().
'Item': The Item that gets displayed (by reference).
'preview': Is this only a preview?
'dispmore': Does this include the "more" text (if available), which means "full post"?

API Tags:

Return:

Have we changed something?

Redefined in descendants as:

test_plugin::DisplayItemAsXml() : Event handler: Called when displaying item/post contents as XML.

[ Top ]

DisplayLoginFormFieldset [line 1855]

void DisplayLoginFormFieldset(
array
&$params 
)

Event handler: Called at the end of the "Login" form.

You might want to use this to inject payload to use in LoginAttempt().

Parameters:

array

&$params:

Associative array of parameters

'Form': the comment form generating object (by reference)

Redefined in descendants as:

test_plugin::DisplayLoginFormFieldset() : Event handler: Called at the end of the "Login" form.

[ Top ]

DisplayMessageFormButton [line 1529]

void DisplayMessageFormButton(
array
&$params 
)

Event handler: Called in the submit button section of the frontend message form.

Parameters:

array

&$params:

Associative array of parameters

'Form': the comment form generating object
'recipient_ID': ID of the user (if any)
'item_ID': ID of the item where the user clicked the msgform icon (if any)
'comment_ID': ID of the comment where the user clicked the msgform icon (if any)

[ Top ]

DisplayMessageFormFieldset [line 1514]

void DisplayMessageFormFieldset(
array
&$params 
)

Event handler: Called at the end of the frontend message form, which allows to send an email to a user/commentator.

You might want to use this to inject antispam payload to use in in MessageFormSent().

Parameters:

array

&$params:

Associative array of parameters

'Form': the comment form generating object
'recipient_ID': ID of the user (if any)
'item_ID': ID of the item where the user clicked the msgform icon (if any)
'comment_ID': ID of the comment where the user clicked the msgform icon (if any)

[ Top ]

DisplayRegisterFormFieldset [line 1830]

void DisplayRegisterFormFieldset(
array
&$params 
)

Event handler: Called at the end of the "Register as new user" form.

You might want to use this to inject antispam payload to use in Plugin::RegisterFormSent().

Parameters:

array

&$params:

Associative array of parameters

'Form': the comment form generating object (by reference)

[ Top ]

DisplaySkin [line 851]

void DisplaySkin(
array
&$params 
)

Event handler: Display a skin. Use Plugin::GetProvidedSkins() to return a list of names that you register.

Parameters:

array

&$params:

Associative array of parameters

'skin': name of skin to be displayed (from the list of Plugin::GetProvidedSkins()). If your Plugin only registers one skin, you can ignore it.

[ Top ]

DisplayTrackbackAddr [line 1280]

void DisplayTrackbackAddr(
array
&$params 
)

Event handler: called to display the URL that accepts trackbacks for an item.

Parameters:

array

&$params:

Associative array of parameters

'Item': the Item object (by reference)
'template': the template to display the URL (%url%)

[ Top ]

DisplayValidateAccountFormFieldset [line 1910]

void DisplayValidateAccountFormFieldset(
array
&$params 
)

Event handler: Called at the end of the "Validate user account" form, which gets invoked if newusers_mustvalidate is enabled and the user has not been validated yet.

The corresponding action event is Plugin::ValidateAccountFormSent().

Parameters:

array

&$params:

Associative array of parameters

'Form': the comment form generating object (by reference)

Redefined in descendants as:

test_plugin::DisplayValidateAccountFormFieldset()

[ Top ]

enable_event [line 2561]

boolean enable_event(

$event 
)

Enable an event.

This adds it to the events table.

Parameters:

$event:

API Tags:

Return:

True, if status has changed; false if it was enabled already

[ Top ]

ExecCronJob [line 659]

array ExecCronJob(
array
&$params 
)

Execute/handle a cron job, which has been scheduled by the admin out of the list that the Plugin provides (see GetCronJobs()).

Parameters:

array

&$params:

Associative array of parameters

'ctrl': The "ctrl" name as defined in GetCronJobs()
'params': The "params" value as defined in GetCronJobs(), plus "ctsk_ID" which holds the cron task ID.

API Tags:

Return:

with keys "code" (integer, 1 is ok), "message" (gets logged)

Redefined in descendants as:

test_plugin::ExecCronJob() : Execute/Handle a test/sample cronjob.

[ Top ]

FilterCommentAuthor [line 1466]

void FilterCommentAuthor(
array
&$params 
)

Event handler: called to filter the comment's author name (blog name for trackbacks)

Parameters:

array

&$params:

Associative array of parameters

'data': the name of the author/blog (by reference)
'makelink': true, if the "data" contains a link
'Comment': the Comment object

Redefined in descendants as:

basic_antispam_plugin::FilterCommentAuthor() : If we use "makelink", handle nofollow rel attrib.

[ Top ]

FilterCommentAuthorUrl [line 1480]

void FilterCommentAuthorUrl(
array
&$params 
)

Event handler: called to filter the comment's author URL

Parameters:

array

&$params:

Associative array of parameters

'data': the URL of the author/blog (by reference)
'makelink': true, if the "data" contains a link
'Comment': the Comment object

Redefined in descendants as:

basic_antispam_plugin::FilterCommentAuthorUrl() : Handle nofollow in author URL (if it's made clickable)

[ Top ]

FilterCommentContent [line 1492]

void FilterCommentContent(
array
&$params 
)

Event handler: called to filter the comment's content

Parameters:

array

&$params:

Associative array of parameters

'data': the name of the author/blog (by reference)
'Comment': the Comment object

Redefined in descendants as:

basic_antispam_plugin::FilterCommentContent() : Handle nofollow rel attrib in comment content.
bbcode_plugin::FilterCommentContent() : Render comments if required
smilies_plugin::FilterCommentContent() : Perform rendering

[ Top ]

FilterIpAddress [line 2058]

boolean FilterIpAddress(
array
&$params 
)

Event handler: Called when an IP address gets displayed, typically in a protected area or for a privileged user, e.g. in the backoffice statistics menu.

Parameters:

array

&$params:

Associative array of parameters

'data': the data (by reference). You probably want to modify this.
'format': see format_to_output().

API Tags:

Return:

Have we changed something?

Redefined in descendants as:

test_plugin::FilterIpAddress() : Wrap a to be displayed IP address.

[ Top ]

forget_events [line 2534]

void forget_events(
)

Call this to unregister all your events for the current request.

[ Top ]

GetCronJobs [line 643]

array GetCronJobs(

&$params 
)

This method gets asked for a list of cronjobs that the plugin provides.

If a user installs a cron job out of this list, the Plugin::ExecCronJob() of the plugin gets called.

Parameters:

&$params:

API Tags:

Return:

Array of arrays with keys "name", "ctrl" and "params". "name" gets used for display. "ctrl" (string) and "params" (array) get passed to the Plugin::ExecCronJob() method when the cronjob gets executed.

Redefined in descendants as:

test_plugin::GetCronJobs() : Define a test cron job

[ Top ]

GetDbLayout [line 580]

void GetDbLayout(
)

This method should return your DB schema, consisting of a list of CREATE TABLE queries.

The DB gets changed accordingly on installing or enabling your Plugin.

If you want to change your DB layout in a new version of your Plugin, simply adjust the queries here and increase Plugin::version, because this will request to check the current DB layout against the one you require.

For restrictions see db_delta().

[ Top ]

GetDefaultSettings [line 498]

array GetDefaultSettings(
array
&$params 
)

Define here default settings that are then available in the backoffice.

You can access them in the plugin through the member object Plugin::Settings, e.g.:

$this->Settings->get( 'my_param' );

You probably don't need to set or change values (other than the defaultvalues), but if you know what you're doing, see PluginSettings, where Plugin::Settings gets derived from.

NOTE: this method gets called by b2evo when instantiating the plugin settings and when the settings get displayed for editing in the backoffice. In the second case, $params['for_editing'] will be true.

Parameters:

array

&$params:

Associative array of parameters (since 1.9). 'for_editing': true, if the settings get queried for editing; false, if they get queried for instantiating Plugin::Settings.

API Tags:

Return:

The array to be returned should define the names of the settings as keys (max length is 30 chars) and assign an array with the following keys to them (only 'label' is required):

'label': Name/Title of the param, gets displayed as label for the input field, or as "legend" tag with types "array" and "fieldset".
'defaultvalue': Default value for the setting, defaults to '' (empty string)
'type', which can be:
- 'text' (default): a simple string
- 'html_input' : like text, but allows html
- 'password': like text, but hidden during input
- 'checkbox': either 0 or 1
- 'integer': a number (no float, can have leading "+" or "-") (like 'text' for input, but gets validated when submitting)
- 'float': a floating number (can have leading "+" or "-", e.g. "+1", "-0.05") (like 'text' for input, but gets validated when submitting)
- 'textarea': several lines of input. The following can be set for this type:
  - 'rows': number of rows
  - 'cols': number of columns
  'html_textarea': like textarea, but allows html
- 'select': a drop down field; you must set 'options' for it:
  - 'options': an array of options ('value' => 'description'), see Form::select_input_array().
- 'select_group': a drop down field, providing all existing groups (Group ID is the value or "" if "allow_none" is true)
- 'select_user': a drop down field, providing all existing groups (User ID is the value or "" if "allow_none" is true)
- 'array': a subset of settings. The value gets automagically (un)serialized through get() and set(). The following keys apply to this type:
  - 'entries': an array with the sub-settings (which can be everything from the top-level, except: "valid_pattern", "valid_range"). Note: currently there's no type forcing or checking for sub-entries involved (e.g., if you have an entry of type "integer", you could get a non-numeric string there).
  - 'max_count': maximum count of sets (optional, default is no restriction)
  - 'min_count': minimum count of sets (optional, default is no restriction)
'note' (gets displayed as a note to the param field),
'size': Size of the HTML input field (applies to types 'text', 'password' and 'integer'; defaults to 15)
'maxlength': maxlength attribute for the input field (See 'size' above; defaults to no limit)
'disabled': if true, it adds a 'disabled="disabled"' html attribute to the element and the value cannot be changed
'no_edit': if true, the setting is not editable. This is useful for internal settings.
'allow_none': set this to true to have "None" in the options list for types 'select_group' and 'select_user'.
'valid_pattern': A regular expression pattern that the value must match. This is either just a regexp pattern as string or an array with the keys 'pattern' and 'error' to define a custom error message.
'valid_range': An array with keys 'min', 'max' and (optionally) 'error' to define a custom error message. At least "min" or "max" must be given.
'help': can be:
- '#anchor': anchor that gets appended to $help_url
- true: the settings name/key gets transformed to an html ID and gets used as anchor to $help_url.
- 'http://example.com/uri': a full URL (starting with http:// or https://)
'layout': Use this to visually group your settings. Either 'begin_fieldset', 'end_fieldset' or 'separator'. You can use 'label' for 'begin_fieldset'.
'id', 'onchange', 'onclick', 'onfocus', 'onkeyup', 'onkeydown', 'onreset', 'onselect': get passed through as attributes to the form/input element.

</li></ul>

e.g.:

return array(
'my_param' => array(
'label' => $this->T_('My Param'),
'defaultvalue' => '10',
'note' => $this->T_('Quite cool, eh?'),
'valid_pattern' => array( 'pattern' => '[1-9]\d+', $this->T_('The value must be >= 10.') ),
),
'another_param' => array( // this one has no 'note'
'label' => $this->T_('My checkbox'),
'defaultvalue' => '1',
'type' => 'checkbox',
),
array( 'layout' => 'separator' ),
'my_select' => array(
'label' => $this->T_('Selector'),
'defaultvalue' => 'one',
'type' => 'select',
'options' => array( 'sun' => $this->T_('Sunday'), 'mon' => $this->T_('Monday') ),
) );

Redefined in descendants as:

pluginname_plugin::GetDefaultSettings() : Define settings that the plugin uses/provides.
basic_antispam_plugin::GetDefaultSettings()
test_plugin::GetDefaultSettings() : Get the settings that the plugin can use.
bbcode_plugin::GetDefaultSettings() : Get the default settings of the plugin.
generic_ping_plugin::GetDefaultSettings() : Get the settings that the plugin can use.
smilies_plugin::GetDefaultSettings() : Defaults for user specific settings: "Display toolbar"
auto_p_plugin::GetDefaultSettings()

[ Top ]

GetDefaultUserSettings [line 522]

array GetDefaultUserSettings(
array
&$params 
)

Define here default user settings that are then available in the backoffice.

You can access them in the plugin through the member object $UserSettings, e.g.:

$this->UserSettings->get( 'my_param' );

This method behaves exactly like Plugin::GetDefaultSettings(), except that it defines settings specific for users.

Parameters:

array

&$params:

Associative array of parameters. 'for_editing': true, if the settings get queried for editing; false, if they get queried for instantiating Plugin::UserSettings.

API Tags:

Return:	See Plugin::GetDefaultSettings(). NOTE: type 'array' does not work (for editing)!
See:	Plugin::GetDefaultSettings()

Redefined in descendants as:

pluginname_plugin::GetDefaultUserSettings() : Define user settings that the plugin uses/provides.
test_plugin::GetDefaultUserSettings() : User settings.
smilies_plugin::GetDefaultUserSettings() : Allowing the user to override the display of the toolbar.

[ Top ]

GetDependencies [line 562]

array GetDependencies(
)

Get the list of dependencies that the plugin has.

This gets checked on install or uninstall of a plugin.

There are two classes of dependencies:

'recommends': This is just a recommendation. If it cannot get fulfilled there will just be a note added on install.
'requires': A plugin cannot be installed if the dependencies cannot get fulfilled. Also, a plugin cannot get uninstalled, if another plugin depends on it.

Each class of dependency can have the following types:

'events_by_one': A list of eventlists that have to be provided by a single plugin, e.g.,
1. array( array('CaptchaPayload', 'CaptchaValidated') )
to look for a plugin that provides both events.
'plugins': A list of plugins, either just the plugin's classname or an array with classname and minimum version of the plugin (see Plugin::version). E.g.:
1. array( 'test_plugin', '1' )
to require at least version "1" of the test plugin.
'app_min': Minimum application (b2evo) version, e.g. "1.9". This way you can make sure that the hooks you need are implemented in the core. (Available since b2evo 1.8.3. To make it work before 1.8.2 use "api_min" and check for array(1, 2) (API version of 1.9)).
'api_min': You can require a specific minimum version of the Plugins API here. If it's just a number, only the major version is checked against. To check also for the minor version, you have to give an array: array( major, minor ). Obsolete since 1.9! Used API versions: 1.1 (b2evo 1.8.1) and 1.2 (b2evo 1.9).

API Tags:

See:

test_plugin::GetDependencies()

Redefined in descendants as:

test_plugin::GetDependencies() : Define some dependencies.

[ Top ]

GetExtraEvents [line 602]

NULL|array GetExtraEvents(
)

This method gets asked when plugins get installed and allows you to return a list of extra events, which your plugin triggers itself (e.g. through $Plugins->trigger_event()).

NOTE: PLEASE use a distinct prefix for the event name, e.g. "$this->classname".

NOTE: The length of event names is limited to 40 chars.

NOTE: Please comment the params and the return value here with the list that you return. Only informal as comment, but makes it easier for others.

API Tags:

Return:	"event_name" => "description"
See:	test_plugin::GetExtraEvents()

Redefined in descendants as:

test_plugin::GetExtraEvents() : We trigger an extra event ourself (which we also provide ourselves).

[ Top ]

GetHtsrvMethods [line 625]

array GetHtsrvMethods(
)

Override this method to define methods/functions that you want to make accessible through /htsrv/call_plugin.php, which allows you to call those methods by HTTP request.

This is useful for things like AJAX or displaying an <iframe> element, where the content should get provided by the plugin itself.

E.g., the image captcha plugin uses this method to serve a generated image.

NOTE: the Plugin's method must be prefixed with "htsrv_", but in this list (and the URL) it is not. E.g., to have a method "disp_image" that should be callable through this method return

array('disp_image')

here and implement it as

function htsrv_disp_image( $params )

in your plugin. This is used to distinguish those methods from others, but keep URLs nice.

API Tags:

See:

Plugin::get_htsrv_url()

[ Top ]

GetProvidedSkins [line 837]

array GetProvidedSkins(
)

Event handler: Gets asked about a list of skin names that the plugin handles.

If one of the skins returned gets called through the "skin=X" URL param, the Plugin::DisplaySkin() method of your plugin gets called.

API Tags:

Usedby:

skin_provided_by_plugin()

[ Top ]

GetSpamKarmaForComment [line 1393]

integer|NULL GetSpamKarmaForComment(
array
&$params 
)

Event handler: Called to ask the plugin for the spam karma of a comment.

This gets called just before the comment gets stored.

Parameters:

array

&$params:

Associative array of parameters

'Comment': the Comment object (by reference)

'cur_karma': current karma value (cur_karma_abs/cur_karma_divider or NULL)
'cur_karma_abs': current karma absolute value or NULL (if no Plugin returned karma before)
'cur_karma_divider': current divider (sum of weights)
'cur_count_plugins': number of Plugins that have already been asked

API Tags:

Return:

Spam probability (-100 - 100). -100 means "absolutely no spam", 100 means "absolutely spam". Only if you return a numeric value, it gets considered (e.g., "", NULL or false get ignored).

Redefined in descendants as:

basic_antispam_plugin::GetSpamKarmaForComment() : Handle max_number_of_links_feedback setting.

[ Top ]

get_class_id [line 2091]

string get_class_id(
[string
$append = ''] 
)

Get a string, unqiue for the plugin, usable in HTML form elements.

Parameters:

string

$append:

Optional text to append (gets prefixed with "_").

[ Top ]

get_edit_settings_link [line 2783]

false|string get_edit_settings_link(
)

Get a link to edit the Plugin's settings (if the user has permission).

[ Top ]

get_help_file [line 2742]

false|string get_help_file(
)

Get the help file for a Plugin ID. README.LOCALE.html will take precedence above the general (english) README.html.

Information Tags:

Todo:

Handle encoding of files (to $io_charset)

[ Top ]

get_help_link [line 2660]

string get_help_link(
[string
$target = ''] 
)

Get a link to a help page (with icon).

Parameters:

string

$target:

Target; one of the following:

anchor to $help_url ("#anchor")
absolute link to some URL, e.g. "http://example.com/example.php"
'$help_url' or empty for $help_url, then also the "www" icon gets used
'$readme' to link to the plugin's README.html file (if available)

API Tags:

Return:

The html A tag, linking to the help (or empty in case of $readme, if there is none).

[ Top ]

get_help_url [line 2712]

string get_help_url(
)

Get the plugin's external help/website URL.

[ Top ]

get_htsrv_url [line 2340]

string get_htsrv_url(
string
$method, [array
$params = array()], [string
$glue = '&amp;'], [string
$abs = false] 
)

Get the URL to call a plugin method through http. This links to the /htsrv/call_plugin.php file.

It uses the Blog's baseurl and changes "http" to "https", if needed, so that this URL can be used in AJAX callbacks (which requires it to be on the same domain/protocol).

Parameters:

string	$method:	Method to call. This must be listed in GetHtsrvMethods().
array	$params:	Array of optional parameters passed to the method.
string	$glue:	Glue for additional GET params used internally.
string	$abs:	Get absolute URL? (or cut off $ReqHost at the beginning)

API Tags:

Return:

The URL

Information Tags:

Todo:

we might want to provide whitelisting of methods through $Session here and check for it in the htsrv handler.

[ Top ]

get_plugin_url [line 2251]

string get_plugin_url(
[string
$abs = false] 
)

Get the absolute URL to the plugin's directory (where the plugins classfile is).

Trailing slash included.

This is either below $plugins_url, if no Blog is set or we're in the backoffice, or the "plugins" directory below the Blog's URL root otherwise.

Parameters:

string

$abs:

Get absolute URL? (or cut off $ReqHost at the beginning)

[ Top ]

get_README_link [line 2728]

void get_README_link(
)

API Tags:

Deprecated:

Backwards compatibility wrapper (for 1.8)

[ Top ]

get_sql_table [line 2456]

string get_sql_table(
string
$name 
)

Get canonical name for database tables a plugin uses, by adding an unique prefix for your plugin instance.

You should use this when refering to your SQL table names.

E.g., for the "test_plugin" with ID 7 and the default $tableprefix of "evo_" it would generate: "evo_plugin_test_7_log" for a requested name "log".

Parameters:

string

$name:

Your name, which gets returned with the unique prefix.

[ Top ]

ItemApplyAsRenderer [line 1295]

boolean|NULL ItemApplyAsRenderer(

&$params 
)

Event handler: Does your Plugin want to apply as a renderer for the item?

NOTE: this is especially useful for lazy Plugins, which would look at the content and decide, if they apply.

Parameters:

&$params:

API Tags:

Return:

If true, the Plugin gets added as a renderer, false removes it as a renderer (if existing) and NULL does not change the renderer setting regarding your Plugin.

[ Top ]

ItemCanComment [line 1251]

boolean|string ItemCanComment(
array
&$params 
)

Event handler: the plugin gets asked if an item can receive feedback/comments.

Parameters:

array

&$params:

Associative array of parameters 'Item': the Item

API Tags:

Return:

true, if the Item can receive feedback false/string, if the Item cannot receive feedback. If you return a string this gets displayed as an error/explanation. NULL, if you do not want to say "yes" or "no".

Redefined in descendants as:

basic_antispam_plugin::ItemCanComment() : We check if this is an anonymous visitor and do not allow comments, if we're setup to do so.

[ Top ]

ItemSendPing [line 1267]

boolean ItemSendPing(
array
&$params 
)

Event handler: send a ping about a new item.

Parameters:

array

&$params:

Associative array of parameters 'Item': the Item (by reference) 'xmlrpcresp': Set this to the xmlrpcresp object, if the plugin uses XMLRPC. 'display': Should results get displayed? (normally you should not need to care about this, especially if you can set 'xmlrpcresp')

API Tags:

Return:

Was the ping successful?

Redefined in descendants as:

ping_b2evonet_plugin::ItemSendPing() : Ping the pingomatic RPC service.
ping_pingomatic_plugin::ItemSendPing() : Ping the pingomatic RPC service.
generic_ping_plugin::ItemSendPing() : Send a ping to the configured service.

[ Top ]

ItemViewsIncreased [line 1191]

void ItemViewsIncreased(
array
&$params 
)

Event handler: Called when the view counter of an item got increased.

Parameters:

array

&$params:

Associative array of parameters

'Item': the Item object (by reference)

[ Top ]

LoginAttempt [line 1879]

void LoginAttempt(
array
$params 
)

Event handler: called when a user attemps to login.

You can prevent the user from logging in by adding a message of type "login_error".

Otherwise, this hook is meant to authenticate a user against some external database (e.g. LDAP) and generate a new user.

To check, if a user already exists in b2evo with that login/password, you might want to use

user_pass_ok( $login, $pass_md5, true )

Parameters:

array

$params:

Associative array of parameters

'login': user's login
'pass': user's password
'pass_md5': user's md5 password

API Tags:

See:	Plugin::Logout()
See:	Plugin::AlternateAuthentication()

Redefined in descendants as:

test_plugin::LoginAttempt() : Event handler: Called when a user tries to login.

[ Top ]

Logout [line 1895]

void Logout(
array
$params 
)

Event handler: called when a user logs out.

This is meant to cleanup data, e.g. if you use the Plugin::AlternateAuthentication() hook.

Parameters:

array

$params:

Associative array of parameters

'User': the user object

API Tags:

See:	Plugin::Logout()
See:	Plugin::AlternateAuthentication()

[ Top ]

long_desc [line 2637]

string long_desc(
[string
$format = 'htmlbody'], [boolean
$disp = true] 
)

Template function: display long description for plug in

Parameters:

string	$format:	Output format, see format_to_output()
boolean	$disp:	shall we display?

API Tags:

Return:	displayable long desc
Deprecated:	since 1.9

[ Top ]

MessageFormSent [line 1548]

void MessageFormSent(
array
&$params 
)

Event handler: Called when a message form has been submitted.

Add messages of category "error" to prevent the message from being sent.

You can also alter the "message" or "message_footer" that gets sent here.

Parameters:

array

&$params:

Associative array of parameters

'recipient_ID': ID of the user (if any)
'item_ID': ID of the item where the user clicked the msgform icon (if any)
'comment_ID': ID of the comment where the user clicked the msgform icon (if any)
'message': The message to be sent (by reference)
'message_footer': The footer of the message (by reference)

[ Top ]

MessageFormSentCleanup [line 1558]

void MessageFormSentCleanup(
)

Event handler: Called after a message has been sent through the public email form.

This is meant to cleanup generated data.

[ Top ]

msg [line 2369]

void msg(
string
$msg, [string|array
$category = 'note'] 
)

A simple wrapper around the $Messages object with a default catgory of 'note'.

Parameters:

string	$msg:	Message
string\|array	$category:	category ('note', 'error', 'success'; default: 'note')

[ Top ]

name [line 2595]

string name(
[string
$format = 'htmlbody'], [boolean
$disp = true] 
)

Template function: Get displayable plugin name.

Parameters:

string	$format:	Output format, see format_to_output()
boolean	$disp:	shall we display?

API Tags:

Return:	displayable plugin name.
Deprecated:	since 1.9

[ Top ]

PluginInit [line 334]

boolean PluginInit(
array
&$params 
)

Init the Plugin after it has been registered/instantiated.

Should set name and description in a localizable fashion.

This gets called on every instantiated plugin, also if it's just for discovering the list of available plugins in the backoffice.

Use this to validate Settings/requirements and/or cache them into class properties.

Parameters:

array

&$params:

Associative array of parameters. 'is_installed': true, if the plugin is installed; false if not (probably it got discovered then) 'db_row': an array with the columns of the plugin DB entry (in T_plugins). This is empty, if the plugin is not installed! E.g., 'plug_version' might be interesting to compare again "$this->version".

API Tags:

Return:

If this method returns false, the Plugin gets unregistered (for the current request only).

Redefined in descendants as:

autolinks_plugin::PluginInit() : Init
pluginname_plugin::PluginInit() : Init
wikilinks_plugin::PluginInit() : Init
quicktags_plugin::PluginInit() : Init
basic_antispam_plugin::PluginInit() : Init
wacko_plugin::PluginInit() : Init
texturize_plugin::PluginInit() : Init
gmcode_plugin::PluginInit() : Init
test_plugin::PluginInit() : Init
bbcode_plugin::PluginInit() : Init
calendar_plugin::PluginInit() : Init
ping_b2evonet_plugin::PluginInit() : Init
ping_pingomatic_plugin::PluginInit() : Init
generic_ping_plugin::PluginInit() : Init
categories_plugin::PluginInit() : Init
bookmarklet_plugin::PluginInit() : Init
smilies_plugin::PluginInit() : Init
auto_p_plugin::PluginInit() : Init
archives_plugin::PluginInit() : Init

[ Top ]

PluginSettingsEditAction [line 1662]

void PluginSettingsEditAction(
)

Event handler: Called as action before displaying the "Edit plugin" form, which includes the display of the Plugin::Settings.

You may want to use this to check existing settings or display notes about something.

[ Top ]

PluginSettingsEditDisplayAfter [line 1677]

void PluginSettingsEditDisplayAfter(
array
&$params 
)

Event handler: Called after the form to edit the Plugin::Settings has been displayed.

Use this to add custom input fields (and catch them in PluginSettingsUpdateAction()) or display custom output (e.g. a test link).

Parameters:

array

&$params:

Associative array of parameters

'Form': the Form, where an fieldset has been opened already (by reference)

[ Top ]

PluginSettingsUpdateAction [line 1650]

false|NULL PluginSettingsUpdateAction(
)

Event handler: Called as action just before updating the Plugin::Settings.

The "regular" settings from GetDefaultSettings() have been set into Plugin::Settings, but get saved into DB after this method has been called.

Use this to catch custom input fields from PluginSettingsEditDisplayAfter() or add notes/errors through Plugin::msg().

If you want to modify plugin events (see Plugin::enable_event() and Plugin::disable_event()), you should use Plugin::BeforeEnable(), because Plugin events get saved (according to the edit settings screen) after this event.

API Tags:

Return:

Return false to prevent the settings from being updated to DB.

[ Top ]

PluginSettingsValidateSet [line 1630]

string|NULL PluginSettingsValidateSet(
array
&$params 
)

Event handler: Called before displaying or setting a plugin's setting in the backoffice.

Parameters:

array

&$params:

Associative array of parameters

'name': name of the setting
'value': value of the setting (by reference)
'meta': meta data of the setting (as given in GetDefaultSettings())

API Tags:

Return:	Return a string with an error to prevent the setting from being set and/or a message added to the settings field.
See:	Plugin::GetDefaultSettings()

Redefined in descendants as:

generic_ping_plugin::PluginSettingsValidateSet() : Check ping service URL.

[ Top ]

PluginUserSettingsEditAction [line 1731]

void PluginUserSettingsEditAction(
array
&$params 
)

Event handler: Called as action before displaying the "Edit user" form, which includes the display of the Plugin::UserSettings.

You may want to use this to check existing settings or display notes about something.

Parameters:

array

&$params:

Associative array of parameters

'User': the User for which the settings are being displayed/edited

[ Top ]

PluginUserSettingsEditDisplayAfter [line 1746]

void PluginUserSettingsEditDisplayAfter(
array
&$params 
)

Event handler: Called after the form to edit the Plugin::UserSettings has been displayed.

Use this to add custom input fields (and catch them in PluginUserSettingsUpdateAction()) or display custom output (e.g. a test link).

Parameters:

array

&$params:

Associative array of parameters

'Form': the Form, where an fieldset has been opened already (by reference)

[ Top ]

PluginUserSettingsUpdateAction [line 1716]

false|NULL PluginUserSettingsUpdateAction(
array
&$params 
)

Event handler: Called as action just before updating the Plugin::UserSettings.

The "regular" settings from GetDefaultUserSettings() have been set into Plugin::UserSettings, but get saved into DB after this method has been called.

Use this to catch custom input fields from PluginUserSettingsEditDisplayAfter() or add notes/errors through Plugin::msg().

Parameters:

array

&$params:

Associative array of parameters

'User': the User for which the settings get updated

API Tags:

Return:

Return false to prevent the settings from being updated to DB.

Redefined in descendants as:

test_plugin::PluginUserSettingsUpdateAction() : Gets asked for, if user settings get updated.

[ Top ]

PluginUserSettingsValidateSet [line 1697]

string|NULL PluginUserSettingsValidateSet(
array
&$params 
)

Event handler: Called before displaying or setting a plugin's user setting in the backoffice.

Parameters:

array

&$params:

Associative array of parameters

'name': name of the setting
'value': value of the setting (by reference)
'meta': meta data of the setting (as given in GetDefaultUserSettings())
'User': the User for which the setting is

API Tags:

Return:	Return a string with an error to prevent the setting from being set and/or a message added to the settings field.
See:	Plugin::GetDefaultUserSettings()

[ Top ]

PluginVersionChanged [line 973]

boolean PluginVersionChanged(
array
&$params 
)

Event handler: Called when we detect a version change (in Plugins::register()).

Use this for your upgrade needs.

Parameters:

array

&$params:

Associative array of parameters. 'old_version': The old version of your plugin as stored in DB. 'db_row': an array with the columns of the plugin DB entry (in T_plugins). The key 'plug_version' is the same as the 'old_version' key.

API Tags:

Return:

If this method returns false, the Plugin's status gets changed to "needs_config" and it gets unregistered for the current request.

Redefined in descendants as:

basic_antispam_plugin::PluginVersionChanged() : A little housekeeping.

[ Top ]

PrependItemInsertTransact [line 1143]

void PrependItemInsertTransact(
array
&$params 
)

Event handler: called at the beginning of inserting an item/post in the database.

Use this to manipulate the Item, e.g. adding a renderer code through Item::add_renderer().

Parameters:

array

&$params:

Associative array of parameters

'Item': the related Item (by reference)

[ Top ]

PrependItemUpdateTransact [line 1114]

void PrependItemUpdateTransact(
array
&$params 
)

Event handler: called at the beginning of updating an item/post in the database.

Use this to manipulate the Item, e.g. adding a renderer code through Item::add_renderer().

Parameters:

array

&$params:

Associative array of parameters

'Item': the related Item (by reference)

[ Top ]

RegisterFormSent [line 1841]

void RegisterFormSent(

&$params 
)

Event handler: Called when a "Register as new user" form has been submitted.

You can cancel the registration process by adding a message of type "error".

Parameters:

&$params:

[ Top ]

register_menu_entry [line 2384]

void register_menu_entry(
string
$text, [string|array
$path = 'tools'], [array
$menu_entry_props = array()] 
)

Register a tab (sub-menu) for the backoffice Tools menus.

Parameters:

string	$text:	Text for the tab.
string\|array	$path:	Path to add the menu entry into. See AdminUI::add_menu_entries(). Default: 'tools' for the Tools menu.
array	$menu_entry_props:	Optional params. See AdminUI::add_menu_entries().

[ Top ]

RenderItemAsHtml [line 994]

boolean RenderItemAsHtml(
array
&$params 
)

Event handler: Called when rendering item/post contents as HTML.

Note: You have to change $params['data'] (which gets passed by reference).

Parameters:

array

&$params:

Associative array of parameters

'data': the data (by reference). You probably want to modify this.
'format': see format_to_output(). Only 'htmlbody' and 'entityencoded' will arrive here.
'Item': the Item object which gets rendered.

API Tags:

Return:

Have we changed something?

Redefined in descendants as:

autolinks_plugin::RenderItemAsHtml() : Perform rendering
wikilinks_plugin::RenderItemAsHtml() : Perform rendering
wacko_plugin::RenderItemAsHtml() : Perform rendering
texturize_plugin::RenderItemAsHtml() : Perform rendering
gmcode_plugin::RenderItemAsHtml() : Perform rendering
test_plugin::RenderItemAsHtml() : Event handler: Called when rendering item/post contents as HTML.
bbcode_plugin::RenderItemAsHtml() : Perform rendering
smilies_plugin::RenderItemAsHtml() : Perform rendering
auto_p_plugin::RenderItemAsHtml() : Perform rendering

[ Top ]

RenderItemAsText [line 1038]

boolean RenderItemAsText(
array
0 
)

Event handler: Called when rendering item/post contents other than XML or HTML.

Note: return value is ignored. You have to change $params['data'].

Parameters:

array

Associative array of parameters

'data': the data (by reference). You probably want to modify this.
'format': see format_to_output(). Only 'text' will arrive here.
'Item': the Item object which gets rendered.

API Tags:

Return:

Have we changed something?

Redefined in descendants as:

test_plugin::RenderItemAsText() : Event handler: Called when rendering item/post contents as text.

[ Top ]

RenderItemAsXml [line 1021]

boolean RenderItemAsXml(
array
&$params 
)

Event handler: Called when rendering item/post contents as XML.

Should this plugin apply to XML? It should actually only apply when:

it generates some content that is visible without HTML tags
it removes some dirty markup when generating the tags (which will get stripped afterwards)

Note: htmlentityencoded is not considered as XML here.

Note: You have to change $params['data'] (which gets passed by reference).

Parameters:

array

&$params:

Associative array of parameters

'data': the data (by reference). You probably want to modify this.
'format': see format_to_output(). Only 'xml' will arrive here.
'Item': the Item object which gets rendered.

API Tags:

Return:

Have we changed something?

Redefined in descendants as:

texturize_plugin::RenderItemAsXml() : The same as for HTML.
test_plugin::RenderItemAsXml() : Event handler: Called when rendering item/post contents as XML.
bbcode_plugin::RenderItemAsXml() : Do the same as for HTML.

[ Top ]

SessionLoaded [line 2072]

void SessionLoaded(
)

Event handler: Called after initializing plugins, DB, Settings, Hit, .. but quite early.

This is meant to be a good point for Antispam plugins to cancel the request.

API Tags:

See:

dnsbl_antispam_plugin

[ Top ]

session_delete [line 2523]

void session_delete(
string
$name 
)

Delete a value from the session data, using a unique prefix to the Plugin.

Parameters:

string

$name:

Name of the data's key (gets prefixed with 'plugIDX_' internally).

[ Top ]

session_get [line 2510]

mixed|NULL session_get(
string
$name 
)

Get a data value for the session, using a unique prefix to the Plugin.

This checks for the data to be expired and unsets it then.

Parameters:

string

$name:

Name of the data's key (gets prefixed with 'plugIDX_' internally).

API Tags:

Return:

The value, if set; otherwise NULL

[ Top ]

session_set [line 2490]

void session_set(
string
$name, mixed
$value, integer
$timeout, [boolean
$save_immediately = false] 
)

Set a data value for the session.

NOTE: the session data is limited to about 64kb, so do not use it for huge data! Please consider using an own database table (see Plugin::GetDbLayout()).

Parameters:

string	$name:	Name of the data's key (gets prefixed with 'plugIDX_' internally).
mixed	$value:	The value
integer	$timeout:	Time in seconds for data to expire (0 to disable).
boolean	$save_immediately:	Should the data get saved immediately?

[ Top ]

set_param [line 2418]

void set_param(
string
$parname, mixed
$parvalue 
)

Set param value.

Parameters:

string	$parname:	Name of parameter
mixed	$parvalue:	Value of parameter

API Tags:

Deprecated:

since 1.9 - no use.

[ Top ]

set_status [line 2431]

boolean set_status(
string
$status 
)

Set the status of the plugin.

Parameters:

string

$status:

'enabled', 'disabled' or 'needs_config'

[ Top ]

short_desc [line 2616]

string short_desc(
[string
$format = 'htmlbody'], [boolean
$disp = true] 
)

Template function: display short description for plug in

Parameters:

string	$format:	Output format, see format_to_output()
boolean	$disp:	shall we display?

API Tags:

Return:	displayable short desc
Deprecated:	since 1.9

[ Top ]

SkinBeginHtmlHead [line 824]

void SkinBeginHtmlHead(

&$params 
)

Event handler: Called at the beginning of the skin's HTML HEAD section.

Use this to add any HTML HEAD lines (like CSS styles or links to resource files (CSS, JavaScript, ..)).

Parameters:

&$params:

[ Top ]

stop_propagation [line 2472]

void stop_propagation(
)

Stop propagation of the event to next plugins (with lower priority) in events that get triggered for a batch of Plugins.

API Tags:

See:	Plugins::stop_propagation()
See:	Plugins::trigger_event()

[ Top ]

T_ [line 2111]

string T_(
string
$string, [string
$req_locale = ''] 
)

Translate a given string, in the Plugin's context.

This means, that the translation is obtained from the Plugin's "locales" folder.

Parameters:

string	$string:	The string (english), that should be translated
string	$req_locale:	Requested locale ($current_locale gets used by default)

Information Tags:

Link:

http://manual.b2evolution.net/Localization#Plugins It uses the global/regular function as fallback.

[ Top ]

ValidateAccountFormSent [line 1921]

void ValidateAccountFormSent(

&$params 
)

Event handler: Called when a "Validate user account" form has been submitted.

You can cancel the registration process by adding a message of type "error".

Parameters:

&$params:

[ Top ]

__get [line 2799]

void __get(

$nm 
)

PHP5 overloading of get method to lazy-load (User)Settings.

Parameters:

$nm:

[ Top ]

Multilingual multiuser multiblog engine

Class: Plugin

Class Plugin

Packages

Classes

Files