MediaWiki\Hook\CanonicalNamespacesHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onCanonicalNamespaces (&$namespaces)
	Use this hook to add namespaces or alter the defaults.

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "CanonicalNamespaces" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 12 of file CanonicalNamespacesHook.php.

Member Function Documentation

onCanonicalNamespaces()

MediaWiki\Hook\CanonicalNamespacesHook::onCanonicalNamespaces

(

&

$namespaces

)

Use this hook to add namespaces or alter the defaults.

Note that if you need to specify namespace protection or content model for a namespace that is added in a CanonicalNamespaces hook handler, you should do so by altering $wgNamespaceProtection and $wgNamespaceContentModels outside the handler, in top-level scope. The point at which the CanonicalNamespaces hook fires is too late for altering these variables. This applies even if the namespace addition is conditional; it is permissible to declare a content model and protection for a namespace and then decline to actually register it.

Since

1.35

Parameters

string[]

&$namespaces

Array of namespace numbers with corresponding canonical names

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/title/Hook/CanonicalNamespacesHook.php