Working with tags in Umbraco
The ITagQuery
interface is your primary way to work with tags in Umbraco, the interface allows you to get the various tags like content tags and media tags, as well as getting content by tag, for instance getting all content nodes with the "Umbraco" tag.
If you're using it in Views or Partial views you can inject ITagQuery
using the @inject
keyword, for example
After this you can use _tagQuery
to access the ITagQuery
.
If you're using it in controllers, you can inject it into the constructor like so:
The example below uses UmbracoApiController which is obsolete in Umbraco 14 and will be removed in Umbraco 15.
ITagQuery
is a scoped service, meaning that it should only be injected into scoped or transient services, for more information see the official Microsoft Documentation
All examples are from a view using the injection shown above, but working with tags in controllers will be the same.
Get a collection of tags used by content items on the site, you can optionally pass in a group name to only list tags belonging to a specific tag group
Get a collection of tags used by media items on the site, you can optionally pass in a group name to only list tags belonging to a specific tag group
Get a collection of tags used by members on the site, you can optionally pass in a group name to only list tags belonging to a specific tag group
Get a collection of tags used on the site, you can optionally pass in a group name to only list tags belonging to a specific tag group
Get a collection of IPublishedContent by tag, and you can optionally filter by tag group as well
Get a collection of IPublishedContent by tag group
Get a collection of Media by tag, and you can optionally filter by tag group as well
Get a collection of Media by tag group
Get a collection of tags by entity id (queries content, media and members), and you can optionally filter by tag group as well
Get a collection of tags assigned to a property of an entity (queries content, media and members), and you can optionally filter by tag group as well