The interface for shadow pages. More...

Public Member Functions
	existsForEdit ()
	If this returns true, force the edit action to be labelled "edit", not "create", even though the page technically doesn't exist.

	getContentForTransclusion ()
	Get the content to be shown if this page is transcluded.

	getDiffTitleMessage ()
	The label for base content when diffing against preloaded content.

	getPreloadContent ()
	Get content to be shown in the edit box when editing a non-existent page.

	getView (ParserOptions $parserOptions)
	Get page view content, or null to decline to provide such content.

	hasPreloadContent ()
	Whether preload content is available.

Detailed Description

The interface for shadow pages.

Note that extensions should generally extend BaseShadowPage, to avoid a b/c break if we decide to add more methods here.

Definition at line 17 of file ShadowPage.php.

Member Function Documentation

MediaWiki\ShadowPage\ShadowPage::existsForEdit ( )

If this returns true, force the edit action to be labelled "edit", not "create", even though the page technically doesn't exist.

MediaWiki\ShadowPage\ShadowPage::getContentForTransclusion ( )

Get the content to be shown if this page is transcluded.

MediaWiki\ShadowPage\ShadowPage::getDiffTitleMessage ( )

The label for base content when diffing against preloaded content.

MediaWiki\ShadowPage\ShadowPage::getPreloadContent ( )

Get content to be shown in the edit box when editing a non-existent page.

MediaWiki\ShadowPage\ShadowPage::getView ( ParserOptions $parserOptions )

Get page view content, or null to decline to provide such content.

MediaWiki\ShadowPage\ShadowPage::hasPreloadContent ( )

Whether preload content is available.

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