檢視 Mediawiki 擴展標籤的原始碼

[[分類:Mediawiki]]
==原理解說==
===一、撰寫===
於 extension.json 中設定以下的勾子(hooks)：<pre>
...
  "Hooks": {
    "ParserFirstCallInit": "ExampleExtension::onParserFirstCallInit"
   },
...</pre>

新增程式：<pre>
<?php
class ExampleExtension {
	// 註冊實體化回傳外掛
	public static function onParserFirstCallInit( Parser $parser ) {
		// 當解析器看到<sample>標記時，它會執行renderTagSample(見下文)
		$parser->setHook( 'sample', [ self::class, 'renderTagSample' ] );
	}

	// 實體化 <sample> 的函式定義
	public static function renderTagSample( $input, array $args, Parser $parser, PPFrame $frame ) {
		// 在本例中這個函數只是將用戶輸入中的轉義字符解析為原來的樣子並再次輸出它
		return htmlspecialchars( $input );
	}
}
...</pre>
===二、使用===
此範例為&lt;sample&gt;標籤註冊回傳函式。當用戶將標籤：&lt;sample arg1='xxx' arg2='xxx'&gt;...input...&lt;/sample&gt;添加到頁面時，解析器將調用renderTagSample()函式，傳入四個參數：
#$input：&lt;sample&gt;和&lt;/sample&gt;標籤之間輸入。如果標籤是「開始與結束合體的」則輸入'null'，即&lt;sample /&gt;
#$args：標籤屬性，像 HTML 標籤屬性一樣輸入；這是一個以屬性名稱作鍵的陣列(鍵-值對)。
#$parser：父解析器(一個解析器物件)；更上級的不掛，使用它來獲取上下文標題，解析維基文字、大括號，註冊鏈接關係和依賴關係等。
#$frame：父框架(PPFrame物件)。它與$parser一起使用，為解析器提供有關調用外掛的上下文的更完整資訊。
===三、設定===
MediaWiki 1.25 之前外掛名和外觀的配置是在 PHP 檔名或外觀名稱一致的，如 MyExtension.php 或 MySkin.php。<pre>
require_once "$IP/extensions/Hello/Hello.php";
require_once "$IP/extensions/FooBar/FooBar.php";
$wgFooBarEnable = true;
require_once "$IP/skins/Baz/Baz.php";</pre>
也可以寫成：<pre>
wfLoadExtensions( array( 'Hello', 'FooBar' ) );
$wgFooBarEnable = true;
wfLoadSkin( 'Baz' );</pre>
如果您將外掛放在 $IP/extensions 以外的位置，您需要重設 $wgExtensionDirectory 。如果您的皮膚未在 $IP/skins 中，您需要重設 $wgStyleDirectory 。重設必須在您載入任何外掛或皮膚前完成。<pre>
$wgExtensionDirectory = '/some/path';
wfLoadExtension('FooBar'); // 參看 /some/path/FooBar/extension.json
$wgStyleDirectory = '/my/skins';
wfLoadSkins(array('BarBaz','BazBar')); // 參看 /my/skins/BarBaz/skin.json 及 /my/skins/BazBar/skin.json</pre>
===四、實例===
*LinkedImages.php
*:LocalSettings.php 中
<pre>include_once("$IP/extensions/LinkedImages.php");</pre>

==參考資料==
#[https://www.mediawiki.org/w/index.php?title=Manual:Tag_extensions/zh&variant=zh-tw 外掛標籤手冊]
#[https://www.mediawiki.org/w/index.php?title=Manual:Extension_registration/zh&variant=zh-tw 外掛如何註冊]
#[https://www.mediawiki.org/w/index.php?title=Manual:Extensions/zh&variant=zh-tw 各類外掛手冊]
==自行撰寫的外掛標籤==
===一、LinkedImages.php(已被封存)===
原用於讓圖產生連結，是非常好的撰寫範例。
====(一)已被封存====
#MediaWiki 1.14 版之後支援語法 &#91;&#91;Image:圖名|寬px|link=目的頁&#93;&#93;，如<p align='right'>[[Image:Go_top.gif|link=#top]]</p>上述語法中，若 link= 留空，則該圖像將不再可點擊。
#也可以使用 CSS ，請參考：[https://www.mediawiki.org/wiki/Manual:Linked_images/zh#Site_CSS https://www.mediawiki.org/wiki/Manual:Linked_images/zh#Site_CSS]
#有伺服器權限時，去啟用 $wgAllowExternalImages(允許來自任何域的外部圖像)或 $wgAllowExternalImagesFrom(限制域的列表)，然後創建到「外部」圖像的「外部」鏈接。要使用完整 URL 而不是本地鏈接。<br/>也可以用 CSS plainlinks 類別來消除圖像，只留下該圖像的「外部鏈接」，如：
#:<span class='plainlinks'>[http://jendo.org/wiki1231/images/4/49/Go_top.gif http://jendo.org/wiki1231/images/4/49/Go_top.gif]</span>
#使用 Raw HTML，請參考：[https://www.mediawiki.org/wiki/Manual:Linked_images/zh#Raw_HTML https://www.mediawiki.org/wiki/Manual:Linked_images/zh#Raw_HTML]
#使用 Via extensions，請參考：[https://www.mediawiki.org/wiki/Manual:Linked_images/zh#Via_extensions https://www.mediawiki.org/wiki/Manual:Linked_images/zh#Via_extensions]
#您可以做一些更麻煩的事情，例如修改 /includes/Sanitizer.php (HTML標籤白名單在其中)，然後將<img />添加到允許的標籤列表中。
====(二)[https://www.mediawiki.org/w/index.php?oldid=603835 舊外掛標籤的說明]====
====(三)使用範例====
「跳至頁首」內容為：<pre>
&lt;p align='right'&gt;&lt;linkedimage&gt;
wikipage=#top
img_src=Go_top.gif
tooltip=跳頁首
img_alt=跳頁首
&lt;/linkedimage&gt;&lt;/p&gt;</pre>

===二、videoflash.php(已被封存)===