Export translations

Settings

Group

Language

Format

Export for off-line translation

Export in native format

Export in CSV format

<languages />
{{Extension
| status = stable
| image =
| type = notify
| hook1 = MediaWikiServices
| author = Aleksi Postari, Lens0021
| description = <Translate>Provides FormattedRCFeed and RCFeedFormatter subclasses for Discord</Translate>
| version =
| update =
| compatibility policy = rel
| mediawiki = >= 1.35.0
| php = >= 7.3
| license = MIT
| download = {{WikimediaDownload|DiscordRCFeed}}
| needs-updatephp = no
}}

<div lang="en" dir="ltr" class="mw-content-ltr">
'''DiscordRCFeed''' extension provides the [[Manual:RCFeedFormatter.php|Discord]] versions of [[Manual:RCFeedFormatter.php|FormattedRCFeed]] and [[Manual:RCFeedFormatter.php|RCFeedFormatter]] subclasses which can be used in {{ll|Manual:$wgRCFeeds|$wgRCFeeds}}.
</div>

__TOC__

<div lang="en" dir="ltr" class="mw-content-ltr">
== Requirements ==
</div>

* <span lang="en" dir="ltr" class="mw-content-ltr">Setting a feed requires the [https://www.php.net/sockets sockets PHP extension]. If the extension is not enabled, actions like edits, moves, etc may work, but the action may not get logged in recent changes at all. See {{ll|Manual:$wgRCFeeds}} for details.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">Apache should have NE (NoEscape) flag on to prevent issues in URLs. By default you should have this enabled.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Installation ==
</div>

{{ExtensionInstall
| custom-steps0 =
* <span lang="en" dir="ltr" class="mw-content-ltr">Create a new Discord Webhook for your channel. You can create and manage webhooks for your channel by clicking the settings icon next to channel name in the Discord app. Read more from here</span>: <tvar name="4">https://support.discord.com/hc/articles/228383668</tvar>
* <span lang="en" dir="ltr" class="mw-content-ltr">After setting up the Webhook you will get a Webhook URL. Copy that URL as you will need it in the following steps.</span>
| registration = required
| localsettings = $wgRCFeeds['discord'] = [
	// Your Discord webhook URL here.
	'url' => 'https://discord.com/api/webhooks/xx/xxxx',
];
}}

<div lang="en" dir="ltr" class="mw-content-ltr">
== Additional options ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
You can set the element that has the following key for the <syntaxhighlight lang="php" inline>$wgRCFeeds['discord']</syntaxhighlight>:
</div>

{| class="wikitable" style="clear: both;"
! <span lang="en" dir="ltr" class="mw-content-ltr">Name</span> || <span lang="en" dir="ltr" class="mw-content-ltr">Possible value</span> || <span lang="en" dir="ltr" class="mw-content-ltr">Description</span> || <span lang="en" dir="ltr" class="mw-content-ltr">Default</span>
|-
! colspan="4" |<span lang="en" dir="ltr" class="mw-content-ltr">Display options</span>
|-
| <syntaxhighlight lang="php" inline>'style'</syntaxhighlight>
| <syntaxhighlight lang="php" inline>'structure'</syntaxhighlight>, <syntaxhighlight lang="php" inline>'embed'</syntaxhighlight> or <syntaxhighlight lang="php" inline>'inline'</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">Determine how the feed is shown.</span>
<gallery mode="slideshow">
File:Screenshot of DiscordRCFeed inline style.png|<span lang="en" dir="ltr" class="mw-content-ltr">The 'inline' style changes.</span>
</gallery>
| <syntaxhighlight lang="php" inline>'structure'</syntaxhighlight>
|-
|<syntaxhighlight lang="php" inline="">'user_tools'</syntaxhighlight>
| rowspan="2" |<span lang="en" dir="ltr" class="mw-content-ltr">See [[#Controlling Page Tools and User Tools|below]]</span>
| rowspan="2" |<span lang="en" dir="ltr" class="mw-content-ltr">Controlling which tools to be included displaying the feed. See [[#Controlling Page Tools and User Tools]] below for details.</span>
| rowspan="2" |<span lang="en" dir="ltr" class="mw-content-ltr">defined in [https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/extensions/DiscordRCFeed/+/refs/heads/master/includes/Constants.php code]</span>
|-
|<syntaxhighlight lang="php" inline="">'page_tools'</syntaxhighlight>
|-
! colspan="4" |<span lang="en" dir="ltr" class="mw-content-ltr">Ignoring changes</span>
|-
| <syntaxhighlight lang="php" inline>'omit_bots'</syntaxhighlight>
| rowspan="6" | <syntaxhighlight lang="php" inline>true</syntaxhighlight> or <syntaxhighlight lang="php" inline>false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to skip bot edits. Same as described on [[Manual:$wgRCFeeds]]</span>.
| rowspan="6" | <syntaxhighlight lang="php" inline>false</syntaxhighlight>
|-
| <syntaxhighlight lang="php" inline>'omit_anon'</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to skip anon edits. Same as described on [[Manual:$wgRCFeeds]]</span>.
|-
| <syntaxhighlight lang="php" inline>'omit_user'</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to skip registered users. Same as described on [[Manual:$wgRCFeeds]]</span>.
|-
| <syntaxhighlight lang="php" inline>'omit_minor'</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to skip minor edits. Same as described on [[Manual:$wgRCFeeds]]</span>.
|-
| <syntaxhighlight lang="php" inline>'omit_patrolled'</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to skip patrolled edits. Same as described on [[Manual:$wgRCFeeds]]</span>.
|-
|<syntaxhighlight lang="php" inline="">'omit_talk'</syntaxhighlight>
|<span lang="en" dir="ltr" class="mw-content-ltr">Whether to skip changes on talk pages</span>.
|-
| <syntaxhighlight lang="php" inline="">'omit_namespaces'</syntaxhighlight>
| rowspan="5" | <span lang="en" dir="ltr" class="mw-content-ltr">See [[#Filtering Notifications|below]]</span>
| rowspan="5" | <span lang="en" dir="ltr" class="mw-content-ltr">Lists for changes to be ignored by the feed. See [[#Filtering Notifications]] below for details.</span>
| rowspan="2" | <syntaxhighlight lang="php" inline="">[]</syntaxhighlight>
|-
| <syntaxhighlight lang="php" inline>'omit_types'</syntaxhighlight>
|-
| <syntaxhighlight lang="php" inline>'omit_log_types'</syntaxhighlight>
|<syntaxhighlight lang="php" inline="">['patrol']</syntaxhighlight>
|-
| <syntaxhighlight lang="php" inline>'omit_log_actions'</syntaxhighlight>
| rowspan="2" |<syntaxhighlight lang="php" inline="">[]</syntaxhighlight>
|-
|<syntaxhighlight lang="php" inline="">'omit_content_models'</syntaxhighlight>
|-
! colspan="4" |<span lang="en" dir="ltr" class="mw-content-ltr">Scoping changes</span>
|-
|<syntaxhighlight lang="php" inline="">'only_talk'</syntaxhighlight>
|<syntaxhighlight lang="php" inline="">true</syntaxhighlight> or <syntaxhighlight lang="php" inline="">false</syntaxhighlight>
|<span lang="en" dir="ltr" class="mw-content-ltr">If this is <syntaxhighlight lang="php" inline="">true</syntaxhighlight>, only changes on talk pages would be displayed as all other changes are ignored</span>.
|<syntaxhighlight lang="php" inline="">false</syntaxhighlight>
|-
|<syntaxhighlight lang="php" inline="">'only_namespaces'</syntaxhighlight>
| rowspan="5" |<div lang="en" dir="ltr" class="mw-content-ltr">
See [[#Filtering Notifications|below]]
| rowspan="5" |If not empty, only changes that match the given condition(s) are sent. See [[#Filtering Notifications]] below for details.
</div>
| rowspan="5" |<syntaxhighlight lang="php" inline="">[]</syntaxhighlight>
|-
|<syntaxhighlight lang="php" inline="">'only_types'</syntaxhighlight>
|-
|<syntaxhighlight lang="php" inline="">'only_log_types'</syntaxhighlight>
|-
|<syntaxhighlight lang="php" inline="">'only_log_actions'</syntaxhighlight>
|-
|<syntaxhighlight lang="php" inline="">'only_content_models'</syntaxhighlight>
|-
! colspan="4" |Other
|-
| <syntaxhighlight lang="php" inline>'request_replace'</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">See [[#Webhook Request Overriding|below]]</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">An array which used to override the post data of the webhook request. See [[#Webhook Request Overriding]] below for details</span>.
| <syntaxhighlight lang="php" inline>[]</syntaxhighlight>
|}

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Filtering Notifications ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
<syntaxhighlight lang="php" inline>$wgRCFeeds['discord']['omit_namespaces']</syntaxhighlight> is a list that contains namespaces should be omitted.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
<syntaxhighlight lang="php">
// Disabling notifications from user talk page
<tvar name="21">$wgRCFeeds['discord']['omit_namespaces'] = [ NS_USER_TALK ];
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
//</tvar> Disabling notifications from talk pages.
$wgRCFeeds['discord']['omit_namespaces'] = [
	NS_TALK,
	NS_USER_TALK,
	NS_PROJECT_TALK,
	NS_FILE_TALK,
	NS_MEDIAWIKI_TALK,
	NS_TEMPLATE_TALK,
	NS_HELP_TALK,
	NS_CATEGORY_TALK,
	NS_MODULE_TALK,
];
</syntaxhighlight>

</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The others are similar.
</div>

* <syntaxhighlight lang="php" inline>'omit_types'</syntaxhighlight> can contain <syntaxhighlight lang="php" inline>RC_EDIT</syntaxhighlight>, <syntaxhighlight lang="php" inline>RC_NEW</syntaxhighlight>, <syntaxhighlight lang="php" inline>RC_LOG</syntaxhighlight> and <syntaxhighlight lang="php" inline>RC_EXTERNAL</syntaxhighlight>. ([https://codesearch.wmcloud.org/search/?q=%5Edefine%5C(%20%27RC_&i=nope see more]) Note that <syntaxhighlight lang="php" inline>RC_CATEGORIZE</syntaxhighlight> is always omitted by the same cause of [[phab:T127360]].
* <syntaxhighlight lang="php" inline>'omit_log_types'</syntaxhighlight> can contain<syntaxhighlight lang="php" inline>'move'</syntaxhighlight>,<syntaxhighlight lang="php" inline>'protect'</syntaxhighlight>, <syntaxhighlight lang="php" inline>'delete'</syntaxhighlight>, <syntaxhighlight lang="php" inline>'block'</syntaxhighlight>, <syntaxhighlight lang="php" inline>'upload'</syntaxhighlight>...
* <syntaxhighlight lang="php" inline>'omit_log_actions'</syntaxhighlight> can contain<syntaxhighlight lang="php" inline>'move/move-noredirect'</syntaxhighlight>, <syntaxhighlight lang="php" inline>'block/block'</syntaxhighlight>, <syntaxhighlight lang="php" inline>'block/unblock'</syntaxhighlight>... ([https://codesearch.wmcloud.org/deployed/?q=%5E%5Cs*%22logentry-.%2B-.%2B%22%3A&i=nope&files=qqq.json see more])
*<syntaxhighlight lang="php" inline="">'omit_content_models'</syntaxhighlight> can contain<syntaxhighlight lang="php" inline="">CONTENT_MODEL_WIKITEXT</syntaxhighlight>, <syntaxhighlight lang="php" inline="">CONTENT_MODEL_JAVASCRIPT</syntaxhighlight>, <syntaxhighlight lang="php" inline="">CONTENT_MODEL_CSS</syntaxhighlight>... ([https://codesearch.wmcloud.org/search/?q=%5Edefine%5C(%20%27CONTENT_MODEL_&i=nope see more])
The next example shows how to disable the new user notification.

<syntaxhighlight lang="php">
$wgRCFeeds['discord']['omit_log_types'] = [
	'newusers',
];
</syntaxhighlight>

=== Controlling Page Tools and User Tools ===

Page tools and user tools are tools shown after page or user link.

{| class="wikitable"
! Option || Description || Default
|-
| <syntaxhighlight lang="php" inline>'user_tools'</syntaxhighlight>
| If this is <syntaxhighlight lang="php" inline>false</syntaxhighlight>, user links of the feed would not get additional tool links.
| <nowiki>(talk | contribs)</nowiki>
|-
| <syntaxhighlight lang="php" inline>'page_tools'</syntaxhighlight>
| If this is <syntaxhighlight lang="php" inline>false</syntaxhighlight>, page links of the feed would not get additional tool links.
| <nowiki>(hist | diff)</nowiki>
|}

<syntaxhighlight lang="php">
// Remove page tools
$wgRCFeeds['discord']['page_tools'] = false;

// Redefine user tools
$wgRCFeeds['discord']['user_tools'] = [
	[
		'target' => 'special',
		'special' => 'Block',
		'text' => 'IP Block'
	],
	[
		'target' => 'talk',
		'text' => 'Discussion'
	],
	[
		'target' => 'special',
		'special' => 'Contributions',
		// message would be shown if 'msg' is given.
		'msg' => 'contribslink'
	],
];
</syntaxhighlight>

The full default values can be found in [https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/extensions/DiscordRCFeed/+/refs/heads/master/includes/Constants.php includes/Constants.php].

=== Webhook Request Overriding ===

<syntaxhighlight lang="php" inline>$wgRCFeeds['discord']['request_replace']</syntaxhighlight> is an associative array which used to override the post data of the webhook request.
You can set username or avatar using this instead of setting in Discord.
Visit https://discord.com/developers/docs/resources/webhook#execute-webhook-jsonform-params for all available parameters.

<syntaxhighlight lang="php">
$wgRCFeeds['discord']['request_replace'] = [
	'username' => 'Captain Hook',
	'avatar_url' => 'https://upload.wikimedia.org/wikipedia/commons/7/79/MediaWiki-48px.png'
];
</syntaxhighlight>

Next example shows how to reuse your icon set in [[Manual:$wgLogos|$wgLogos]].
<syntaxhighlight lang="php">
$wgRCFeeds['discord']['request_replace'] = [
	'avatar_url' => "$wgCanonicalServer/${wgLogos['icon']}",
];
</syntaxhighlight>

=== Registering Multiple Webhooks ===

You can register multiple webhooks with separate settings. Only the important part is that all keys of the feeds you want to must start with <syntaxhighlight lang="php" inline>'discord'</syntaxhighlight>, for example, <syntaxhighlight lang="php" inline="">'discord'</syntaxhighlight>, <syntaxhighlight lang="php" inline="">'discord-second'</syntaxhighlight>, <syntaxhighlight lang="php" inline="">'discord2'</syntaxhighlight> and <syntaxhighlight lang="php" inline="">'discord_copy'</syntaxhighlight> are valid keys.

<syntaxhighlight lang="php">
wfLoadExtension( 'DiscordRCFeed' );
// Divide anonymous and registered users.
$wgRCFeeds = [
	'discord' => [
		'url' => 'https://discord.com/api/webhooks/aaa/xxxx',
		'omit_user' = true,
	],
	'discord_registered' => [
		'url' => 'https://discord.com/api/webhooks/bbb/xxxx',
		'omit_anon' = true,
	],
];
</syntaxhighlight>

== Configuration Examples ==

=== Splitting changes on talk pages from others ===
<syntaxhighlight lang="php">
$wgRCFeeds = [
	'discord_content' => [
		'url' => 'https://discord.com/api/webhooks/aaa/xxxx',
		'omit_talk' => true,
	],
	'discord_talk' => [
		'url' => 'https://discord.com/api/webhooks/bbb/xxxx',
		'only_talk' => true,
	],
];
</syntaxhighlight>

Note that this is not suitable for wiki where [[Structured Discussions]] is enabled because a page on <syntaxhighlight lang="php" inline>NS_TOPIC</syntaxhighlight> is not considered as a talk page by <syntaxhighlight lang="php" inline>Title::isTalkPage()</syntaxhighlight>. In that case, filtering by namespace is only the solution:<syntaxhighlight lang="php">
$wgRCFeeds['discord'] = [
	'url' => 'https://discord.com/api/webhooks/aaa/xxxx',
	'omit_namespaces' => [
		NS_TALK,
		NS_USER_TALK,
		NS_PROJECT_TALK,
		NS_FILE_TALK,
		NS_MEDIAWIKI_TALK,
		NS_TEMPLATE_TALK,
		NS_HELP_TALK,
		NS_CATEGORY_TALK,
		829, // NS_MODULE_TALK, if Scribunto is installed
		2600, // NS_TOPIC
		// could be longer
	],
];
$wgRCFeeds['discord_talk'] = [
	'url' => 'https://discord.com/api/webhooks/bbb/xxxx',
	'only_namespaces' => $wgRCFeeds['discord']['omit_namespaces'],
];
</syntaxhighlight>

=== Reusing a feed setting for multiple servers ===
<syntaxhighlight lang="php">
// Define the source.
$wgRCFeeds['discord1'] = [
	'url' => 'https://discord.com/api/webhooks/aaa/xxxx',
	'omit_bots' => true,
	'omit_minor' => true,
	'omit_nemespaces' => [
	    NS_PROJECT,
	    NS_TEMPLATE,
	    NS_MODULE,
	    NS_USER,
    ],
    'only_types' => [ RC_EDIT, RC_NEW ],
];

// Reuse the same configuration.
$wgRCFeeds['discord2'] = $wgRCFeeds['discord1'];
$wgRCFeeds['discord2']['url'] = 'https://discord.com/api/webhooks/bbb/xxxx',

// Reuse but with some tweak.
$wgRCFeeds['discord3'] = $wgRCFeeds['discord1'];
$wgRCFeeds['discord3']['url'] = 'https://discord.com/api/webhooks/ccc/xxxx',
$wgRCFeeds['discord3']['omit_minor'] = false;
unset( $wgRCFeeds['discord3']['only_types'] );

</syntaxhighlight>

=== JavaScript Changes Only ===
<syntaxhighlight lang="php">
$wgRCFeeds = [
	'discord' => [
		'url' => 'https://discord.com/api/webhooks/xxx/xxxx',
		'only_content_models' => CONTENT_MODEL_JAVASCRIPT,
	],
];
</syntaxhighlight>

== Notes ==

* Basically, DiscordRCFeed is a fork of [[Extension:DiscordNotifications|DiscordNotifications]], but heavily modified.
* The basic usage of [[Manual:$wgRCFeeds|$wgRCFeeds]] is like below:<syntaxhighlight lang="php">$wgRCFeeds['discord'] = [
    'formatter' => 'MediaWiki\Extension\DiscordRCFeed\DiscordRCFeedFormatter',
	'url' => 'https://discord.com/api/webhooks/xxx/xxxx',
];
</syntaxhighlight>But because the <syntaxhighlight lang="php" inline>'formatter'</syntaxhighlight> value is too long for the end-users, DiscordRCFeed automatically uses <syntaxhighlight lang="php" inline>'MediaWiki\Extension\DiscordRCFeed\DiscordRCFeedFormatter'</syntaxhighlight> as its default formatter, if the value is omitted and the key of RCFeed is starts with <syntaxhighlight lang="php" inline>'discord'</syntaxhighlight>.

== See also ==
* {{ll|Extension:DiscordNotifications}}
* {{ll|Extension:Discord}}
{{FemiwikiExtensionFooter}}

[[Category:Discord extensions{{#translation:}}]]
[[Category:Extensions with StructuredDiscussions support{{#translation:}}]]

Export translations

Navigation menu

Search