Template:Class doclink

{{{1}}}

Template documentation

[view] [edit] [history] [purge]

Given a class name implemented by mediawiki/core, this renders a link to automatically-generated documentation for the class at https://doc.wikimedia.org/mediawiki-core/master/php/

Code	Preview
{{class doclink|OutputPage}}	OutputPage
{{class doclink|WebRequest}}	WebRequest
{{class doclink|class=RequestContext}}	RequestContext
{{class doclink|Config|type=interface}}	Config
{{class doclink|Wikimedia\Rdbms\Database|Wikimedia\Rdbms\Database::select|anchor=a3b03dd27f434aabfc8d2d639d1e5fa9a}}	Wikimedia\Rdbms\Database::select
{{class doclink|class=Wikimedia\Rdbms\Database|text=Wikimedia\Rdbms\Database::select|anchor=a3b03dd27f434aabfc8d2d639d1e5fa9a}}	Wikimedia\Rdbms\Database::select

Parameters

<templatedata> { "params": { "1": { "aliases": [ "class" ], "label": "class name", "description": "Fully qualified class name.", "example": "Wikimedia\\Rdbms\\Database", "type": "string", "required": true }, "2": { "aliases": [ "text" ], "label": "text", "description": "Link text.", "example": "Database", "type": "string" }, "project": { "label": "Project / extension name", "description": "Project name, from https://doc.wikimedia.org/index/ . For extensions, this is just the name of the extension. For most other things, it is the repository name, with dashes instead of slashes.", "example": "mediawiki-libs-RemexHtml", "type": "string" }, "branch": { "description": "Git branch (if not master).", "example": "main", "type": "string" }, "type": { "label": "type", "description": "Type of the entity: class or interface. (With the current documentation structure, it's not possible to link traits.) Required if it's not a class.", "type": "string", "default": "interface" }, "anchor": { "description": "URL anchor. Used for linking to a specific property or method of the class.", "example": "a3b03dd27f434aabfc8d2d639d1e5fa9a", "type": "string" } }, "description": "Renders a link to automatically-generated documentation for a class or method at https://doc.wikimedia.org/mediawiki-core/master/php/", "paramOrder": [ "1", "2", "anchor", "type", "project", "branch" ], "format": "inline" } </templatedata>

See also

• {{Class }} links to the implicit Manual:ClassName.php wiki page
• {{MW file }} renders a table for a PHP file in core, including doc links for the classes implemented by it
• {{Method doclink }} to link to a particular method
• {{File doclink }}
• {{Js doclink }} for Javascript API links

The above documentation is transcluded from Template:Class doclink/doc. (edit | history)
Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.