glFusion Wiki

Site Tools


glfusion:development:pluginapi:feeds

FIXME - replace test with actual function examples

Feed Functions

The following is a list of (optional) functions for syndication feed purposes.

plugin_getfeednames_<plugin name>

Plugins can provide content for the creation of syndication feeds. This function allows the plugin to return a list of feed content it can supply. For example, the Links plugin provides a feed for all links, and a feed for each link category. The plugin should return an array of ID/name pairs where ID is the plugins internal ID for the field and name is what is displayed to the user.

Arguments

test

plugin_getfeedcontent_<plugin name>

Where a plugin has returned a list of feeds from the plugin_getfeednames_<plugin name> function, it must also return feed content using this function. The plugin is expected to return an array holding the content of the feed and to fill in 'link' (some link that represents the same content on the site as that in the feed) and 'update_data' (to be stored for later up-to-date checks).

Arguments

test

plugin_feedExtensionTags_<plugin name>

Plugins may enter additional elements in the top level of a feed format by supporting this function. The function receives the type and version of a feed (i.e. RSS version 2.0) and is expected to return an array of valid XML tags.

Arguments

test

plugin_feedNSExtensions_<plugin name>

Plugins which add their own elements to feeds may require adding extra XML Namespaces to the XML. This function should return an array of valid namespace attributes.

Arguments

test

plugin_feedElementExtensions_<plugin name>

Plugins may add additional elements to feed items by supporting this function. The function is supplied the version and type of feed, plus the content type and identifier, and must return an array of valid XML Elements.

Arguments

test
glfusion/development/pluginapi/feeds.txt · Last modified: 2017/04/12 21:13 (external edit)

Page Tools