From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.svg

Release status:Extension status beta

ImplementationTemplate:Extension#type User interface, API
DescriptionTemplate:Extension#description Delivers task suggestions to new editors and shows editors how to complete those tasks
Author(s)Template:Extension#username Munaf Assaf, Matthew Flaschen, Pau Giner, Kaity Hammerstein, Ori Livneh, Rob Moen, S Page, Sam Smith, Moiz Syed
Latest versionTemplate:Extension#version 1.0
MediaWikiTemplate:Extension#mediawiki 1.21+
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Hooks usedTemplate:Extension#hook

Internet Explorer compatibility: none for 6, partial for 7.

Translate the GettingStarted extension if it is available at translatewiki.net

Check usage and version matrix.


Open tasks · Report a bug

The GettingStarted extension provides an onboarding process for new editors of Wikipedia.


UX/UI described in more detail at Onboarding new Wikipedians

GettingStarted provides several interfaces for suggesting introductory tasks to newly-registered editors, and it uses guided tours to show them how to complete their first edits.

If CentralAuth is installed, GettingStarted users are redirected back to their internal referrer (or the main page, if there was no referrer) post-registration. After users are sent back, they are provided with an invitation to either edit the current page or take a suggestion of something easy to edit.

Without CentralAuth, the above is the same, but the standard core interstitial page letting you change your preferences (or click a link to return) shows. The link to their internal referrer is modified to include a GettingStarted parameter (triggering the above-mentioned invitation).



GettingStarted uses Extension:EventLogging to log and Extension:GuidedTour to provide tours and tooltips. As of January 2013 they are required. Extension:CentralAuth is supported but not required.

The extension maintains its lists of articles in a Redis in-memory store. See README for the latest requirements and dependencies.

  • Download and place the file(s) in a directory called GettingStarted in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/GettingStarted/GettingStarted.php";
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.


The extension implements a MediaWiki API query list submodule "gettingstartedgetpages" that supplies

  • suggested pages to work on
  • or simply related pages.

"Related pages" relies on the morelike: prefix search feature of the Cirrus Search extension.

Suggested pages are optional for the GettingStarted new user experience and they only appear if the wiki has appropriate task categories set. GettingStarted stores lists of articles in Redis, populating them from on-wiki categories such as English Wikipedia's All articles needing copy edit according to the configuration in $wgGettingStartedCategoriesForTaskTypes. You may also exclude certain categories via $wgGettingStartedExcludedCategories. On the Wikimedia cluster, configuration settings in InitialiseSettings.php determine their value.

View the generated API documentation for the gettingstartedgetpages API module on English Wikipedia. The following are examples of types of pages you request from the API:

  • Get 10 random pages, related to Earth
  • Get a single random page that needs copy-editing.
  • Get three random pages needing copy-editing, in XML.

See also[edit]