Persistent Page Identifiers

Usage documentation

Parser Function

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

Semantic MediaWiki users can store the ID with {{#set:PPID={{#ppid:}}}}, where PPID is the name of their semantic property.

GET /persistent-page-identifiers/v1/pages?ids=123|456

{
    "identifiers": {
        "123": "00000000-0000-0000-0000-000000000042",
        "456": "00000000-0000-0000-0000-000000000043"
    }
}

php maintenance/GenerateMissingIdentifiers.php

Installation

Requirements

• PHP 8.1 or later
• MediaWiki 1.39 or later

Load and enable

Load the extension using Composer:

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

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
// Becomes something like 123e4567-e89b-12d3-a456-426614174000

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';
  // Becomes something like wiki_123e4567-e89b-12d3-a456-426614174000