قالب:وصلة شبكية لامتداد
نسخ القالب ولصقه
MyHook | |
---|---|
متوفر بدءا من الإصدار ??? |
|
تعريف الوظيفة: | public static function onMyHook( $x, $y ) { ... }
|
وصلة الربط الشبكية: | $wgHooks['MyHook'][] = 'MyExtensionHooks::onMyHook';
|
تستدعى من: | ملف/ملفات: |
لمزيد من المعلومات المتعلقة بإضافة وصلة شبكية، طالع دليل:وصلات .
كي تطلع على أمثلة على امتدادات أخرى تستخدم هذه الوصلة الشبكية، طالع Category:MyHook extensions/ar.
{{ExtensionHook |name = MyHook |version = |gerrit = |removed = |summary = |args = $x, $y |extension = |source = |sourcefunction = |sourceclass = |newvarname = |newvarlink = |nocatdesc = }}
ملاحظات على الاستخدام
- name
- اسم الوصلة الشبكية. عادة ما يكون هو نفس اسم الصفحة الفرعية.
- version
- إصدار برمجيات ميدياويكي الذي أضيف إليه هذه الوصلة الشبكي للمرة الأولى.
- rev
- إصدار مخزن SVN الذي أضيف إليه هذه الوصلة الشبكية للمرة الأولى. لو كان هذا المعطى مضافا، سوف يقدم رابط إلى صفحة مراجعة الكود البرمجي المناسبة لذلك الغرض (مثال r115794).
- gerrit
- رقم تغيير غيريت (Gerrit) الذي أضيف إليه هذه الوصلة الشبكية للمرة الأولى. لو كان هذا المعطى مضافا، سوف يقدم رابط إلى صفحة مجموعة تغيير غيريت (Gerrit) المناسبة لذلك الغرض (مثال تغيير غيريت رقم 5).
- removed
- لو كانت الوصلة قد حذفت، سيكون الرقم هو إصدار برمجيات ميدياويكي الذي حذفت منه.
- deprecated
- لو كانت الوصلة متقادمة (إلا أنها لم تحذف)، سيكون ذلك إصدار برمجيات ميدياويكي الذي تقادمت فيه.
- summary
- بيان قصير عن غرض الوصلة.
- يحبذ إضافة بيان مفصل، ويجب أن يضاف إلى محتوى الصفحة الرئيسية.
- لو حدثت البيان المختصر، يرجى أيضا تحديث الجدولين الموجودين على صفحة دليل:وصلات .
- args
- المعاملات كما تستخدم في الجزء الأعلى من الوظيفة.
- extension
- Extension name where hook is called; for when the source is not in the MediaWiki core code repository.
- source
- الموقع (اسم الملف) الذي يستدعي هذه الوصلة في الكود البرمجي. يمكن إضافة مواقع إضافية مستخدما source2...source10.
- sourcefunction
- اسم الوظيفة التي تستدعي هذه الوصلة. يمكن إضافة غيرها مستخدما sourcefunction2.
- sourceclass
- اسم التصنيف الذي يستدعي هذه الوصلة.
- templatemode
- يضبط إلى القيمة nocats لو كان توثيق الوصلة لا يجب أن يظهر في تصنيفات برمجيات ميدياويكي المعتادة.
- إن استخدام هذا القالب يضيف تلقائيا صفحة التوثيق إلى التصنيفات التالية:
- وصلات ميدياويكي
- وصلات أضيفت إلى ميدياويكي...
- توجد حالات لا يستحب فيها تصنيف صفحات توثيق الوصلات آليا. قد تشمل أمثلة ذلك حينما توثق وصلة في امتداد أو حينما توثق القالب ذاته.
- nocatdesc
- لو رفعت وصلة كليةً من أحد إصدارات ميدياويكي عن طريق ضبط
yes
، لن تظهر في بيان التصنيف مرة أخرى.
Template data
A card which describes the information of a hook registered by an extension.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Template mode | templatemode | no description | String | optional |
Name | name | The name of the hook. This is usually the same name as the sub-page. | String | required |
SVN revision introduced | rev | SVN revision in which this hook was first introduced. If this parameter is given, it will link to the appropriate CodeReview page. | String | optional |
Gerrit changeset introduced | gerrit | Gerrit change number in which this hook was first introduced. If this parameter is given, it will link to the appropriate Gerrit changeset page. | Number | suggested |
Version introduced | version | The version of MediaWiki this hook was first introduced in. | String | suggested |
Version deprecated | deprecated | If the hook has been deprecated, the version of MediaWiki that it was deprecated in. | String | optional |
Gerrit ID of deprecation | gerritdeprecated | no description | Number | optional |
Version removed | removed | If the hook has been removed, the version of MediaWiki that it was removed in. | String | optional |
Gerrit ID of removal | gerritremoved | no description | Number | optional |
Replacement name | newvarname | If the hook is either deprecated or removed, name the feature that replaces this hook, if there is any replacement. | String | optional |
Replacement link | newvarlink | If the hook is either deprecated or removed, link to the feature that replaces this hook, if there is any replacement. | Page name | optional |
Summary | summary | A short description of the hook's purpose. More detailed descriptions are desirable, and should be added to the main page content. | String | suggested |
Arguments | args | The arguments that are defined by the hook signature. | String | required |
Extension name | extension | Extension name where the hook is called; for when the source is not in the MediaWiki core code repository. | Page name | required |
Skin name | skin | Skin name where the hook is called; alternatively, set for the 'extrension' variable. | Page name | optional |
Source 1 | source | Location (file name) which calls this hook in the code. | String | suggested |
Source 2 | source2 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 3 | source3 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 4 | source4 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 5 | source5 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 6 | source6 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 7 | source7 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 8 | source8 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 9 | source9 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source 10 | source10 | Location (file name) which calls this hook in the code, if another source exists | String | optional |
Source class | sourceclass | The fully qualified class name (FQCN) which calls this hook. | String | suggested |
Source function | sourcefunction | Name of the function which calls this hook | String | suggested |
Source function 2 | sourcefunction2 | Name of the function which calls this hook, if another functions call this hook | String | optional |
No category description | nocatdesc | Allows to hide the category hook description if the hook was removed completely from MediaWiki version. | String | optional |