doublesecretagency/craft-viewcount

Count the number of times an element has been viewed.

2.0.0 2024-02-21 23:27 UTC

Requires

• craftcms/cms: ^5.0.0-beta

proprietary

• Double Secret Agency

• cms
• views
• counter
• Craft
• craftcms
• craft-plugin
• view-count

README

View Count plugin for Craft CMS

Count the number of times an element has been viewed.

Track views via Twig, PHP, or AJAX

Basic tracking looks like this...

{% do craft.viewCount.increment(elementId) %}

However, there are several more advanced ways to increment a view counter.

Allow multiple counters on the same element

If you need to track multiple aspects of the same element, it's easy to do so! Simply specify an optional key when setting up the tracking mechanism.

Sort by "most viewed"

Once you've started logging views, you'll likely want to know which items have been viewed the most...

{% set articles = craft.entries.section('articles') %}
{% do craft.viewCount.sort(articles) %}

Display view totals in the control panel

You can add a "Total Views" field, which displays a read-only total for each element.

Events

They do exactly what you think...

• EVENT_BEFORE_VIEW
• EVENT_AFTER_VIEW

Within the EVENT_BEFORE_VIEW event, you can prevent the view from being counted.

Further Reading

If you haven't already, flip through the complete plugin documentation.

And if you have any remaining questions, feel free to reach out to us (via Discord is preferred).

On behalf of Double Secret Agency, thanks for checking out our plugin! 🍺