Template:ResolveEntityId/doc
 | This template is used on approximately 1,200,000 pages, or roughly 44362% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
Usage
Functions similarly to mw.wikibase.resolvePropertyId, but for Wikidata entities instead of properties.
Returns an entity id for the given label or id. This allows using the entity's labels instead of ids in all places. If no entity was found for the label or id, or if the label is ambiguous, a nil value is returned.
When attempting to resolve a label, only entities with English Wikipedia sitelinks are considered in the search. If a label exists in Wikidata, but does not have the requisite language sitelink, a nil value is returned.
Call from within a module (_id)
Example calls within a module might look like the following:
| Code | Result | Notes |
|---|---|---|
| <syntaxhighlight lang="lua">local resolveEntityId = require( "Module:ResolveEntityId" )._id
id = resolveEntityId('Q42')</syntaxhighlight> |
id = Script error: No such module "ResolveEntityId".
|
"Q42" is a valid Wikidata ID, and a Wikidata items exists with that Id, so it is therefore returned intact |
| <syntaxhighlight lang="lua">local resolveEntityId = require( "Module:ResolveEntityId" )._id
id = resolveEntityId('Q0')</syntaxhighlight> |
id = Script error: No such module "ResolveEntityId".
|
"Q0" is not a valid Wikidata ID, and while the Wikipedia article Q0 exists, it is a disambiguation page, so nil is returned
|
| <syntaxhighlight lang="lua">local resolveEntityId = require( "Module:ResolveEntityId" )._id
id = resolveEntityId('Q404')</syntaxhighlight> |
id = Script error: No such module "ResolveEntityId".
|
"Q404" is a Wikidata redirect to Q395, so the latter is returned |
| <syntaxhighlight lang="lua">local resolveEntityId = require( "Module:ResolveEntityId" )._id
id = resolveEntityId('Q2147483647')</syntaxhighlight> |
id = Script error: No such module "ResolveEntityId".
|
Q2147483647 is a valid Wikidata ID, but no entity exists with that ID, so nil is returned
|
| <syntaxhighlight lang="lua">local resolveEntityId = require( "Module:ResolveEntityId" )._id
id = resolveEntityId('Douglas Adams')</syntaxhighlight> |
id = Script error: No such module "ResolveEntityId".
|
The article Douglas Adams exists and has the Wikidata ID "Q42", so that is returned. |
| <syntaxhighlight lang="lua">local resolveEntityId = require( "Module:ResolveEntityId" )._id
id = resolveEntityId('ThisIsNotARealWikidataItem')</syntaxhighlight> |
id = Script error: No such module "ResolveEntityId".
|
"ThisIsNotARealWikidataItem" is not a valid Wikidata ID, and no Wikipedia article exists at ThisIsNotARealWikidataItem, so nil is returned
|
| <syntaxhighlight lang="lua">local resolveEntityId = require( "Module:ResolveEntityId" )._id
id = resolveEntityId('ThisIsNotARealWikidataItem', 'Wikidata ID not found!')</syntaxhighlight> |
id = Script error: No such module "ResolveEntityId".
|
Same as above, but the custom error message Wikidata ID not found! is returned
|
| <syntaxhighlight lang="lua">local resolveEntityId = require( "Module:ResolveEntityId" )._id
id = resolveEntityId('Douglas adams')</syntaxhighlight> |
id = Script error: No such module "ResolveEntityId".
|
"Douglas adams" is not a valid Wikidata ID, and while Douglas adams (with a lower-case "a") exists, it is a redirect to Douglas Adams. Therefore the Wikidata ID for the latter page is returned |
| <syntaxhighlight lang="lua">local resolveEntityId = require( "Module:ResolveEntityId" )._id
id = resolveEntityId('Wikipedia:Village pump (technical)/Archive 1')</syntaxhighlight> |
id = Script error: No such module "ResolveEntityId".
|
"Wikipedia:Village pump (technical)/Archive 1" is not a valid Wikidata ID, and while Wikipedia:Village pump (technical)/Archive 1 exists, it does not have a Wikidata ID, so nil is returned
|
Use from within a template (entityid)
The following will return the entity id (or nothing if the ID doesn't exist):
{{#invoke:ResolveEntityId|entityid|id}}
The following will return the entity id (or the alternate text if the ID doesn't exist):
{{#invoke:ResolveEntityId|entityid|id|alternate text if id is nil}}
Former _entityid function
The _entityid function, which required that the frame be passed as the first argument, has been removed from the module because workarounds are no longer needed for phab:T143970.