MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/API

action=compare

(main | compare)
  • This module requires read rights.
  • Source: MediaWiki
  • License: GPL-2.0+

Get the difference between two pages.

A revision number, a page title, a page ID, text, or a relative reference for both "from" and "to" must be passed.

Parameters:
fromtitle

First title to compare.

fromid

First page ID to compare.

Type: integer
fromrev

First revision to compare.

Type: integer
fromtext

Use this text instead of the content of the revision specified by fromtitle, fromid or fromrev.

frompst

Do a pre-save transform on fromtext.

Type: boolean (details)
fromcontentformat

Content serialization format of fromtext.

One of the following values: application/json, text/x-wiki, text/javascript, text/css, text/plain
fromcontentmodel

Content model of fromtext. If not supplied, it will be guessed based on the other parameters.

One of the following values: GadgetDefinition, wikitext, javascript, json, css, text
totitle

Second title to compare.

toid

Second page ID to compare.

Type: integer
torev

Second revision to compare.

Type: integer
torelative

Use a revision relative to the revision determined from fromtitle, fromid or fromrev. All of the other 'to' options will be ignored.

One of the following values: prev, next, cur
totext

Use this text instead of the content of the revision specified by totitle, toid or torev.

topst

Do a pre-save transform on totext.

Type: boolean (details)
tocontentformat

Content serialization format of totext.

One of the following values: application/json, text/x-wiki, text/javascript, text/css, text/plain
tocontentmodel

Content model of totext. If not supplied, it will be guessed based on the other parameters.

One of the following values: GadgetDefinition, wikitext, javascript, json, css, text
prop

Which pieces of information to get.

diff
The diff HTML.
diffsize
The size of the diff HTML, in bytes.
rel
The revision IDs of the revision previous to 'from' and after 'to', if any.
ids
The page and revision IDs of the 'from' and 'to' revisions.
title
The page titles of the 'from' and 'to' revisions.
user
The user name and ID of the 'from' and 'to' revisions.
comment
The comment on the 'from' and 'to' revisions.
parsedcomment
The parsed comment on the 'from' and 'to' revisions.
size
The size of the 'from' and 'to' revisions.
Values (separate with | or alternative): diff, diffsize, rel, ids, title, user, comment, parsedcomment, size
Default: diff|ids|title
Example:
Create a diff between revision 1 and 2.
api.php?action=compare&fromrev=1&torev=2 [open in sandbox]