API:Allredirects
From MediaWiki.org
This page is part of the MediaWiki action API documentation. |
MediaWiki action API
- Introduction and quick start
- FAQ
- Tutorial
- Formats
- Error reporting
- Restricting usage
- Cross-site requests
- Authentication
- Queries
- Searching (by title, content, coordinates...)
- Parsing wikitext and expanding templates
- Purging pages' caches
- Parameter information
- Changing wiki content
- Create and edit pages
- Move pages
- Merge pages
- Rollback
- Delete pages
- Restore deleted revisions
- (Un)protect pages
- (Un)block users
- (Un)watch pages
- Mark revisions of watched pages as visited
- Send email
- Patrol changes
- Import pages
- Change user group membership
- Upload files
- User options
- Tokens
- Page language
- Watchlist feed
- Wikidata
- Extensions
- Using the API in MediaWiki and extensions
- Miscellaneous
- Implementation
- Client code
- Asserting
Allredirects | ||
---|---|---|
This module cannot be used as a Generator . |
||
Prefix | ar | |
Required rights | none | |
Post only? | No | |
Generated help | Current | |
Version added |
|
List all redirects to a namespace.
Parameters[edit]
arcontinue
: When more results are available, use this to continue
arfrom
: The title of the redirect to start enumerating from
arto
: The title of the redirect to stop enumerating at
arprefix
: Search for all target pages that begin with this value
arunique
: Only show distinct target pages. Cannot be used witharprop=ids|fragment|interwiki
. When used as a generator, yields target pages instead of source pages.
arprop
: What pieces of information to include. (Default:title
)ids
: Adds the pageid of the redirecting page. (Cannot be used witharunique
.)title
: Adds the title of the redirectfragment
: Adds the fragment from the redirect, if any. (Cannot be used witharunique
.)interwiki
: Adds the interwiki prefix from the redirect, if any. (Cannot be used witharunique
.)
arnamespace
: The namespace to enumerate. (Default: 0)
arlimit
: How many total items to return. (Default: 10)
ardir
: The direction in which to list (ascending/descending). (Default:ascending
)
The following documentation is the output of Special:ApiHelp/query+allredirects, generated from query+allredirects's source code. |
list=allredirects (ar)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
List all redirects to a namespace.
Parameters:
- arcontinue
-
When more results are available, use this to continue.
- arfrom
-
The title of the redirect to start enumerating from.
- arto
-
The title of the redirect to stop enumerating at.
- arprefix
-
Search for all target pages that begin with this value.
- arunique
-
Only show distinct target pages. Cannot be used with arprop=ids|fragment|interwiki.
When used as a generator, yields target pages instead of source pages.
- Type: boolean (details)
- arprop
-
Which pieces of information to include:
- ids
- Adds the page ID of the redirecting page (cannot be used with arunique).
- title
- Adds the title of the redirect.
- fragment
- Adds the fragment from the redirect, if any (cannot be used with arunique).
- interwiki
- Adds the interwiki prefix from the redirect, if any (cannot be used with arunique).
- Values (separate with | or alternative): ids, title, fragment, interwiki
- Default: title
- arnamespace
-
The namespace to enumerate.
- One of the following values: 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
- Default: 0
- arlimit
-
How many total items to return.
- No more than 500 (5,000 for bots) allowed.
- Type: integer or max
- Default: 10
- ardir
-
The direction in which to list.
- One of the following values: ascending, descending
- Default: ascending
Examples:
- List target pages, including missing ones, with page IDs they are from, starting at B.
- api.php?action=query&list=allredirects&arfrom=B&arprop=ids|title [open in sandbox]
- List unique target pages.
- api.php?action=query&list=allredirects&arunique=&arfrom=B [open in sandbox]
- Gets all target pages, marking the missing ones.
- api.php?action=query&generator=allredirects&garunique=&garfrom=B [open in sandbox]
- Gets pages containing the redirects.
- api.php?action=query&generator=allredirects&garfrom=B [open in sandbox]