Module:ResolveEntityId/doc

This is a documentation subpage for Module:ResolveEntityId.
It may contain usage information, categories and other content that is not part of the original module page.

This Lua module is used on approximately 473,000 pages, or roughly 1% 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 entitiy was found for the label or id, or if the label is ambiguous, a nil value is returned.

Call from within a module (_id)

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 = Q42

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 (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.