https://github.com/daun/statamic-widget-collection-count
Display the number of entries per collection in your Statamic control panel
https://github.com/daun/statamic-widget-collection-count
control-panel counter statamic statamic-addon widget
Last synced: 6 months ago
JSON representation
Display the number of entries per collection in your Statamic control panel
- Host: GitHub
- URL: https://github.com/daun/statamic-widget-collection-count
- Owner: daun
- License: mit
- Created: 2024-03-07T20:56:37.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-13T10:58:41.000Z (6 months ago)
- Last Synced: 2025-04-13T11:17:21.090Z (6 months ago)
- Topics: control-panel, counter, statamic, statamic-addon, widget
- Language: PHP
- Homepage: https://statamic.com/addons/daun/collection-count-widget
- Size: 674 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Statamic Widget: Collection Count
Control panel widget for [Statamic](https://statamic.com/) that displays the
count of entries for a given collection or taxonomy.
## Installation
From your project root, run:
```sh
composer require daun/statamic-widget-collection-count
```
Alternatively, you can install the addon via the control panel.
## Usage
Add the widget to your control panel dashboard by adding it to the `widgets` array in the
`config/statamic/cp.php` config file. Pass in the name of the collection to show.
```php
return [
'widgets' => [
[
'type' => 'collection_count',
'collection' => 'projects'
]
]
];
```
## Options
### Ignore draft entries
By default, all entries are counted, including drafts. Set the `count_unpublished` variable to
`false` to only count published entries.
```php
return [
'widgets' => [
[
'type' => 'collection_count',
'collection' => 'projects',
'count_unpublished' => false,
]
]
];
```
### Apply custom query scopes
Pass in the `query_scope` param to apply [custom scopes](https://statamic.dev/extending/query-scopes-and-filters) before counting.
```php
return [
'widgets' => [
[
'type' => 'collection_count',
'collection' => 'projects',
'query_scope' => 'archived',
]
]
];
```
### Usage with taxonomies
The widget will happily count taxonomy terms as well. Just use the taxonomy name instead.
```php
return [
'widgets' => [
[
'type' => 'collection_count',
'collection' => 'tags',
]
]
];
```
## Requirements
Statamic 3/4/5+
## License
[MIT](https://opensource.org/licenses/MIT)