Inherited From Plugin

Plugin::$author

Plugin::$help_url

Plugin::$ping_service_name

Plugin::$ping_service_note

Plugin::$sub_group

Inherited From Plugin

Plugin::Plugin()

Constructor.

Plugin::AdminAfterMenuInit()

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

Plugin::AdminAfterPageFooter()

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

Plugin::AdminBeforeItemEditCreate()

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

Plugin::AdminBeforeItemEditDelete()

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

Plugin::AdminBeforeItemEditUpdate()

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

Plugin::AdminBeginPayload()

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

Plugin::AdminDisplayCommentFormFieldset()

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

Plugin::AdminDisplayEditorButton()

Event handler: Called when displaying editor buttons.

Plugin::AdminDisplayItemFormFieldset()

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

Plugin::AdminDisplayToolbar()

Event handler: Called when displaying editor toolbars.

Plugin::AdminEndHtmlHead()

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

Plugin::AdminTabAction()

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

Plugin::AdminTabPayload()

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

Plugin::AdminToolAction()

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

Plugin::AdminToolPayload()

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

Plugin::AfterCommentDelete()

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

Plugin::AfterCommentFormInsert()

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

Plugin::AfterCommentInsert()

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

Plugin::AfterCommentUpdate()

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

Plugin::AfterInstall()

Event handler: Called after the plugin has been installed.

Plugin::AfterItemDelete()

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

Plugin::AfterItemInsert()

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

Plugin::AfterItemUpdate()

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

Plugin::AfterLoginAnonymousUser()

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

Plugin::AfterLoginRegisteredUser()

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

Plugin::AfterUserDelete()

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

Plugin::AfterUserInsert()

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

Plugin::AfterUserRegistration()

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

Plugin::AfterUserUpdate()

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

Plugin::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.

Plugin::AppendItemPreviewTransact()

Event handler: called when instantiating an Item for preview.

Plugin::AppendUserRegistrTransact()

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

Plugin::are_events_available()

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

Plugin::BeforeBlogDisplay()

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

Plugin::BeforeCommentFormInsert()

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

Plugin::BeforeDisable()

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

Plugin::BeforeEnable()

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

Plugin::BeforeInstall()

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

Plugin::BeforeTrackbackInsert()

Event handler: called before a trackback gets recorded.

Plugin::BeforeUninstall()

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

Plugin::BeforeUninstallPayload()

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

Plugin::CacheIsCollectingContent()

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

Plugin::CacheObjects()

Event handler: called to cache object data.

Plugin::CachePageContent()

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

Plugin::CaptchaPayload()

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

Plugin::CaptchaValidated()

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

Plugin::CaptchaValidatedCleanup()

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

Plugin::CommentFormSent()

Event handler: Called before at the beginning, if a comment form gets sent (and received).

Plugin::debug_log()

Log a debug message.

Plugin::disable_event()

Disable an event.

Plugin::DisplayCommentFormButton()

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

Plugin::DisplayCommentFormFieldset()

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

Plugin::DisplayCommentToolbar()

Event handler: Called when displaying editor toolbars.

Plugin::DisplayItemAsHtml()

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

Plugin::DisplayItemAsText()

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

Plugin::DisplayItemAsXml()

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

Plugin::DisplayLoginFormFieldset()

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

Plugin::DisplayMessageFormButton()

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

Plugin::DisplayMessageFormFieldset()

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

Plugin::DisplayRegisterFormFieldset()

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

Plugin::DisplaySkin()

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

Plugin::DisplayTrackbackAddr()

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

Plugin::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.

Plugin::enable_event()

Enable an event.

Plugin::ExecCronJob()

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

Plugin::FilterCommentAuthor()

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

Plugin::FilterCommentAuthorUrl()

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

Plugin::FilterCommentContent()

Event handler: called to filter the comment's content

Plugin::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.

Plugin::forget_events()

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

Plugin::GetCronJobs()

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

Plugin::GetDbLayout()

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

Plugin::GetDefaultSettings()

Define default settings here.

Plugin::GetDefaultUserSettings()

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

Plugin::GetDependencies()

Get the list of dependencies that the plugin has.

Plugin::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()).

Plugin::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.

Plugin::GetProvidedSkins()

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

Plugin::GetSpamKarmaForComment()

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

Plugin::get_class_id()

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

Plugin::get_edit_settings_link()

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

Plugin::get_help_file()

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

Plugin::get_help_link()

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

Plugin::get_help_url()

Get the plugin's external help/website URL.

Plugin::get_htsrv_url()

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

Plugin::get_plugin_url()

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

Plugin::get_README_link()

Plugin::get_sql_table()

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

Plugin::get_widget_param_definitions()

Get definitions for widget specific editable params

Plugin::ItemApplyAsRenderer()

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

Plugin::ItemCanComment()

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

Plugin::ItemSendPing()

Event handler: send a ping about a new item.

Plugin::ItemViewsIncreased()

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

Plugin::LoginAttempt()

Event handler: called when a user attemps to login.

Plugin::LoginAttemptNeedsRawPassword()

Event handler: your Plugin should return true here, if it needs a raw (un-hashed) password for the Plugin::LoginAttempt() event. If any Plugin returns true for this event, client-side hashing of the password is not used.

Plugin::Logout()

Event handler: called when a user logs out.

Plugin::MessageFormSent()

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

Plugin::MessageFormSentCleanup()

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

Plugin::msg()

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

Plugin::PluginInit()

Init the Plugin after it has been registered/instantiated.

Plugin::PluginSettingsEditAction()

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

Plugin::PluginSettingsEditDisplayAfter()

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

Plugin::PluginSettingsUpdateAction()

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

Plugin::PluginSettingsValidateSet()

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

Plugin::PluginUserSettingsEditAction()

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

Plugin::PluginUserSettingsEditDisplayAfter()

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

Plugin::PluginUserSettingsUpdateAction()

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

Plugin::PluginUserSettingsValidateSet()

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

Plugin::PluginVersionChanged()

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

Plugin::PrependItemInsertTransact()

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

Plugin::PrependItemUpdateTransact()

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

Plugin::RegisterFormSent()

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

Plugin::register_menu_entry()

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

Plugin::RenderItemAsHtml()

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

Plugin::RenderItemAsText()

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

Plugin::RenderItemAsXml()

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

Plugin::SessionLoaded()

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

Plugin::session_delete()

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

Plugin::session_get()

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

Plugin::session_set()

Set a data value for the session.

Plugin::set_status()

Set the status of the plugin.

Plugin::SkinBeginHtmlHead()

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

Plugin::SkinEndHtmlBody()

Event handler: Called at the end of the skin's HTML BODY section.

Plugin::stop_propagation()

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

Plugin::T_()

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

Plugin::ValidateAccountFormSent()

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

Plugin::__get()

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