Persistent Page Identifiers

Stable unique identifiers for your wiki pages

Reference your pages with UUIDs or PURIs

On this page

Overview Usage documentation Installation Configuration

External links

Release notes Issue tracker Source code

Overview

Reference your wiki pages with stable, unique identifiers that remain unchanged even when pages are renamed, moved, or deleted and restored.

Each page automatically receives a unique persistent ID upon creation. You can configure the format of your IDs.

The extension generates UUID v7 IDs. Future versions might add support for other ID types, such as nanoid-style IDs. UUIDs (Universally Unique Identifiers) are 128-bit numbers represented as 32 hexadecimal digits separated by hyphens. Example: 123e4567-e89b-12d3-a456-426614174000

You can access the identifiers via the page information tab (action=info), parser functions, and the REST API.

MediaWiki page information showing persistent identifier

Parser Function

To display a page's persistent identifier within the page content, use the parser function {{#ppid:}} .

Example of persistent identifier parser function usage in MediaWiki

API

Get persistent identifiers via the REST API by MediaWiki page ID:

GET /persistent-page-identifiers/v1/pages?ids=123|456
                        
                            {
                                "identifiers": {
                                    "123": "00000000-0000-0000-0000-000000000042",
                                    "456": "00000000-0000-0000-0000-000000000043"
                                }
                            }
                        
                    

Generate IDs for Existing Pages

For wikis with existing pages that were created before installing this extension, you can generate persistent identifiers using the maintenance script:

php maintenance/GenerateMissingIdentifiers.php

The script will only generate identifiers for pages that don't already have one, processing them in batches for optimal performance.

Installation

Platform requirements:

  • PHP 8.1 or later
  • MediaWiki 1.39 or later

Install the extension using Composer:

                        
                            COMPOSER=composer.local.json composer require --no-update professional-wiki/persistent-page-identifiers:~1.0
                        
                    
                        
                            composer update professional-wiki/persistent-page-identifiers --no-dev -o
                        
                    

Enable the extension by adding the following to your LocalSettings.php:

wfLoadExtension( 'PersistentPageIdentifiers' );

You can verify the installation by checking your wiki's Special:Version page.

If you already have wiki pages, you probably want to generate IDs for them.

Configuration

Persistent Page Identifiers only has optional configuration. Change configuration via LocalSettings.php.

Persistent Identifier Format

This format affects how identifiers are displayed everywhere in the extension, including the page information tab, parser function output, and API responses.

$wgPersistentPageIdentifiersFormat = "$1";  // Default value

The $1 placeholder is replaced with the persistent ID.

Example usage:

  • PURIs (Persistent Uniform Resource Identifiers):
    
                                    $wgPersistentPageIdentifiersFormat = 'https://example.com/id/$1';
                                    // Becomes something like https://example.com/id/123e4567-e89b-12d3-a456-426614174000
                                
  • Add a prefix or suffix:
    $wgPersistentPageIdentifiersFormat = 'wiki_$1';

Professional MediaWiki Services

MediaWiki services by the authors of this extension

Softwareentwicklung Symbol Softwareentwicklung

Erzielen Sie hervorragende Ergebnisse mit erfahrenen MediaWiki-Entwicklern, die Erfahrung beim Entwickeln von MediaWiki-Erweiterungen und -Integrationen haben.

Mehr zu MediaWiki-Entwicklung
Theme-Entwicklung Symbol Theme-Entwicklung

Lassen Sie Ihr Wiki großartig aussehen! Verwenden Sie ein erprobtes responsives MediaWiki-Theme oder lassen Sie uns ein individuelles MediaWiki-Skin für Sie erstellen.

Gestalten Sie Ihr Wiki
MediaWiki-Hosting Symbol MediaWiki-Hosting

Lassen Sie uns Ihr Wiki betreuen und hosten. Wir sind Experten für MediaWiki-Hosting und bieten Cloud-Hosting, dediziertes Hosting und Hosting vor Ort (On-Premises) an.

Wählen Sie das perfekte Wiki-Hosting
MediaWiki-Beratung Symbol MediaWiki-Beratung

Steigern Sie Wert und Qualität Ihres Wikis, indem Sie unsere MediaWiki-Expertise nutzen. Von der Planung bis zur konkreten Implementierung haben wir alles im Griff.

Mehr zu MediaWiki-Dienstleistungen
MediaWiki-Migration Symbol MediaWiki-Migration

Wechseln Sie sorglos zu einem neuen Hosting. Wir migrieren Ihr MediaWiki auf einen neuen Server, oder wir unterstützen Sie beim Umzug von einem anderen Wiki-System zu MediaWiki.

Migrieren Sie Ihr Wiki
MediaWiki-Upgrades Symbol MediaWiki-Upgrades

Wir sorgen dafür, dass Ihr MediaWiki auf dem neuesten Stand und geschützt bleibt. Wir bieten Wartung und Aktualisierung für MediaWiki, damit Ihr Wiki störungsfrei läuft.

Aktualisieren Sie Ihr Wiki