API:Embeddedin
Jump to navigation
Jump to search
| This page is part of the MediaWiki Action API documentation. |
| Please help improve this technical documentation! Take our MediaWiki Action API Technical Documentation User Feedback Survey before 6 January – Note: The survey uses Google Forms. See Privacy Statement – Thanks! |
| Embeddedin | ||
|---|---|---|
This module can be used as a Generator. |
||
| Prefix | ei | |
| Required rights | none | |
| Post only? | No | |
| Generated help | Current | |
| Version added |
|
|
List pages that transclude a certain page.
Parameters[edit]
eititle: List pages including this title. The title need not existeinamespace: Only list pages in these namespaceseifilterredir: How to filter redirects (Default:all)all: List all pages regardless of their redirect flagredirects: Only list redirectsnonredirects: Don't list redirects
eilimit: Maximum amount of pages to list. No more than 500 (5000 for bots) allowed. (Default: 10)eicontinue: Used to continue a previous request
Example[edit]
Find all pages that embed w:Template:Stub.
| Result |
|---|
<?xml version="1.0" encoding="utf-8"?>
<api>
<query-continue>
<embeddedin eicontinue="10|Stub|16324457" />
</query-continue>
<query>
<embeddedin>
<ei pageid="7997510" ns="0" title="Maike Evers" />
<ei pageid="10357370" ns="0" title="ConnectU" />
<ei pageid="11347592" ns="0" title="Oliver B. Greene" />
<ei pageid="11886644" ns="0" title="Godfrey Burley Group" />
<ei pageid="14882500" ns="0" title="Contra principia negantem disputari non potest" />
</embeddedin>
</query>
</api>
|
Error Codes[edit]
| Code | Info |
|---|---|
| eibadcontinue | Invalid continue param. You should pass the original value returned by the previous query. |
| The following documentation is the output of Special:ApiHelp/query+embeddedin, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org). |
list=embeddedin (ei)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0-or-later
Find all pages that embed (transclude) the given title.
Parameters:
- eititle
Title to search. Cannot be used together with eipageid.
- eipageid
Page ID to search. Cannot be used together with eititle.
- Type: integer
- eicontinue
When more results are available, use this to continue.
- einamespace
The namespace to enumerate.
- 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, 5500, 5501
- To specify all values, use *.
- eidir
The direction in which to list.
- One of the following values: ascending, descending
- Default: ascending
- eifilterredir
How to filter for redirects.
- One of the following values: all, redirects, nonredirects
- Default: all
- eilimit
How many total pages to return.
- No more than 500 (5,000 for bots) allowed.
- Type: integer or max
- Default: 10
Examples:
- Show pages transcluding Template:Stub.
- api.php?action=query&list=embeddedin&eititle=Template:Stub [open in sandbox]
- Get information about pages transcluding Template:Stub.
- api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info [open in sandbox]