tag.php File Reference

Tag area definitions. More...

Variables
	$tagareas

Detailed Description

Tag area definitions.

File db/tag.php lists all available tag areas in core or a plugin.

Each tag area may have the following attributes:

• itemtype (required) - what is tagged. Must be name of the existing DB table
• component - component responsible for tagging, if the tag area is inside a plugin the component must be the full frankenstyle name of the plugin
• collection - name of the custom tag collection that will be used to store tags in this area. If specified aministrator will be able to neither add any other tag areas to this collection nor move this tag area elsewhere
• searchable (only if collection is specified) - wether the tag collection should be searchable on /tag/search.php
• showstandard - default value for the "Standard tags" attribute of the area, this is only respected when new tag area is added and ignored during upgrade
• customurl (only if collection is specified) - custom url to use instead of /tag/search.php to display information about one tag
• callback - name of the function that returns items tagged with this tag, see core_tag_tag::get_tag_index() and existing callbacks for more details, callback should return instance of core_tag\output\tagindex
• callbackfile - file where callback is located (if not an autoloaded location)

Language file must contain the human-readable names of the tag areas and collections (either in plugin language file or in component language file or lang/en/tag.php in case of core):

• for item type "user": $string['tagarea_user'] = 'Users';
• for tag collection "mycollection": $string['tagcollection_mycollection'] = 'My tag collection';

Copyright

2015 Marina Glancy

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later