Pepperminty Wiki Module API

links

Table of Contents

interwiki_pagename_parse()  : array<string|int, string>
Parses an interwiki pagename into it's component parts.
interwiki_pagename_resolve()  : stdClass
Resolves an interwiki pagename to the associated interwiki definition object.
interwiki_get_pagename_url()  : string
Converts an interwiki pagename into a url.
is_interwiki_link()  : bool
Returns whether a given pagename is an interwiki link or not.

Functions

interwiki_pagename_parse()

Parses an interwiki pagename into it's component parts.

interwiki_pagename_parse(string $interwiki_pagename) : array<string|int, string>
Parameters
$interwiki_pagename : string

The interwiki pagename to parse.

Return values
array<string|int, string>

An array containing the parsed components of the interwiki pagename, in the form ["prefix", "page_name"].

interwiki_pagename_resolve()

Resolves an interwiki pagename to the associated interwiki definition object.

interwiki_pagename_resolve(string $interwiki_pagename) : stdClass
Parameters
$interwiki_pagename : string

An interwiki pagename. Should be in the form "prefix:page name".

Return values
stdClass

The interwiki definition object.

interwiki_get_pagename_url()

Converts an interwiki pagename into a url.

interwiki_get_pagename_url(string $interwiki_pagename) : string
Parameters
$interwiki_pagename : string

The interwiki pagename (in the form "prefix:page name")

Return values
string

A url that points to the specified interwiki page.

Returns whether a given pagename is an interwiki link or not.

is_interwiki_link(string $pagename) : bool

Note that this doesn't guarantee that it's a valid interwiki link - only that it looks like one :P

Parameters
$pagename : string

The page name to check.

Return values
bool

Whether the given page name is an interwiki link or not.

Search results