1 Friendica Addon/Plugin-Entwicklung
4 * [Zur Startseite der Hilfe](help)
6 Bitte schau dir das Beispiel-Addon "randplace" für ein funktionierendes Beispiel für manche der hier aufgeführten Funktionen an.
7 Das Facebook-Addon bietet ein Beispiel dafür, die "addon"- und "module"-Funktion gemeinsam zu integrieren.
8 Addons arbeiten, indem sie Event Hooks abfangen.
9 Module arbeiten, indem bestimmte Seitenanfragen (durch den URL-Pfad) abgefangen werden.
11 Plugin-Namen können keine Leerstellen oder andere Interpunktionen enthalten und werden als Datei- und Funktionsnamen genutzt.
12 Du kannst einen lesbaren Namen im Kommentarblock eintragen.
13 Jedes Addon muss beides beinhalten - eine Installations- und eine Deinstallationsfunktion, die auf dem Addon-/Plugin-Namen basieren; z.B. "plugin1name_install()".
14 Diese beiden Funktionen haben keine Argumente und sind dafür verantwortlich, Event Hooks zu registrieren und abzumelden (unregistering), die dein Plugin benötigt.
15 Die Installations- und Deinstallationsfunktionfunktionen werden auch ausgeführt (z.B. neu installiert), wenn sich das Plugin nach der Installation ändert - somit sollte deine Deinstallationsfunktion keine Daten zerstört und deine Installationsfunktion sollte bestehende Daten berücksichtigen.
16 Zukünftige Extensions werden möglicherweise "Setup" und "Entfernen" anbieten.
18 Plugins sollten einen Kommentarblock mit den folgenden vier Parametern enthalten:
21 * Name: My Great Plugin
22 * Description: This is what my plugin does. It's really cool.
24 * Author: John Q. Public <john@myfriendicasite.com>
27 Registriere deine Plugin-Hooks während der Installation.
29 register_hook($hookname, $file, $function);
31 $hookname ist ein String und entspricht einem bekannten Friendica-Hook.
33 $file steht für den Pfadnamen, der relativ zum Top-Level-Friendicaverzeichnis liegt.
34 Das *sollte* "addon/plugin_name/plugin_name.php' sein.
36 $function ist ein String und der Name der Funktion, die ausgeführt wird, wenn der Hook aufgerufen wird.
41 Deine Hook-Callback-Funktion wird mit mindestens einem und bis zu zwei Argumenten aufgerufen
43 function myhook_function(&$a, &$b) {
47 Wenn du Änderungen an den aufgerufenen Daten vornehmen willst, musst du diese als Referenzvariable (mit "&") während der Funktionsdeklaration deklarieren.
49 $a ist die Friendica "App"-Klasse, die eine Menge an Informationen über den aktuellen Friendica-Status beinhaltet, u.a. welche Module genutzt werden, Konfigurationsinformationen, Inhalte der Seite zum Zeitpunkt des Hook-Aufrufs.
50 Es ist empfohlen, diese Funktion "$a" zu nennen, um seine Nutzung an den Gebrauch an anderer Stelle anzugleichen.
52 $b kann frei benannt werden.
53 Diese Information ist speziell auf den Hook bezogen, der aktuell bearbeitet wird, und beinhaltet normalerweise Daten, die du sofort nutzen, anzeigen oder bearbeiten kannst.
54 Achte darauf, diese mit "&" zu deklarieren, wenn du sie bearbeiten willst.
60 Plugins/Addons können auch als "Module" agieren und alle Seitenanfragen für eine bestimte URL abfangen.
61 Um ein Plugin als Modul zu nutzen, ist es nötig, die Funktion "plugin_name_module()" zu definieren, die keine Argumente benötigt und nichts weiter machen muss.
63 Wenn diese Funktion existiert, wirst du nun alle Seitenanfragen für "http://example.com/plugin_name" erhalten - mit allen URL-Komponenten als zusätzliche Argumente.
64 Diese werden in ein Array $a->argv geparst und stimmen mit $a->argc überein, wobei sie die Anzahl der URL-Komponenten abbilden.
65 So würde http://example.com/plugin/arg1/arg2 nach einem Modul "plugin" suchen und seiner Modulfunktion die $a-App-Strukur übergeben (dies ist für viele Komponenten verfügbar). Das umfasst:
68 $a->argv = array(0 => 'plugin', 1 => 'arg1', 2 => 'arg2');
70 Deine Modulfunktionen umfassen oft die Funktion plugin_name_content(&$a), welche den Seiteninhalt definiert und zurückgibt.
71 Sie können auch plugin_name_post(&$a) umfassen, welches vor der content-Funktion aufgerufen wird und normalerweise die Resultate der POST-Formulare handhabt.
72 Du kannst ebenso plugin_name_init(&$a) nutzen, was oft frühzeitig aufgerufen wird und das Modul initialisert.
78 **'authenticate'** - wird aufgerufen, wenn sich der User einloggt.
80 'username' => der übertragene Nutzername
81 'password' => das übertragene Passwort
82 'authenticated' => setze das auf einen anderen Wert als "0", damit der User sich authentifiziert
83 'user_record' => die erfolgreiche Authentifizierung muss auch einen gültigen Nutzereintrag aus der Datenbank zurückgeben
85 **'logged_in'** - wird aufgerufen, sobald ein Nutzer sich erfolgreich angemeldet hat.
86 $b beinhaltet den $a->Nutzer-Array
89 **'display_item'** - wird aufgerufen, wenn ein Beitrag für die Anzeige formatiert wird.
91 'item' => Die Item-Details (Array), die von der Datenbank ausgegeben werden
92 'output' => Die HTML-Ausgabe (String) des Items, bevor es zur Seite hinzugefügt wird
94 **'post_local'** - wird aufgerufen, wenn der Statusbeitrag oder ein Kommentar im lokalen System eingetragen wird.
95 $b ist das Item-Array der Information, die in der Datenbank hinterlegt wird.
96 {Bitte beachte: der Seiteninhalt ist bbcode - nicht HTML)
98 **'post_local_end'** - wird aufgerufen, wenn ein lokaler Statusbeitrag oder Kommentar im lokalen System gespeichert wird.
99 $b ist das Item-Array einer Information, die gerade in der Datenbank gespeichert wurden.
100 {Bitte beachte: der Seiteninhalt ist bbcode - nicht HTML)
102 **'post_remote'** - wird aufgerufen, wenn ein Beitrag aus einer anderen Quelle empfangen wird. Dies kann auch genutzt werden, um lokale Aktivitäten oder systemgenerierte Nachrichten zu veröffentlichen/posten.
103 $b ist das Item-Array einer Information, die in der Datenbank und im Item gespeichert ist.
104 {Bitte beachte: der Seiteninhalt ist bbcode - nicht HTML)
106 **'settings_form'** - wird aufgerufen, wenn die HTML-Ausgabe für die Einstellungsseite generiert wird.
107 $b ist die HTML-Ausgabe (String) der Einstellungsseite vor dem finalen "</form>"-Tag.
109 **'settings_post'** - wird aufgerufen, wenn die Einstellungsseiten geladen werden.
110 $b ist der $_POST-Array
112 **'plugin_settings'** - wird aufgerufen, wenn die HTML-Ausgabe der Addon-Einstellungsseite generiert wird.
113 $b ist die HTML-Ausgabe (String) der Addon-Einstellungsseite vor dem finalen "</form>"-Tag.
115 **'plugin_settings_post'** - wird aufgerufen, wenn die Addon-Einstellungsseite geladen wird.
116 $b ist der $_POST-Array
118 **'profile_post'** - wird aufgerufen, wenn die Profilseite angezeigt wird.
119 $b ist der $_POST-Array
121 **'profile_edit'** - wird aufgerufen, bevor die Profil-Bearbeitungsseite angezeigt wird.
123 'profile' => Profileintrag (Array) aus der Datenbank
124 'entry' => die HTML-Ausgabe (string) des generierten Eintrags
126 **'profile_advanced'** - wird aufgerufen, wenn die HTML-Ausgabe für das "Advanced profile" generiert wird; stimmt mit dem "Profil"-Tab auf der Profilseite der Nutzer überein.
127 $b ist die HTML-Ausgabe (String) des erstellten Profils
128 (Die Details des Profil-Arrays sind in $a->profile)
130 **'directory_item'** - wird von der Verzeichnisseite aufgerufen, wenn ein Item für die Anzeige formatiert wird.
132 'contact' => Kontakteintrag (Array) einer Person aus der Datenbank
133 'entry' => die HTML-Ausgabe (String) des generierten Eintrags
135 **'profile_sidebar_enter'** - wird aufgerufen, bevor die Sidebar "Kurzprofil" einer Seite erstellt wird.
136 $b ist der Profil-Array einer Person
138 **'profile_sidebar'** - wird aufgerufen, wenn die Sidebar "Kurzprofil" einer Seite erstellt wird.
140 'profile' => Kontakteintrag (Array) einer Person aus der Datenbank
141 'entry' => die HTML-Ausgabe (String) des generierten Eintrags
143 **'contact_block_end'** - wird aufgerufen, wenn der Block "Kontakte/Freunde" der Profil-Sidebar komplett formatiert wurde.
145 'contacts' => Array von "contacts"
146 'output' => die HTML-Ausgabe (String) des Kontaktblocks
148 **'bbcode'** - wird während der Umwandlung von bbcode auf HTML aufgerufen.
149 $b ist der konvertierte Text (String)
151 **'html2bbcode'** - wird während der Umwandlung von HTML zu bbcode aufgerufen (z.B. bei Nachrichtenbeiträgen).
152 $b ist der konvertierte Text (String)
154 **'page_header'** - wird aufgerufen, nachdem der Bereich der Seitennavigation geladen wurde.
155 $b ist die HTML-Ausgabe (String) der "nav"-Region
157 **'personal_xrd'** - wird aufgerufen, bevor die Ausgabe der persönlichen XRD-Datei erzeugt wird.
159 'user' => die hinterlegten Einträge der Person
160 'xml' => die komplette XML-Datei die ausgegeben wird
162 **'home_content'** - wird aufgerufen, bevor die Ausgabe des Homepage-Inhalts erstellt wird; wird nicht eingeloggten Nutzern angezeigt.
163 $b ist die HTML-Ausgabe (String) der Auswahlregion
165 **'contact_edit'** - wird aufgerufen, wenn die Kontaktdetails vom Nutzer auf der "Kontakte"-Seite bearbeitet werden.
167 'contact' => Kontakteintrag (Array) des abgezielten Kontakts
168 'output' => die HTML-Ausgabe (String) der "Kontakt bearbeiten"-Seite
170 **'contact_edit_post'** - wird aufgerufen, wenn die "Kontakt bearbeiten"-Seite ausgegeben wird.
171 $b ist der $_POST-Array
173 **'init_1'** - wird aufgerufen, kurz nachdem die Datenbank vor Beginn der Sitzung geöffnet wird.
174 $b wird nicht genutzt
176 **'page_end'** - wird aufgerufen, nachdem die Funktion des HTML-Inhalts komplett abgeschlossen ist.
177 $b ist die HTML-Ausgabe (String) vom Inhalt-"div"
179 **'avatar_lookup'** - wird aufgerufen, wenn der Avatar geladen wird.
181 'size' => Größe des Avatars, der geladen wird
182 'email' => Email-Adresse, um nach dem Avatar zu suchen
183 'url' => generierte URL (String) des Avatars
186 - wird aufgerufen nachdem in include/nav,php der Inhalt des Navigations Menüs erzeugt wurde.
187 - $b ist ein Array, das $nav wiederspiegelt.
189 Komplette Liste der Hook-Callbacks
192 Eine komplette Liste aller Hook-Callbacks mit den zugehörigen Dateien (am 14-Feb-2012 generiert): Bitte schau in die Quellcodes für Details zu Hooks, die oben nicht dokumentiert sind.
194 boot.php: call_hooks('login_hook',$o);
196 boot.php: call_hooks('profile_sidebar_enter', $profile);
198 boot.php: call_hooks('profile_sidebar', $arr);
200 boot.php: call_hooks("proc_run", $arr);
202 include/contact_selectors.php: call_hooks('network_to_name', $nets);
204 include/api.php: call_hooks('logged_in', $a->user);
206 include/api.php: call_hooks('logged_in', $a->user);
208 include/queue.php: call_hooks('queue_predeliver', $a, $r);
210 include/queue.php: call_hooks('queue_deliver', $a, $params);
212 include/text.php: call_hooks('contact_block_end', $arr);
214 include/text.php: call_hooks('smilie', $s);
216 include/text.php: call_hooks('prepare_body_init', $item);
218 include/text.php: call_hooks('prepare_body', $prep_arr);
220 include/text.php: call_hooks('prepare_body_final', $prep_arr);
222 include/nav.php: call_hooks('page_header', $a->page['nav']);
224 include/auth.php: call_hooks('authenticate', $addon_auth);
226 include/bbcode.php: call_hooks('bbcode',$Text);
228 include/oauth.php: call_hooks('logged_in', $a->user);
230 include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr);
232 include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o);
234 include/acl_selectors.php: call_hooks('contact_select_options', $x);
236 include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr);
238 include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o);
240 include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr);
242 include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o);
244 include/notifier.php: call_hooks('notifier_normal',$target_item);
246 include/notifier.php: call_hooks('notifier_end',$target_item);
248 include/items.php: call_hooks('atom_feed', $atom);
250 include/items.php: call_hooks('atom_feed_end', $atom);
252 include/items.php: call_hooks('atom_feed_end', $atom);
254 include/items.php: call_hooks('parse_atom', $arr);
256 include/items.php: call_hooks('post_remote',$arr);
258 include/items.php: call_hooks('atom_author', $o);
260 include/items.php: call_hooks('atom_entry', $o);
262 include/bb2diaspora.php: call_hooks('bb2diaspora',$Text);
264 include/cronhooks.php: call_hooks('cron', $d);
266 include/security.php: call_hooks('logged_in', $a->user);
268 include/html2bbcode.php: call_hooks('html2bbcode', $text);
270 include/Contact.php: call_hooks('remove_user',$r[0]);
272 include/Contact.php: call_hooks('contact_photo_menu', $args);
274 include/conversation.php: call_hooks('conversation_start',$cb);
276 include/conversation.php: call_hooks('render_location',$locate);
278 include/conversation.php: call_hooks('display_item', $arr);
280 include/conversation.php: call_hooks('render_location',$locate);
282 include/conversation.php: call_hooks('display_item', $arr);
284 include/conversation.php: call_hooks('item_photo_menu', $args);
286 include/conversation.php: call_hooks('jot_tool', $jotplugins);
288 include/conversation.php: call_hooks('jot_networks', $jotnets);
290 include/plugin.php: if(! function_exists('call_hooks')) {
292 include/plugin.php:function call_hooks($name, &$data = null) {
294 index.php: call_hooks('init_1');
296 index.php: call_hooks('app_menu', $arr);
298 index.php: call_hooks('page_end', $a->page['content']);
300 mod/photos.php: call_hooks('photo_post_init', $_POST);
302 mod/photos.php: call_hooks('photo_post_file',$ret);
304 mod/photos.php: call_hooks('photo_post_end',$foo);
306 mod/photos.php: call_hooks('photo_post_end',$foo);
308 mod/photos.php: call_hooks('photo_post_end',$foo);
310 mod/photos.php: call_hooks('photo_post_end',intval($item_id));
312 mod/photos.php: call_hooks('photo_upload_form',$ret);
314 mod/friendica.php: call_hooks('about_hook', $o);
316 mod/editpost.php: call_hooks('jot_tool', $jotplugins);
318 mod/editpost.php: call_hooks('jot_networks', $jotnets);
320 mod/parse_url.php: call_hooks('parse_link', $arr);
322 mod/home.php: call_hooks('home_init',$ret);
324 mod/home.php: call_hooks("home_content",$o);
326 mod/contacts.php: call_hooks('contact_edit_post', $_POST);
328 mod/contacts.php: call_hooks('contact_edit', $arr);
330 mod/settings.php: call_hooks('plugin_settings_post', $_POST);
332 mod/settings.php: call_hooks('connector_settings_post', $_POST);
334 mod/settings.php: call_hooks('settings_post', $_POST);
336 mod/settings.php: call_hooks('plugin_settings', $settings_addons);
338 mod/settings.php: call_hooks('connector_settings', $settings_connectors);
340 mod/settings.php: call_hooks('settings_form',$o);
342 mod/register.php: call_hooks('register_account', $newuid);
344 mod/like.php: call_hooks('post_local_end', $arr);
346 mod/xrd.php: call_hooks('personal_xrd', $arr);
348 mod/item.php: call_hooks('post_local_start', $_REQUEST);
350 mod/item.php: call_hooks('post_local',$datarray);
352 mod/item.php: call_hooks('post_local_end', $datarray);
354 mod/profile.php: call_hooks('profile_advanced',$o);
356 mod/profiles.php: call_hooks('profile_post', $_POST);
358 mod/profiles.php: call_hooks('profile_edit', $arr);
360 mod/tagger.php: call_hooks('post_local_end', $arr);
362 mod/cb.php: call_hooks('cb_init');
364 mod/cb.php: call_hooks('cb_post', $_POST);
366 mod/cb.php: call_hooks('cb_afterpost');
368 mod/cb.php: call_hooks('cb_content', $o);
370 mod/directory.php: call_hooks('directory_item', $arr);