Jump to content

Help:Purge

Page semi-protected
From Wikipedia, the free encyclopedia

Purge is a function that is sometimes necessary to use to update a wiki page whenever template- or subpage-transclusions are involved. Purging clears the page's server cache, and the page is rebuilt. Before purging, you may want to try first to refresh the page using your web browser.

For updating a page display, any purge methods do the job, but for categories and backlinks a null edit explained below is required, and other methods don't work. Update of images is explained in a section below.

The page to purge is the one that transcludes, not the page that gets transcluded. Purge consumes a small amount of additional processing power to rebuild the page.

How to purge

Note: Purging may take a few minutes, though it usually happens immediately.

Sometimes already provided

Some pages already provide a link to purge the page, such as the Wikipedia:Templates for discussion page (WP:TFD). Simply click on the link to purge the page. (WP:TFD transcludes subpages like Wikipedia:Templates for discussion/Log/2024 November 24, and updates from these subpages are not always reflected in WP:TFD. By purging, you will see the most recent version.)

{{purge}}

The {{purge}} template may be used to place a purge link on a page.

Gadgets

There are also two gadgets that can add a purge tab or link to every page. These may be found in the Gadgets section of your Wikipedia Preferences, under "Appearance":

  • The "Purgetab" gadget ("Add a "Purge" option to the top of the page, which purges the page's cache"), and
  • The "UTCLiveClock" gadget ("(S) Add a clock to the personal toolbar that displays the current time in UTC and provides a link to purge the current page (documentation)").

The "purge" option of the former can also be found in the Vector skin by navigating to the drop-down menu to the left of the Search box. In the MonoBook skin, it is in a separate tab.

To change the text shown on the "Purgetab" gadget's menu, add the following to your common.js file (or create the file using it): 

/* Customise purge tab's text */
$( document ).ready( function() {
	$( 'a', '#ca-purge' ).text( 'p' );
});

In this case, the 'p' in the third line sets the text shown on the tab to the lowercase letter p. You can change this to whatever you prefer ('purge', 'purge page', etc).

Purge request to server

Purge cache by adding ?action=purge to the URL
You have to confirm purging. This is normal, just click "Yes". You can't break anything by doing it.

You can also request the MediaWiki server to purge using a special URL. The URL should be in the format //en.wikipedia.org/w/index.php?title=page_title&action=purge (it can be prefixed with http:, https:, or with nothing).

Note that this will not work with URLs of the form //en.wikipedia.org/wiki/page_title, for which a slightly different form is required: //en.wikipedia.org/wiki/page_title?action=purge. In both cases the text needs to be placed before the URL fragment if one is there.

Another way is using the page Special:Purge. It can be used directly by accessing it and providing the title of the target page, or through accessing a link that already supplies the page, like //en.wikipedia.org/wiki/Special:Purge/page_title.

It may be easiest to make the URL by clicking "edit" or "view source" tab of the page, and changing the last portion of the URL's query string from action=edit to action=purge (anything in the URL that appears after action=edit can be deleted).

This kind of URL is used to make the links and templates outlined in the Just by clicking a link section above.

Null edit

Shortcuts
Not to be confused with a dummy edit, which slightly changes the page.

If a category or backlink page isn't showing linked articles known to exist, the page may be null-edited (refreshed) and will then show all properly linked articles.

A null edit purges the target page (including category and backlink pages) if the page can be edited:

  1. Click any "Edit" or "Edit source" link on the page.
  2. Click "Publish changes" at the bottom of the edit box without making any changes.

With a null edit, nothing is saved, and no edit is recorded. If you leave text in the edit summary, it will be discarded. Adding or deleting blank lines only at the end of the page is also usually a null edit. Trailing blank lines are largely ignored. Adding or deleting blank lines in section edits, however, sometimes results in changes, and gets saved.

A page move or protection counts as a null edit as well, although an edit is recorded in the page history.

Advantage

None of the other purge methods apply to categorization, nor to "what links here" changes from template edits.

Disadvantage

If you can't edit the page, you can't perform a null edit to it. If you're looking for category or backlink updates, but cannot perform a null edit to the page, all you need to do is simply wait, or ask another editor who is capable of editing the page to do it for you. Changes in category links are put into the job queue, and re-cached when the server load is low. Depending on how busy the server is, the page may take days, or even months, to be updated.

Do not confuse a null edit with a dummy edit. A dummy edit does modify the page source (even if only slightly), and does result in the edit being saved and logged to the page's edit history.

If you have access to use the AutoWikiBrowser editor and need to purge a large number of pages (e.g., after changing a transcluded template), one way to do this is to click the save button without making any changes. No changes will be made, but the page will be purged.

When you need to null edit a larger number of pages in a category (existing or not-existing), one of these tools may be used (e.g. User:Ahecht/Scripts/refresh.js).

Purge local browser cache

Firefox Microsoft Windows and Linux:
Ctrl+F5 or Ctrl+⇧ Shift+R

macOS:
⌘+R (reload page) or ⌘+⇧ Shift+R (reload page and rewrite cache)

Google Chrome Microsoft Windows and Linux:
Ctrl+F5 or ⇧ Shift+F5

macOS:
⌘+R (reload page) or ⌘+⇧ Shift+R (force reload page)

Konqueror Ctrl+R
Microsoft Edge F5 or Ctrl+R
Opera Ctrl+F5 or ⇧ Shift+F5
Safari ⌘+⌥+E (clearing browser cache) or ⌘+R (update)

forcerecursivelinkupdate

The behaviour of null edits changed around July 2013. Null edits previously added all pages which transcluded the page to the job queue to be reparsed. Now a null edit will reparse the page edited just as it always has (and therefore fix category membership and such), but it will no longer queue every transcluding page for reparse too.

A new "forcerecursivelinkupdate" parameter was added to the API's action=purge to get the old behavior if necessary. So action=purge&forcerecursivelinkupdate=1 in the URL (see above) will get the old behaviour. Only use this responsibly.

These changes do not affect normal edits that change the content of a page.

User preference

Logged-in users have some options in their Special:Preferences to help purging and bypassing browser caches. See also Special:Gadgets. For purge gadgets in Commons, see commons:Help:purge.

Automating the confirmation screen

Logged in users may automate the "OK" confirmation by modifying their custom common.js file. An example script is below: 

/* Automate purge confirmation dialog */
if (mw.config.get('wgAction') === 'purge') {
    $('form[action*="action=purge"]').submit();
}

Server cache

When a change is made to a page, the MediaWiki software saves the change to the main database. Thereafter a copy of that page is made to a "server cache" on secondary servers, and until the page is changed again, that cached page will be shown. A change in a template puts updates of articles that use the template into a waiting list, called the Job queue, and the page is updated once it has reached its turn. Smaller changes to the cache are done when pages are deleted or restored, in that case only the links are updated. Similarly when an image is updated, thumbnails on all pages that use that image are updated.[1]

Category counts

Counts in categories are normally done by adding to the count when a page is added to an category and subtracting when an page is removed. In categories with less than 5000 members users can purge the category to update the count. Since April 2022, larger categories are recounted monthly.[2]

Templates

In a future update, in templates, the #time parser function and the formatDate() function in Modules will update server cache once the resulting time is up.[3] If none of the previous conditions are met, then the page will be updated 30 days after the last edit.[4] Some pages are updated more frequently, like the Main page, which is updated every hour.

Purge

Update this page

Purge server cache

Purge

Images

See also: Commons:Help:Purge

To refresh thumbnails, you may have to purge either or both of the image page and/or the page that loads the image.

First go to the image description page by clicking the image. You should go further to Commons if the image is from Commons. Then purge. (Purge gadgets seem to work consistently. See commons:Help:Purge for Commons gadgets.) It may take a while for MediaWiki to complete rescaling, especially for an animated GIF. It depends on how busy the MediaWiki software is.

After a while, go back to the page with thumbnails and reload, bypassing your browser cache (Ctrl-F5 on Firefox). If the page still shows the old thumbnails, then purge this page.

If an image thumbnail will not yet regenerate successfully, it is probably because the server has cached an error page with the URL of a thumbnail, but the page is not purged because the actual thumbnail does not exist. The solution is to request the thumbnail with an unusual URL, say by appending "?1" to the end, then do a usual purge. If there is still a problem, ask for help at Wikipedia:Village pump (technical).

See also

References

  1. ^ mw:Manual:Job_queue#HTML_cache_invalidation
  2. ^ phab:T299823
  3. ^ gerrit:c/mediawiki/core/+/135887/
  4. ^ gerrit:c/operations/puppet/+/230808/2/modules/role/manifests/cache/text.pp
Retrieved from "https://en.wikipedia.org/w/index.php?title=Help:Purge&oldid=1253952141"