قالب:وصلة شبكية لامتداد

From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page Template:ExtensionHook and the translation is 100% complete.
Other languages:
Deutsch • ‎English • ‎Türkçe • ‎dansk • ‎français • ‎polski • ‎svenska • ‎русский • ‎العربية • ‎中文 • ‎日本語
توثيق القالب

نسخ القالب ولصقه

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 =
}}

ملاحظات على الاستخدام

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
اسم التصنيف الذي يستدعي هذه الوصلة.
newvarname
يستخدمه {{Removed}} أو {{Deprecated}} حينما يضبط أي من removed أو deprecated.
newvarlink
يستخدمه {{Removed}} أو {{Deprecated}} حينما يضبط أي من removed أو deprecated.
templatemode
يضبط إلى القيمة nocats لو كان توثيق الوصلة لا يجب أن يظهر في تصنيفات برمجيات ميدياويكي المعتادة.
إن استخدام هذا القالب يضيف تلقائيا صفحة التوثيق إلى التصنيفات التالية:
  • وصلات ميدياويكي
  • وصلات أضيفت إلى ميدياويكي...
توجد حالات لا يستحب فيها تصنيف صفحات توثيق الوصلات آليا. قد تشمل أمثلة ذلك حينما توثق وصلة في امتداد أو حينما توثق القالب ذاته.

Template data

A card which describes the information of a hook registered by an extension.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Template modetemplatemode

no description

Stringoptional
Namename

The name of the hook. This is usually the same name as the sub-page.

Stringrequired
SVN revision introducedrev

SVN revision in which this hook was first introduced. If this parameter is given, it will link to the appropriate CodeReview page.

Stringoptional
Gerrit changeset introducedgerrit

Gerrit change number in which this hook was first introduced. If this parameter is given, it will link to the appropriate Gerrit changeset page.

Numbersuggested
Version introducedversion

The version of MediaWiki this hook was first introduced in.

Stringsuggested
Version deprecateddeprecated

If the hook has been deprecated, the version of MediaWiki that it was deprecated in.

Stringoptional
Version removedremoved

If the hook has been removed, the version of MediaWiki that it was removed in.

Stringoptional
Replacement namenewvarname

If the hook is either deprecated or removed, name the feature that replaces this hook, if there is any replacement.

Stringoptional
Replacement linknewvarlink

If the hook is either deprecated or removed, link to the feature that replaces this hook, if there is any replacement.

Page nameoptional
Summarysummary

A short description of the hook's purpose. More detailed descriptions are desirable, and should be added to the main page content.

Stringsuggested
Argumentsargs

The arguments that are defined by the hook signature.

Stringrequired
Extension nameextension

Extension name where the hook is called; for when the source is not in the MediaWiki core code repository.

Page namerequired
Source 1source

Location (file name) which calls this hook in the code.

Stringsuggested
Source 2source2

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 3source3

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 4source4

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 5source5

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 6source6

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 7source7

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 8source8

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 9source9

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source 10source10

Location (file name) which calls this hook in the code, if another source exists

Stringoptional
Source classsourceclass

The fully qualified class name (FQCN) which calls this hook.

Stringsuggested
Source functionsourcefunction

Name of the function which calls this hook

Stringsuggested
Source function 2sourcefunction2

Name of the function which calls this hook, if another functions call this hook

Stringoptional

انظر أيضا