About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools


development:plugins:related_records_modules

Related Records Modules

Related records modules are used to display recommendations on the record view based on the currently-selected record.

Key Plugin Details

Default Namespace: \VuFind\Related

Interface: \VuFind\Related\RelatedInterface

Service Locator Configuration Section in module.config.php: ['vufind']['plugin_managers']['related']

Service Manager Name for Service Locator: VuFind\RelatedPluginManager (VuFind 2.x-4.x), VuFind\Related\PluginManager (VuFind 5.0+)

Template Name: To display the related record recommendations, VuFind will attempt to load a template from the Related folder of the current theme whose name corresponds with the class of the plugin (ignoring the namespace). The template will have access to the plugin object as $this→related.

See the General Plugin Information page for more details on VuFind plugins.

development/plugins/related_records_modules.txt · Last modified: 2020/09/22 14:37 by demiankatz