Module:ResolveEntityId/doc
This is the documentation page for Module:ResolveEntityId
 | This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected. |
 | This Lua module is used on approximately 2,390,000 pages, or roughly 24950% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. 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 |
|---|---|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q42')
|
id = Q42
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q0')
|
id = nil
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q404')
|
id = nil
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q151384451555')
|
id = nil
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Douglas Adams')
|
id = nil
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('ThisIsNotARealWikidataItem')
|
id = nil
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('ThisIsNotARealWikidataItem', 'Wikidata ID not found!')
|
id = 'Wikidata ID not found!'
|
Use from within a template (entityid)
The following will return the entity id (or nil 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}}
Deprecated (_entityid)
The _entityid function, which required that the frame be passed as the first argument, has been deprecated because workarounds are no longer needed for phab:T143970.