` element giving the page a title and a `
` element describing what you can test on this page, what you expect to happen when doing something or loading the pag etc. ## Viewing a page Either open the index page of this directory in the browser or directly load a specific filename in the browser. ## License GPL v3 (or later) license, see [LICENSE](LICENSE).

# test-examples

**Repository Path**: mirrors_matomo-org/test-examples

## Basic Information

- **Project Name**: test-examples
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-02-27
- **Last Updated**: 2026-07-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Matomo Test Examples

This is a collection of various tests pages that let you test and reproduce various features of Matomo.

It is especially useful for Matomo core developers and Matomo support but also anyone else who wants to test a specific feature.

## Installation

This can be hosted either on the same domain as Matomo or on a different domain.

To install it, simply clone this repository using git.

To run this project you only PHP 7.4 or newer.

## Configuration

Make a copy of `config/config.example.php` and save it as `config/config.local.php`. Adjust any variable as needed.

Variables:

* `matomoUrl` - The URL to the Matomo installation. A trailing slash will be removed automatically
* `matomoIdSite` - The ID of the site data should be tracked into or data should be requested from
* `matomoTagManagerContainer` - The ID of the Tag-Manager container that should be used in the Tag-Manager examples 

## File Structure

* `tracking/*.php` - all tracking related test files are put into this directory. Ideally, features are grouped together when possible like `tracking/events/*.php` and `tracking/content/*.php`.
* `consent/*.php` - includes consent and opt out related examples
* `consent/consent_manager/*.php` - embedding Matomo using popular third-party consent managers
* `tagmanager/*.php`

In directory and file names please use an underscore (`_`) to separate words as it's best to read on the index page this way. 

## Adding a new page

* Simply create a new PHP page in the best suited directory (feel free to create a directory if it doesn't exist yet)
* Put `<?php include '../bootstrap.php'; ?>` in the beginning to load the config
* You can then use variables like this: `<?php echo $matomoUrl ?>`
* If any possible it be great to start with a leading `<h1>` element giving the page a title and a `<p>` element describing what you can test on this page, what you expect to happen when doing something or loading the pag etc.

## Viewing a page

Either open the index page of this directory in the browser or directly load a specific filename in the browser.

## License

GPL v3 (or later) license, see [LICENSE](LICENSE).