MediaWiki\ShadowPage\ShadowPageProvider Interface Reference

The interface for providers of ShadowPage instances. More...

Inherited by MediaWiki\ShadowPage\BaseShadowPageProvider.

Public Member Functions
	existsForLink (LinkTarget $link)
	Determine whether a link should be coloured as if it refers to an existing page.
	get (PageReference $title)
	If the implementation wishes to handle this title, return a ShadowPage.

Detailed Description

The interface for providers of ShadowPage instances.

Extensions should extend BaseShadowPageProvider, to avoid a b/c break if we decide to add more methods here.

Since

1.47

Definition at line 16 of file ShadowPageProvider.php.

Member Function Documentation

existsForLink()

MediaWiki\ShadowPage\ShadowPageProvider::existsForLink

(

LinkTarget

$link

)

Determine whether a link should be coloured as if it refers to an existing page.

Parameters

LinkTarget

$link

Returns

bool

get()

MediaWiki\ShadowPage\ShadowPageProvider::get

(

PageReference

$title

)

If the implementation wishes to handle this title, return a ShadowPage.

Return null to allow the loader to try the next provider.

Parameters

PageReference

$title

Returns

ShadowPage|null

Implemented in MediaWiki\ShadowPage\MessageProvider.

---

The documentation for this interface was generated from the following file:

• includes/ShadowPage/ShadowPageProvider.php