Module:ResolveEntityId

Module documentation[view] [edit] [history] [purge]

This module is rated as beta. It is considered ready for widespread use, but as it is still relatively new, it should be applied with some caution to ensure results are as expected.

Page template-protected This module is currently protected from editing.
See the protection policy and protection log for more details. Please discuss any changes on the talk page; you may submit an edit request to ask an administrator to make an edit if it is uncontroversial or supported by consensus. You may also request that this page be unprotected.

Warning This Lua module is used on approximately 487,000 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	Notes
localresolveEntityId=require("Module:ResolveEntityId")._id id=resolveEntityId('Q42')	`id` = `Q42`	"Q42" is a valid Wikidata ID, and a Wikidata items exists with that Id, so it is therefore returned intact
localresolveEntityId=require("Module:ResolveEntityId")._id id=resolveEntityId('Q0')	`id` = `nil`	"Q0" is not a valid Wikidata ID, and while the Wikipedia article Q0 exists, it is a disambiguation page, so `nil` is returned
localresolveEntityId=require("Module:ResolveEntityId")._id id=resolveEntityId('Q404')	`id` = `Q404`	"Q404" is a Wikidata redirect to Q395, so the latter is returned
localresolveEntityId=require("Module:ResolveEntityId")._id id=resolveEntityId('Q2147483647')	`id` = `nil`	Q2147483647 is a valid Wikidata ID, but no entity exists with that ID, so `nil` is returned
localresolveEntityId=require("Module:ResolveEntityId")._id id=resolveEntityId('Douglas Adams')	`id` = `Q42`	The article Douglas Adams exists and has the Wikidata ID "Q42", so that is returned.
localresolveEntityId=require("Module:ResolveEntityId")._id id=resolveEntityId('ThisIsNotARealWikidataItem')	`id` = `nil`	"ThisIsNotARealWikidataItem" is not a valid Wikidata ID, and no Wikipedia article exists at ThisIsNotARealWikidataItem, so `nil` is returned
localresolveEntityId=require("Module:ResolveEntityId")._id id=resolveEntityId('ThisIsNotARealWikidataItem','Wikidata ID not found!')	`id` = `'Wikidata ID not found!'`	Same as above, but the custom error message `Wikidata ID not found!` is returned
localresolveEntityId=require("Module:ResolveEntityId")._id id=resolveEntityId('Douglas adams')	`id` = `Q42`	"Douglas adams" is not a valid Wikidata ID, and while Douglas adams (with a lower-case "a") exists, it is a redirect to Douglas Adams. Therefore the Wikidata ID for the latter page is returned
localresolveEntityId=require("Module:ResolveEntityId")._id id=resolveEntityId('Wikipedia:Village pump (technical)/Archive 1')	`id` = `nil`	"Wikipedia:Village pump (technical)/Archive 1" is not a valid Wikidata ID, and while Wikipedia:Village pump (technical)/Archive 1 exists, it does not have a Wikidata ID, so `nil` is returned

Use from within a template (entityid)

The following will return the entity id (or nothing 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}}

Former _entityid function

The _entityid function, which required that the frame be passed as the first argument, has been removed from the module because workarounds are no longer needed for phab:T143970.

The above documentation is transcluded from Module:ResolveEntityId/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Subpages of this module.

 localp={}

 functionp._id(idOrTitle,alt)
 localfunctioncheckId(id)
 ifidandmw.wikibase.entityExists(id)then
 localsitelink=mw.wikibase.getSitelink(id)
 ifsitelinkthen
 returnmw.wikibase.getEntityIdForTitle(sitelink)ormw.wikibase.getEntity(id).id
 end
 returnmw.wikibase.getEntity(id).id
 else
 returnalt
 end
 end

 iftype(idOrTitle)=='string'then
 idOrTitle=mw.ustring.upper(mw.ustring.sub(idOrTitle,1,1))..mw.ustring.sub(idOrTitle,2)
 ifmw.wikibase.isValidEntityId(idOrTitle)then
 -- idOrTitle is in the proper format for a Wikidata entity ID
 returncheckId(idOrTitle)
 else
 localeid=mw.wikibase.getEntityIdForTitle(idOrTitle)
 ifeidthen
 -- idOrTitle is a title that matches a Wikidata entity
 localinstanceOf=mw.wikibase.getBestStatements(eid,'P31')[1]--instance of
 ifnotinstanceOforinstanceOf.mainsnak.datavalue.value.id~='Q4167410'then
 -- instance-of value is missing or is not "disambiguation"
 returncheckId(eid)
 end
 else
 -- idOrTitle is a title, but no wikidata item exists for that title
 localpage=mw.title.new(idOrTitle)
 ifpagethen-- valid title
 localrtarget=page.redirectTarget
 ifrtargetthen-- title is a Wikipedia redirect
 returnp._id(rtarget.fullText,alt)
 end
 end
 end
 end
 end
 returnalt
 end

 functionp.entityid(frame)
 returnp._id(frame.args[1],frame.args[2])
 end

 returnp

Retrieved from "https://en.wikipedia.org/w/index.php?title=Module:ResolveEntityId&oldid=1119627112"