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 1,800,000 pages, or roughly 9751% 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 = Lua error at line 13: attempt to index field 'wikibase' (a nil value).
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q0')
|
id = Lua error at line 13: attempt to index field 'wikibase' (a nil value).
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q404')
|
id = Lua error at line 13: attempt to index field 'wikibase' (a nil value).
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q151384451555')
|
id = Lua error at line 13: attempt to index field 'wikibase' (a nil value).
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Douglas Adams')
|
id = Lua error at line 22: attempt to index field 'wikibase' (a nil value).
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('ThisIsNotARealWikidataItem')
|
id = Lua error at line 22: attempt to index field 'wikibase' (a nil value).
|
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('ThisIsNotARealWikidataItem', 'Wikidata ID not found!')
|
id = Lua error at line 22: attempt to index field 'wikibase' (a nil value).
|
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.
local p = {}
function p._entityid(_,id,alt)
-- backwards compatibility for deprecated _entityid function
return p._id(id,alt)
end
function p._id(id,alt)
if type(id) == 'string' then
id = mw.ustring.upper(mw.ustring.sub(id,1,1))..mw.ustring.sub(id,2)
if mw.ustring.match(id,'^Q%d+$') then
-- id is in the proper format for a Wikidata entity
if mw.wikibase.isValidEntityId(id) then
-- id is valid
id = mw.wikibase.getEntity(id)
if id then
-- entity exists
return id.id
end
end
else
id = mw.wikibase.getEntityIdForTitle(id)
if id then
-- id is a title that matches a Wikidata entity
local instanceOf = mw.wikibase.getBestStatements(id, 'P31')[1] --instance of
if instanceOf and instanceOf.mainsnak.datavalue.value.id ~= 'Q4167410' then
-- not disambiguation
return mw.wikibase.getEntity(id).id
elseif instanceOf == nil then
-- id is a title, but is missing an instance-of value
return mw.wikibase.getEntity(id).id
end
end
end
end
return alt or nil
end
function p.entityid(frame)
return p._id(frame.args[1], frame.args[2])
end
return p