Open main menu

Changes

Module:ResolveEntityId/doc

3,768 bytes added, 13:25, 7 July 2020
m
change source to syntaxhighlight
{{Module rating |beta}}
{{High-risk|~1200000}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
== Usage ==
Functions similarly to [[:mw:Extension:Wikibase_Client/Lua#mw.wikibase.resolvePropertyId|mw.wikibase.resolvePropertyId]], but for [[:wikidata:|Wikidata]] [[:mw:Extension:Wikibase_Client/Lua#mw.wikibase.entity|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:

{| class="wikitable"
|+ style="text-align:left"|
!Code !! Result
|-
|<syntaxhighlight lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q42')</syntaxhighlight>
|style="vertical-align: mid;"|<code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q42|'''nil'''}}</code>
|-
|<syntaxhighlight lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q0')</syntaxhighlight>
|style="vertical-align: mid;"|<code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q0|'''nil'''}}</code>
|-
|<syntaxhighlight lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q404')</syntaxhighlight>
|style="vertical-align: mid;"|<code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q404|'''nil'''}}</code>
|-
|<syntaxhighlight lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q151384451555')</syntaxhighlight>
|style="vertical-align: mid;"|<code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q151384451555|'''nil'''}}</code>
|-
|<syntaxhighlight lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Douglas Adams')</syntaxhighlight>
|style="vertical-align: mid;"|<code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Douglas Adams|'''nil'''}}</code>
|-
|<syntaxhighlight lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('ThisIsNotARealWikidataItem')</syntaxhighlight>
|style="vertical-align: mid;"|<code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|ThisIsNotARealWikidataItem|'''nil'''}}</code>
|-
|<syntaxhighlight lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('ThisIsNotARealWikidataItem', 'Wikidata ID not found!')</syntaxhighlight>
|style="vertical-align: mid;"|<code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|ThisIsNotARealWikidataItem|'Wikidata ID not found!'}}</code>
|}

=== Use from within a template (entityid) ===
The following will return the entity id (or <code>'''nil'''</code> if the ID doesn't exist):
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|entityid|''id''}}</code>

The following will return the entity id (or the alternate text if the ID doesn't exist):
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|entityid|''id''|''alternate text if ''id'' is '''nil'''''}}</code>

=== Deprecated (_entityid) ===
The <code>_entityid</code> function, which required that the frame be passed as the first argument, has been deprecated because workarounds are no longer needed for [[:phab:T143970]].

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Wikidata modules]]
}}</includeonly>
Anonymous user