PerlDoc

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

---

Parent package: Foswiki::Plugins
Child packages:

More ...Less ...

internal package ExtendedWebListPlugin

NOTE: When writing handlers, keep in mind that these may be invoked on included topics. For example, if a plugin generates links to the current topic, these need to be generated before the afterCommonTagsHandler is run, as at that point in the rendering loop we have lost the information that we the text had been included from another topic.

initPlugin($topic, $web, $user, $installWeb) → $boolean

• $topic - the name of the topic in the current CGI query
• $web - the name of the web in the current CGI query
• $user - the login name of the user
• $installWeb - the name of the web the plugin is installed in

REQUIRED

Called to initialise the plugin. If everything is OK, should return a non-zero value. On non-fatal failure, should write a message using Foswiki::Func::writeWarning and return 0. In this case

Plugin	Errors
TWikiCompatibilityPlugin	none
SpreadSheetPlugin	none
SlideShowPlugin	none
AttachmentListPlugin	none
AutoTemplatePlugin	none
AutoViewTemplatePlugin	none
BreadCrumbsPlugin	none
CommentPlugin	none
CompareRevisionsAddonPlugin	none
ConfigurePlugin	none
DBCachePlugin	none
DiffPlugin	none
EditRowPlugin	none
EditTablePlugin	none
ExtendedWebListPlugin	none
FilterPlugin	none
FlexFormPlugin	none
FlexWebListPlugin	none
GridLayoutPlugin	none
HistoryPlugin	none
HomePagePlugin	none
ImagePlugin	none
InterwikiPlugin	none
JQueryPlugin	none
ListyPlugin	none
MailerContribPlugin	none
MathModePlugin	none
MetaDataPlugin	none
MimeIconPlugin	none
MoreFormfieldsPlugin	none
MultiLingualPlugin	none
NatEditPlugin	none
NatSkinPlugin	none
PreferencesPlugin	none
PubLinkFixupPlugin	none
RedDotPlugin	none
RenderListPlugin	none
RenderPlugin	none
SmiliesPlugin	none
SubscribePlugin	none
TablePlugin	none
TinyMCEPlugin	none
TopicDataHelperPlugin	none
TopicInteractionPlugin	none
TopicTitlePlugin	none
TwistyPlugin	none
UpdatesPlugin	none
WebCreatorPlugin	none
WebLinkPlugin	none
WebPermissionsPlugin	none
WysiwygPlugin	none

Handler	Plugins
afterAttachmentSaveHandler	DBCachePlugin This handler is deprecated - please check for updated versions of the plugins that use it!
afterUploadHandler	DBCachePlugin MoreFormfieldsPlugin TopicInteractionPlugin
afterCommonTagsHandler	TablePlugin TopicInteractionPlugin
afterEditHandler	MoreFormfieldsPlugin WysiwygPlugin
afterRenameHandler	DBCachePlugin FlexWebListPlugin ImagePlugin MoreFormfieldsPlugin TopicTitlePlugin
afterSaveHandler	DBCachePlugin FlexWebListPlugin ImagePlugin MoreFormfieldsPlugin
beforeCommonTagsHandler	EditTablePlugin NatSkinPlugin PreferencesPlugin WysiwygPlugin
beforeEditHandler	MoreFormfieldsPlugin NatEditPlugin TinyMCEPlugin WysiwygPlugin
beforeMergeHandler	WysiwygPlugin
beforeSaveHandler	MetaDataPlugin MoreFormfieldsPlugin MultiLingualPlugin TopicTitlePlugin WebPermissionsPlugin WysiwygPlugin
beforeUploadHandler	TopicInteractionPlugin
commonTagsHandler	SpreadSheetPlugin SlideShowPlugin CompareRevisionsAddonPlugin DiffPlugin EditRowPlugin EditTablePlugin FilterPlugin ImagePlugin MathModePlugin
completePageHandler	FlexFormPlugin NatSkinPlugin
earlyInitPlugin	TWikiCompatibilityPlugin
endRenderingHandler	NatSkinPlugin This handler is deprecated - please check for updated versions of the plugins that use it!
finishPlugin	AutoTemplatePlugin BreadCrumbsPlugin DBCachePlugin DiffPlugin FilterPlugin FlexFormPlugin FlexWebListPlugin GridLayoutPlugin ImagePlugin JQueryPlugin ListyPlugin MathModePlugin MetaDataPlugin MimeIconPlugin MoreFormfieldsPlugin MultiLingualPlugin NatSkinPlugin RenderPlugin TopicInteractionPlugin TopicTitlePlugin UpdatesPlugin WebCreatorPlugin WebLinkPlugin
initPlugin	TWikiCompatibilityPlugin SpreadSheetPlugin SlideShowPlugin AttachmentListPlugin AutoTemplatePlugin AutoViewTemplatePlugin BreadCrumbsPlugin CommentPlugin CompareRevisionsAddonPlugin ConfigurePlugin DBCachePlugin DiffPlugin EditRowPlugin EditTablePlugin ExtendedWebListPlugin FilterPlugin FlexFormPlugin FlexWebListPlugin GridLayoutPlugin HistoryPlugin HomePagePlugin ImagePlugin InterwikiPlugin JQueryPlugin ListyPlugin MailerContribPlugin MathModePlugin MetaDataPlugin MimeIconPlugin MoreFormfieldsPlugin MultiLingualPlugin NatEditPlugin NatSkinPlugin PreferencesPlugin PubLinkFixupPlugin RedDotPlugin RenderListPlugin RenderPlugin SmiliesPlugin SubscribePlugin TablePlugin TinyMCEPlugin TopicDataHelperPlugin TopicInteractionPlugin TopicTitlePlugin TwistyPlugin UpdatesPlugin WebCreatorPlugin WebLinkPlugin WebPermissionsPlugin WysiwygPlugin
initializeUserHandler	HomePagePlugin
lateInitPlugin	JQueryPlugin MetaDataPlugin
modifyHeaderHandler	RenderPlugin WysiwygPlugin
postRenderingHandler	EditRowPlugin EditTablePlugin MathModePlugin PreferencesPlugin WysiwygPlugin
preRenderingHandler	InterwikiPlugin RenderListPlugin SmiliesPlugin TablePlugin
renderWikiWordHandler	TWikiCompatibilityPlugin TopicTitlePlugin

51 plugins

will indicate which plugins failed.

In the case of a catastrophic failure that will prevent the whole installation from working safely, this handler may use 'die', which will be trapped and reported in the browser.

You may also call Foswiki::Func::registerTagHandler here to register a function to handle variables that have standard TWiki syntax - for example, =%MYTAG{"my param" myarg="My Arg"}%. You can also override internal TWiki variable handling functions this way, though this practice is unsupported and highly dangerous!

Note: Please align variables names with the Plugin name, e.g. if your Plugin is called FooBarPlugin, name variables FOOBAR and/or FOOBARSOMETHING. This avoids namespace issues.