API:Alldeletedrevisions

From MediaWiki.org
Jump to: navigation, search
Tools clipart.png This page is part of the MediaWiki action API documentation.



MediaWiki action API

v · d · e
Alldeletedrevisions
List all deleted revisions by a user or in a namespace.
This module can be used as a GeneratorAPI:generator.
Prefix adr
Required rights none
Post only? No
Generated help Current
Version added
≥ 1.25

List all deleted revisions by a user or in a namespace.

This module lists revisions which have been deleted from a page, as you would see in Special:Undelete. It should not be confused with revisions which have been hidden via the Revision Delete feature.

Parameters[edit]

  • adrprop: Which properties to get for each revision: (Default: ids|timestamp|flags|comment|user)
    • ids: The ID of the revision.
    • flags: Revision flags (minor).
    • timestamp: The timestamp of the revision.
    • user: User that made the revision.
    • userid: User ID of the revision creator.
    • size: Length (bytes) of the revision.
    • sha1: SHA-1 (base 16) of the revision.
    • contentmodel: Content model ID of the revision.
    • comment: Comment by the user for the revision.
    • parsedcomment: Parsed comment by the user for the revision.
    • content: Text of the revision.
    • tags: Tags for the revision.
    • parsetree: The XML parse tree of revision content (requires content model wikitext).
  • adrlimit: Limit how many revisions will be returned. No more than 500 (5000 for bots) allowed. (Default: 10 (1 with content property))
  • adrexpandtemplates: Expand templates in revision content (requires adrprop=content).
  • adrgeneratexml: Deprecated. Generate XML parse tree for revision content (requires adrprop=content; replaced by adrprop=parsetree). (Deprecated in 1.26)
  • adrparse: Parse revision content (requires adrprop=content). For performance reasons, if this option is used, adrlimit is enforced to 1.
  • adrsection: Only retrieve the content of this section number.
  • adrdiffto: Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.
  • adrdifftotext: Text to diff each revision to. Only diffs a limited number of revisions. Overrides adrdiffto. If adrsection is set, only that section will be diffed against this text.
  • adrdifftotextpst: Perform a pre-save transform on the text before diffing it. Only valid when used with adrdifftotext. 1.27+
  • adrcontentformat: Serialization format used for adrdifftotext and expected for output of content. Possible values: application/json, text/x-wiki, text/javascript, text/css, text/plain.
  • adruser: Only list revisions by this user.
  • adrnamespace: Only list pages in this namespace.
  • adrstart: The timestamp to start enumerating from. Ignored when processing a list of revision IDs.
  • adrend: The timestamp to stop enumerating at. Ignored when processing a list of revision IDs.
  • adrdir: In which direction to enumerate: (Default: older)
    • newer: List oldest first. Note: adrstart has to be before adrend.
    • older: List newest first. Note: adrstart has to be later than adrend.
  • adrfrom: Start listing at this title.
  • adrto: Stop listing at this title.
  • adrprefix: Search for all page titles that begin with this value.
  • adrexcludeuser: Don't list revisions by this user.
  • adrtag: Only list revisions tagged with this tag.
  • adrcontinue: When more results are available, use this to continue.
  • adrgeneratetitles: When being used as a generator, generate titles rather than revision IDs. For example, if looking at the edits a particular user made, prop=revisions would, by default, return the latest revision from the pages that user edited, rather than the specific revisions they made.

Example[edit]

Get a list of deleted revisions in Main space.

api.php?action=query&list=alldeletedrevisions&adrprop=user|comment|content [try in ApiSandbox]
Result 
{
    "query": {
        "alldeletedrevisions": [
            {
                "pageid": 0,
                "revisions": [
                    {
                        "user": "Example",
                        "comment": "Test",
                        "contentformat": "text/x-wiki",
                        "contentmodel": "wikitext",
                        "content": "Page for alldeletedrevisions example"
                    }
                ],
                "ns": 0,
                "title": "ADR Page"
            }
        ]
    }
}

Possible warnings[edit]

  • Couldn't diff to r######: content is hidden
    • Thrown when the revision has been hidden (e.g., using RevisionDelete or Oversight).
  • Conversion to XML is supported for wikitext only, title uses content model content model
    • Thrown when the parsetree property or generatexml parameter is used and the content model (as returned by the content property) is not set to wikitext
  • Template expansion is supported for wikitext only, title uses content model content model
    • Thrown when the expandtemplates parameter is used and the content model (as returned by the content property) is not set to wikitext
  • The requested format contentFormat is not supported for content model model used by name
    • Thrown when the content of either the current revision or one being diffed to is not supported (typically, not text).
  • For better performance when generating titles, set gadrdir=newer
    • Thrown when using this module as a generator to enumerate pages in a namespace and using the generatetitles parameter together with dir=older (either specifically or by default).

Possible errors[edit]

Code Info
adrdiffto adrdiffto must be set to a non-negative number, "prev", "next" or "cur"
adrnosuchrevid There is no revision with ID ID
adrnosuchsection There is no section section in rID
adrpermissiondenied You don't have permission to view deleted revision information
adrpermissiondenied You don't have permission to view deleted revision content
adrbadparams The adrfrom/adrto/adrprefix/adrexcludeuser parameter cannot be used with adruser
adrbadparams The adrstart/adrend parameter may only be used with adruser



list=alldeletedrevisions (adr)

(main | query | alldeletedrevisions)
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0+

List all deleted revisions by a user or in a namespace.

Parameters:
adrprop

Which properties to get for each revision:

ids
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision.
userid
User ID of the revision creator.
size
Length (bytes) of the revision.
sha1
SHA-1 (base 16) of the revision.
contentmodel
Content model ID of the revision.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Text of the revision.
tags
Tags for the revision.
parsetree
The XML parse tree of revision content (requires content model wikitext).
Values (separate with | or alternative): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
Default: ids|timestamp|flags|comment|user
adrlimit

Limit how many revisions will be returned.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
adrexpandtemplates

Expand templates in revision content (requires adrprop=content).

Type: boolean (details)
adrgeneratexml
Deprecated.

Generate XML parse tree for revision content (requires adrprop=content; replaced by adrprop=parsetree).

Type: boolean (details)
adrparse

Parse revision content (requires adrprop=content). For performance reasons, if this option is used, adrlimit is enforced to 1.

Type: boolean (details)
adrsection

Only retrieve the content of this section number.

adrdiffto

Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

adrdifftotext

Text to diff each revision to. Only diffs a limited number of revisions. Overrides adrdiffto. If adrsection is set, only that section will be diffed against this text.

adrdifftotextpst

Perform a pre-save transform on the text before diffing it. Only valid when used with adrdifftotext.

Type: boolean (details)
adrcontentformat

Serialization format used for adrdifftotext and expected for output of content.

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

Only list revisions by this user.

Note: Due to miser mode, using adruser and adrnamespace together may result in fewer than adrlimit results returned before continuing; in extreme cases, zero results may be returned.

Type: user name
adrnamespace

Only list pages in this namespace.

Note: Due to miser mode, using adruser and adrnamespace together may result in fewer than adrlimit results returned before continuing; in extreme cases, zero results may be returned.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 90, 91, 92, 93, 100, 101, 102, 103, 104, 105, 106, 107, 486, 487, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303, 2600
To specify all values, use *.
adrstart

The timestamp to start enumerating from.

May only be used with adruser.
Type: timestamp (allowed formats)
adrend

The timestamp to stop enumerating at.

May only be used with adruser.
Type: timestamp (allowed formats)
adrdir

In which direction to enumerate:

newer
List oldest first. Note: adrstart has to be before adrend.
older
List newest first (default). Note: adrstart has to be later than adrend.
One of the following values: newer, older
Default: older
adrfrom

Start listing at this title.

Cannot be used with adruser.
adrto

Stop listing at this title.

Cannot be used with adruser.
adrprefix

Search for all page titles that begin with this value.

Cannot be used with adruser.
adrexcludeuser

Don't list revisions by this user.

Cannot be used with adruser.
Type: user name
adrtag

Only list revisions tagged with this tag.

adrcontinue

When more results are available, use this to continue.

adrgeneratetitles

When being used as a generator, generate titles rather than revision IDs.

Type: boolean (details)
Examples:
List the last 50 deleted contributions by user Example.
api.php?action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50 [open in sandbox]
List the first 50 deleted revisions in the main namespace.
api.php?action=query&list=alldeletedrevisions&adrdir=newer&adrnamespace=0&adrlimit=50 [open in sandbox]
Retrieved from "https://www.mediawiki.org/w/index.php?title=API:Alldeletedrevisions&oldid=2425865"