XenForo Reference Guide for Developer
Back to top  

Abstract moderator handler.

Moderator handlers deal with the content-specific differences in content moderators.

package XenForo_Moderator

 Methods

Gets the option that shows up on the moderator add "choice" screen for this content type.

getAddModeratorOption(\XenForo_View $view, integer $selectedContentId, string $contentType) : array

The return value should be an array that can be passed as a tag (label, value, selected, disabled, etc).

Parameters

$view

\XenForo_View

$selectedContentId

integer

If being redirected back to this page, there may be a selected content ID.

$contentType

string

The name of the content type

Returns

array

Helper to get the content title of one piece of content.

getContentTitle(integer $id) : string

Parameters

$id

integer

Returns

string

Gets the title of multiple pieces of content in this content type.

getContentTitles(array $ids) : array

The return should be an array keyed by matching keys of the IDs param. Note that an ID value may occur multiple times.

Note that the title may be more than just the title, if necessary. It may include other necessary disambiguation, such as the content type ("Forum - Name").

Parameters

$ids

array

Returns

arrayFormat: [id key (key of param)] => title

Gets the moderator permission interface group IDs that apply to this type of content.

getModeratorInterfaceGroupIds() : array

Returns

array