silverstripe/reports
Reports module for SilverStripe CMS
Package info
github.com/silverstripe/silverstripe-reports
Type:silverstripe-vendormodule
pkg:composer/silverstripe/reports
Requires
- php: ^8.3
- silverstripe/admin: ^3
- silverstripe/assets: ^3
- silverstripe/cms: ^6
- silverstripe/config: ^3
- silverstripe/framework: ^6
- silverstripe/versioned: ^3
Requires (Dev)
Suggests
None
Provides
None
Conflicts
None
Replaces
None
BSD-3-Clause 44ae134dd5f8f58f0b1c0500baa6ed7b5c18155f
This package is auto-updated.
Last update: 2026-05-22 05:34:48 UTC
README
👁 CI
👁 Silverstripe supported module
Installation
composer require silverstripe/reports
Introduction
This module contains the API's for building Reports that are displayed in the Silverstripe backend.
There are also a few CMS reports that comes out of the box:
- A "Users, Groups and Permissions" report allowing administrators to get a quick overview of who has access to the CMS.
- A "Site-wide content report" report allowing CMS users to get a quick overview of content across the site.
- An "External broken links report" allowing users with permissions to track broken external links.
Note
Note that for the "External broken links report" to show up you must install symbiote/silverstripe-queuedjobs.
Troubleshooting
The reports section will not show up in the CMS if:
- There are no reports to show
- The logged in user does not have permission to view any reports
For large datasets, the reports section may take a long time to load, since each report is getting a count of the items it contains to display next to the title.
To mitigate this issue, there is a cap on the number of items that will be counted per report. This is set at 10,000 items by default, but can be configured using the limit_count_in_overview configuration variable. Setting this to null will result in showing the actual count regardless of how many items there are.
SilverStripe\Reports\Report: limit_count_in_overview: 500
Note that some reports may have overridden the getCount method, and for those reports this may not apply.
Included reports
This module comes with a few customisable reports out of the box. Details on how to customise these reports can be found in the [documentation] section(./docs/en/index.md).
