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 ~1,200,000 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 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 entitiy was found for the label or id, or if the label is ambiguous, a nil value is returned.

Call from within a module

An example call within a module might look like the following:

local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q42')

which would result in id = Q42

local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q0')

which would result in id = nil

local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q404')

which would result in id = Q404

local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q151384451555')

which would result in id = nil

local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Douglas Adams')

which would result in id = nil

local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('ThisIsNotARealWikidataItem')

which would result in id = nil

local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('ThisIsNotARealWikidataItem', 'Wikidata ID not found!')

which would result in id = 'Wikidata ID not found!'

Use from within a template

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}}