Release status: stable
|Description||Provides an in-wiki notification system that can be used by other extensions.|
|Latest version||continuous updates|
|Compatibility policy||release branches|
|Translate the Echo extension if it is available at translatewiki.net|
|Check usage and version matrix.|
|Issues||Open tasks · Report a bug|
The Echo extension provides an in-wiki notification system that can be used by other extensions. Thanks and StructuredDiscussions are two MediaWiki extensions that make use of Echo. See Notifications for a full description of what this extension does.
The extension can be retrieved directly from Git [?]:
- Browse code
- Some extensions have tags for stable releases.
- Browse tags
- Select the tag
- Click "snapshot"
- Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).
- Browse branches
- Select a branch name
- Click "Continue"
Extract the snapshot and place it in the extensions/Echo/ directory of your MediaWiki installation.
If you are familiar with git and have shell access to your server, you can also obtain the extension as follows:
cd extensions/ git clone
- Download and place the file(s) in a directory called
- Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'Echo' );
- Run the update script which will automatically create the necessary database tables that this extension needs.
- If necessary configure at your convenience
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
To users running MediaWiki 1.28 or earlier:
The instructions above describe the new way of installing this extension using
wfLoadExtension(). If you need to install this extension on these earlier versions (MediaWiki 1.28 and earlier), instead of
wfLoadExtension( 'Echo' );, you need to use:
In addition to setting default user preferences, you can also use the AddNewAccount hook to change user preferences on signup. That allows setting different user preferences going forward without affecting existing users.
See Special:DisplayNotificationsConfiguration for local details.
||true||Whether to turn on email batch function|
||''||The organization address (or whatever text you want to appear in the footer of the email notifications). Should be defined in LocalSettings.php|
||The email address for both "from" and "reply to" on email notifications. Should be defined in LocalSettings.php|
||"emailsender" message (MediaWiki)||Name for "from" on email notifications. Should be defined in LocalSettings.php|
||No Reply||Name for "reply to" on email notifications. Should be defined in LocalSettings.php|
||false||Use the main db if this is set to false, to use a specific external db, just use any key defined in $wgExternalServers|
||false||Shared database to use for keeping track of cross-wiki unread notifications; false to not keep track of it at all|
||false||Cluster the shared tracking database is located on; false if it is on the main one. Must be a key defined in $wgExternalServers|
||2000||The max number of notifications allowed for a user to do a live update, this is also the number of max notifications allowed for a user to have.|
||50||The max number of mention notifications allowed for a user to send at once|
||false||Enable mention success/failure notifications|
||true||Trigger mentions for multiple-section edits|
||true||Trigger mentions for edits to existing comments, as long as a signature is added in the same section|
||0||Maximum number of users that will be notified that they were linked from an edit summary or 0 for no notifications|
||0||The time interval between each bundle email in seconds; set a small number for test wikis. This should be set to 0 to disable email bundling if there is no delay queue support|
||true||Whether or not to enable a new talk page message alert for logged in users.|
||false||Whether or not to show the footer feedback notice in the notifications popup|
||''||A URL for the survey that appears in the footer feedback notice in the notification popup|
[ // Otherwise, a user->user email could trigger an additional redundant notification email. 'emailuser' => [ 'web' => true, 'email' => false, ], 'mention-failure' => [ 'web' => true, 'email' => false, ], 'mention-success' => [ 'web' => true, 'email' => false, ], ]
|Define which notify types are available for each notification category. If any notify types are omitted, it defaults to $wgDefaultNotifyTypeAvailability.|
[ 'web' => [ 'EchoNotifier', 'notifyWithNotification' ], 'email' => [ 'EchoNotifier', 'notifyWithEmail' ], ]
|Definitions of the different types of notification delivery that are possible. Each definition consists of a class name and a function name. See also: EchoNotificationController class.|
||||List of usernames which will not trigger notifications|
||Echo-blacklist||Page location of community maintained blacklist within NS_MEDIAWIKI containing one username per line which will not trigger notifications. Set to null to disable.|
||%s/Echo-whitelist||An sprintf format of the location of the per-user notification agent whitelist within the NS_USER namespace. %s will be replaced with the users name. The whitelists must contain one username per line which will always trigger notifications regardless of their existence in the blacklists. Set to null to disable.|
||false||Whether to enable the cross-wiki notifications feature. To enable this feature you need to:
||false||Feature flag for the cross-wiki notifications beta feature
If this is true, the cross-wiki notifications preference will appear in the BetaFeatures section; if this is false, it'll appear in the Notifications section instead.
This does not control whether cross-wiki notifications are enabled by default. For that, use $wgDefaultUserOptions['echo-cross-wiki-notifications'] = true;
||See extension.json||Define the categories that notifications can belong to. Categories can be assigned the following parameters. All parameters are optional:
If a notifications type doesn't have a category parameter, it is automatically assigned to the
||See extension.json||Defines icons, which are 30x30 images. This is passed to BeforeCreateEchoEvent so extensions can define their own icons with the same structure. It is recommended that extensions prefix their icon key. An example is myextension-name. This will help avoid namespace conflicts.
You can use either a path or a url, but not both. The value of 'path' is relative to
The value of 'url' should be a URL.
You should customize the site icon URL, which is:
||See extension.json||Define the event types for echo. Event definitions are in the form of 'event-name' => [ ... ].
||true||Default user preference for showing the special talk page alert bar|
||0||How often to send emails, by default. By default, send emails for each notification as they come in|
||0||Ensures the feedback alert is visible by default. Do not change; to disable, use |
||Default user preference for whether to use HTML or text email|
||false for most categories; depends||Default user preference for whether to notify via email for a particular category|
||true for most categories; depends||Default user preference for whether to notify via web for a particular category|
||See extension.json||Configuration for EventLogging. Individual schemas can be disabled.|
||null||Boolean that enabled Per User Blacklist.|
- Notification blacklist/whitelist
There are occasionally specific users, typically bots, which perform maintenance tasks that should not generate notifications. To handle these cases, users can be globally blacklisted from the LocalSettings.php file (or InitialiseSettings.php in the case of WMF wikis):
$wgEchoAgentBlacklist = [ 'GonzoBot', 'CrazyGuy' ];
There is also an on-wiki blacklist that can be maintained by the wiki's community. The location of the global on-wiki blacklist defaults to MediaWiki:Echo-blacklist. Individual users can override the blacklist by creating a whitelist. The whitelist location defaults to Special:MyPage/Echo-whitelist. All on-wiki lists expect to receive one case-specific username per line with no special markup or prefixes. For example:
- "Mention" option
One of the notification types that this extension allows is: "Notify me when someone links to my user page." It might not be obvious to some users, but this particular notification only works when the person linking to another user's page also signs (~~~~) the post.
After installation of the extension, a new tab "Notifications" is created in a user's Special:Preferences page. Under the section "Notify me about these events", in front of the "Mention" option, the hoverbox states: "Notify me when someone links to my user page." If an administrator feels, that the requirement for signing the post isn't obvious in this help text, it can be modified by changing the text in the Wiki's MediaWiki:Echo-pref-tooltip-mention page.
(Tested on MediaWiki v1.26.2 on March 15, 2016)
- notification - Any individual notice that is delivered by Echo
- message - A notification about activity in a Flow discussion
- alert - Any notification other than a message
- Manual:Echo - for details on the Mention requirements
- Extension:Echo/Creating a new notification type (current)
- Notifications/Developer_guide (outdated)
|This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.|