Mer avancerat temabyggande: temafunktioner

Med hjälp av tpl-filer, css-filer och Firebug kan man ändra rätt mycket när det gäller Drupals utseende. Men vissa saker är svåra att ändra, så som i vilken ordning olika element hamnar. För att ändra såna saker behöver man ofta använda tema-funktioner - de funktioner som anropas när innehållet på en sida ska läggas i ordning för att visas.

Här är ett exempel på hur man kan använda temafunktioner för att ändra utseendet på sin webbplats. Exemplet gäller hur man plockar bort avsnittet "Member for" ("Medlem i") på användarsidorna, men förhoppningsvis är det tillräckligt generellt skrivet för att kunna tillämpas i många olika sammanhang.

Steg 0: Ha ett eget tema

När man ändrar saker i Drupal är det viktigt att inte göra ändringarna direkt i core - de filer man får med när man laddar hem Drupal. Teman du vill ändra i bör ligga i katalogen sites/all/themes/namn-på-tema. Om du bara vill leka med temafunktioner är Zen en utmärkt utgångspunkt, men kanske har du ett mer färdigt tema som du bara vill ändra ett par småsaker i.

Steg 1: Hitta funktionen du vill ändra

Det stora jobbet med att ändra en temafunktion är egentligen att hitta vilken funktion det är som styr just det elementet du vill påverka. Ett rätt effektivt sätt är att kolla på källkoden (eventuellt med hjälp av Firebug) efter karaktäristiska css-klasser som står tillsammans med det som du vill ändra.
Om man tittar på källkoden för "Member for" på användarsidan ser den ut som följer:

Lämpliga saker att leta efter här är exempelvis class="user-member" och class="profile" (och kanske class="picture").
>> Varför det? Jo, för att css-klasserna är med allra största sannolikhet resultatet av en temafunktion, eftersom de styr hur sidan ser ut. (Texten "Member for" är visserligen det vi vill ändra, men själva texten handlar om innehållet på sajten, inte hur det visas.)

Det finns olika sätt att leta upp kodbitar i Drupals källkod, men en effektiv metod är Drupal Code Search. Om vi söker på css-klasserna ovan ger class="profile" bingo: På rad 651 i modules/user/user.module finns funktionen theme_user_profile, som verkar innehålla precis det vi vill ändra.
>> Hur vet vi det? Jo, dels börjar funktionsnamnet med theme_, vilket betyder att det är en temafunktion. Dels tyder raderna $output = '<div class="profile">'; och $output .= '<dt class="'. $item['class'] .'">'. $item['title'] .'</dt>'; ... $output .= '<dd class="'. $item['class'] .'">'. $item['value'] .'</dd>'; på att det är precis här som användarens medlemstid skrivs ut. En bra hint är också att detta är den enda träffen vi får upp på kodsökningen.

Steg 2: Kopiera och döp om temafunktionen

När vi väl hittat temafunktionen ska vi inte börja pilla i den förrän vi gjort oss en egen kopia. Det gör vi genom att kopiera hela funktionen - i detta fall rad 651 till 670 - och klistra in den sist i template.php för vårt eget tema. (Det går säkert att använda andra php-filer i temat, men om det inte finns anledning att låta bli är template.php ett bra ställe.)
Nästa sak vi gör är att ändra namn på temafunktionen, från theme_user_profile till namn-på-tema_user_profile. Med ett ett mer specifikt funktionsnamn kommer Drupal att anropa vår egen temafunktion, och låta den mer generella funktionen i core vara. Detta betyder också att temafunktionen bara anropas om vårt eget tema är aktivt, vilket är en fördel. (Dessutom slipper vi två funktioner med exakt samma namn, vilket inte funkar så bra i PHP.)
När vi har gjort detta har vi en alldeles egen temafunktion, som vi får ändra i hur mycket vi vill.

Steg 3: Ändra i temafunktionen

Sista steget är det roligaste. Då får vi mecka runt i funktionen för att få den att göra precis som vi vill. För många temafunktioner är det rätt lätt att se vad som skrivs ut - olika element har olika rader, och det framgår rätt tydligt vad de olika raderna gör. I vårt fall är det däremot lite knepigare. En foreach-loop går igenom alla kategorier i användarkontot, och matar ut etiketter och värden som finns lagrade för (icke-tomma) kategorier:

Det vi vill är att kategorin "History" ska hoppas över. Ett smidigt sätt att göra detta är att använda ett enkelt if-villkor, som hoppar över all form av output om $category skulle vara "History". Funktionen blir så som följer (med ny rad näst överst, och matchande slutparentes näst underst):

Som vanligt när man håller på och meckar i kod är det smart att spara och testa resultatet. Förhoppningvis fungerar detta bra, men om vi skulle ha installerat svenska på sajten skulle det förmodligen inte ha funkat. Varför? Jo, för att $category inte längre är "History", utan "Historia".
För att avhjälpa detta använder vi funktionen t(), som är den som översätter strängar i Drupal. Den nya raden blir då if ($category != t('History')) {, och allt fungerar som vi vill.
Resultatet blir som följer:

Tack till mapiedra, Campsouster, med flera för bra bakgrund till denna guide, samt till deviantintegral som tog sig tid att förklara lite grejer på Drupals IRC-forum.