Extension:Admin Links/Hooks/AdminLinks/cs
| AdminLinks | |
|---|---|
| Available from version ??? |
|
| Define function: | public static function onAdminLinks( array( &$admin_links_tree ) ) { ... }
|
| Attach hook: | $wgHooks['AdminLinks'][] = 'MyExtensionHooks::onAdminLinks';
|
| Called from: | File(s): AdminLinks / includes/AdminLinks.php Function(s): execute |
For more information about attaching hooks, see Příručka:Háčky.
For examples of other extensions using this hook, see Category:AdminLinks extensions/cs.
Aby rozšíření přidávalo odkazy a sekce na stránku Admin Links, musí definovat novou funkci a zaregistrovat ji pomocí háčku "AdminLinks". Registrace by měla vypadat takto:
$wgHooks['AdminLinks'][] = 'my-function';
A záhlaví funkce by mělo vypadat takto:
function my-function(&$admin_links_tree)
"Strom" předaný do funkce je typu ALTree. Každý strom ALTree obsahuje skupinu sekcí typu ALSection. Sekce se skládá ze skupiny řádků typu ALRow. Řádek nakonec obsahuje skupinu odkazů nebo jiného textu, každý typu ALItem. Relevantní metody pro každou z nich jsou:
ALTree:
getSection($section_header)- načte část stromu, která má toto záhlavíaddSection($section, $next_section_header = null)- přidá sekci do tohoto stromu před sekci se zadaným záhlavím, pokud je zadáno
ALSection:
getRow($row_name)- načte řádek z této sekce, který má toto záhlavíaddRow($row, $next_row_name = null)- přidá řádek do této sekce před řádek se zadaným názvem, pokud je zadán
ALRow:
addItem($item, $next_item_label = null)- přidá položku do tohoto řádku před položku se zadaným štítkem, pokud je zadán
ALItem:
newFromPage($page_name_or_title, $description = null, $params = null)- vytvoří nový objekt ALItem, který odkazuje na stránku wiki, s možností zadat popis a parametry; prvním argumentem může být název stránky nebo objekt TitlenewFromSpecialPage($page_name)- vytvoří nový objekt ALItem, který odkazuje na speciální stránkunewFromEditLink($page_name, $description)- vytvoří nový objekt ALItem, který odkazuje na akci 'upravit' stránku wiki, se zadaným textovým popisemnewFromExternalLink($url, $label)- creates a new ALItem object that links to a URL, with a specified text label
vytvoří nový objekt ALItem, který odkazuje na URL, se zadaným textovým štítkem