PHPackages                             visionbites/usage-reference - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Admin Panels](/categories/admin)
4. /
5. visionbites/usage-reference

ActiveKirby-plugin[Admin Panels](/categories/admin)

visionbites/usage-reference
===========================

Show references to a page or file on the objects blueprint.

1.2.3(1y ago)266.3k↑13.9%[1 issues](https://github.com/visionbites/kirby-usage-reference/issues)MITPHP

Since Jul 10Pushed 1y ago2 watchersCompare

[ Source](https://github.com/visionbites/kirby-usage-reference)[ Packagist](https://packagist.org/packages/visionbites/usage-reference)[ RSS](/packages/visionbites-usage-reference/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (7)Dependencies (1)Versions (7)Used By (0)

Kirby usage reference plugin
============================

[](#kirby-usage-reference-plugin)

Infosection to display all references to a page or image in a list.

[![preview](preview.png)](preview.png)

Install
-------

[](#install)

### Download Zip file

[](#download-zip-file)

Copy plugin folder into `site/plugins`

### Git submodule

[](#git-submodule)

```
git submodule add https://github.com/visionbites/kirby-usage-reference.git site/plugins/usage-reference

```

### Composer

[](#composer)

```
composer require visionbites/usage-reference

```

Usage
-----

[](#usage)

Add a section `usageReference` to your blueprint to show references to the current page. Add a `template` key to define the type of pages you are looking for.

### Example

[](#example)

Basic setup:

```
sections:
    references:
        headline: References to this page
        type: usageReference
        template: template-name
```

Setup for files:

```
sections:
    file_data:
        type: fields
        fields:
            title:
                type: text
                label: Title
            alt:
                type: text
                label: Alternative title
            caption:
                type: textarea
                label: Image caption
    references:
        headline: References to this file
        type: usageReference
```

Options
-------

[](#options)

there are only two options at the moment:

OptionDefaultDescription`expire``15`the cache will expire after n minutes. Minimum is 1 as a indefinite cache makes no sense`cache``true`if set to false will disable the caching of referencesset the options in `config.php`:

```
return [
	'visionbites.usage-reference' => [
		'expire' => 15 // in minutes
		'cache' => true
	],
];
```

please keep in mind that this might lead to showing out of date data to the editor if there was another reference added.

Usage in plugins, models and other places
-----------------------------------------

[](#usage-in-plugins-models-and-other-places)

you can use the `ReferenceService` that is provided in other places to access the data that is presented in the panel.

E.g. if you have events attached to a place that are not children of the place itself you can have a `events()` method in the `PlacePage` model:

```
public function events()
{
	$refService = new ReferenceService();
	// pass the uuid of the place and the template that you are looking for
	$events = $refService->findReferencesForUuid($this->uuid()->toString(), 'event');
	// depending on what you want to do with the events you can either return them here or
	// resolve the pages and return a pages collection
	$eventsPages = new Pages();
	foreach ($events as $event) {
		$eventPage = $this->kirby()->page($event['uuid']);
		$eventsPages->append($eventPage);
	}
	return $eventsPages;
}
```

todos
-----

[](#todos)

- clear cache for a page on update of a referencing page
- make it pick up on text links

License
-------

[](#license)

[MIT](https://opensource.org/licenses/MIT)

It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia animal abuse, violence or any other form of hate speech.

###  Health Score

33

—

LowBetter than 74% of packages

Maintenance34

Infrequent updates — may be unmaintained

Popularity32

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~74 days

Recently: every ~87 days

Total

6

Last Release

663d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/3467b2f963e8c4926d4cdc0c81c7e56a0fe1d205e133b0efe0253d5a16b856f7?d=identicon)[philipkuban](/maintainers/philipkuban)

---

Top Contributors

[![therephil](https://avatars.githubusercontent.com/u/4098146?v=4)](https://github.com/therephil "therephil (19 commits)")

---

Tags

kirby-cmskirby-panelkirby-pluginkirbycmskirbykirby-pluginkirby-cms

### Embed Badge

![Health badge](/badges/visionbites-usage-reference/health.svg)

```
[![Health](https://phpackages.com/badges/visionbites-usage-reference/health.svg)](https://phpackages.com/packages/visionbites-usage-reference)
```

###  Alternatives

[bnomei/kirby3-janitor

Kirby Plugin for running commands like cleaning the cache from within the Panel, PHP code or a cronjob

9339.9k2](/packages/bnomei-kirby3-janitor)[bnomei/kirby3-feed

Generate a Atom/JSON/RSS-Feed and XML-Sitemap from Pages-Collections

7224.8k](/packages/bnomei-kirby3-feed)[belugadigital/kirby-navigation

Kirby 5 field for hierarchical menus with drag & drop level indentation.

8713.4k](/packages/belugadigital-kirby-navigation)[bnomei/kirby3-dotenv

Kirby Plugin for environment variables from .env

4144.1k1](/packages/bnomei-kirby3-dotenv)[bnomei/kirby3-fingerprint

File Method and css/js helper to add cache-busting hash and optional Subresource Integrity to file

4130.5k1](/packages/bnomei-kirby3-fingerprint)[timnarr/kirby-imagex

Modern images for Kirby CMS – This plugin helps you orchestrate modern, responsive and performant images in Kirby

797.5k1](/packages/timnarr-kirby-imagex)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)