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 a very large number of pages. To avoid large-scale disruption and unnecessary server load, any changes to this module should first be tested in its /sandbox or /testcases subpages. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
Usage
Functions similarly to mw.wikibase.resolvePropertyId, but for PBD 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 PBC sitelinks are considered in the search. If a label exists in PBD, 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 = nil
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q0')
|
id = nil
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q141')
|
id = Q141
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q8')
|
id = Q8
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Andrey Vic')
|
id = Q8
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('ThisIsNotARealPBDItem')
|
id = nil
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('ThisIsNotARealPBDItem', 'PBD ID not found!')
|
id = 'PBD 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.