1 Friendica Addon/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 Addon-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-Namen basieren; z.B. "addon1name_install()".
14 Diese beiden Funktionen haben keine Argumente und sind dafür verantwortlich, Event Hooks zu registrieren und abzumelden (unregistering), die dein Addon benötigt.
15 Die Installations- und Deinstallationsfunktionfunktionen werden auch ausgeführt (z.B. neu installiert), wenn sich das Addon 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 Addons sollten einen Kommentarblock mit den folgenden vier Parametern enthalten:
21 * Name: My Great Addon
22 * Description: This is what my addon does. It's really cool.
24 * Author: John Q. Public <john@myfriendicasite.com>
27 Registriere deine Addon-Hooks während der Installation.
29 \Friendica\Core\Hook::register($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/addon_name/addon_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(App $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 Addons können auch als "Module" agieren und alle Seitenanfragen für eine bestimte URL abfangen.
61 Um ein Addon als Modul zu nutzen, ist es nötig, die Funktion "addon_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/addon_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/addon/arg1/arg2 nach einem Modul "addon" suchen und seiner Modulfunktion die $a-App-Strukur übergeben (dies ist für viele Komponenten verfügbar). Das umfasst:
68 $a->argv = array(0 => 'addon', 1 => 'arg1', 2 => 'arg2');
70 Deine Modulfunktionen umfassen oft die Funktion addon_name_content(App $a), welche den Seiteninhalt definiert und zurückgibt.
71 Sie können auch addon_name_post(App $a) umfassen, welches vor der content-Funktion aufgerufen wird und normalerweise die Resultate der POST-Formulare handhabt.
72 Du kannst ebenso addon_name_init(App $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 **'addon_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 **'addon_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 01-Apr-2018 generiert): Bitte schau in die Quellcodes für Details zu Hooks, die oben nicht dokumentiert sind.
196 Hook::callAll('init_1');
197 Hook::callAll('app_menu', $arr);
198 Hook::callAll('page_content_top', DI::page()['content']);
199 Hook::callAll($a->module.'_mod_init', $placeholder);
200 Hook::callAll($a->module.'_mod_init', $placeholder);
201 Hook::callAll($a->module.'_mod_post', $_POST);
202 Hook::callAll($a->module.'_mod_afterpost', $placeholder);
203 Hook::callAll($a->module.'_mod_content', $arr);
204 Hook::callAll($a->module.'_mod_aftercontent', $arr);
205 Hook::callAll('page_end', DI::page()['content']);
209 Hook::callAll('logged_in', $a->user);
210 Hook::callAll('authenticate', $addon_auth);
211 Hook::callAll('logged_in', $a->user);
213 ### include/enotify.php
215 Hook::callAll('enotify', $h);
216 Hook::callAll('enotify_store', $datarray);
217 Hook::callAll('enotify_mail', $datarray);
218 Hook::callAll('check_item_notification', $notification_data);
220 ### include/conversation.php
222 Hook::callAll('conversation_start', $cb);
223 Hook::callAll('render_location', $locate);
224 Hook::callAll('display_item', $arr);
225 Hook::callAll('display_item', $arr);
226 Hook::callAll('item_photo_menu', $args);
227 Hook::callAll('jot_tool', $jotplugins);
229 ### include/items.php
231 Hook::callAll('page_info_data', $data);
233 ### mod/directory.php
235 Hook::callAll('directory_item', $arr);
239 Hook::callAll('personal_xrd', $arr);
243 Hook::callAll('network_ping', $arr);
245 ### mod/parse_url.php
247 Hook::callAll("parse_link", $arr);
249 ### src/Module/Delegation.php
251 Hook::callAll('home_init', $ret);
255 Hook::callAll('acl_lookup_end', $results);
259 Hook::callAll('network_content_init', $arr);
260 Hook::callAll('network_tabs', $arr);
262 ### mod/friendica.php
264 Hook::callAll('about_hook', $o);
266 ### mod/subthread.php
268 Hook::callAll('post_local_end', $arr);
272 Hook::callAll('profile_post', $_POST);
273 Hook::callAll('profile_edit', $arr);
277 Hook::callAll('addon_settings_post', $_POST);
278 Hook::callAll('connector_settings_post', $_POST);
279 Hook::callAll('display_settings_post', $_POST);
280 Hook::callAll('settings_post', $_POST);
281 Hook::callAll('addon_settings', $settings_addons);
282 Hook::callAll('connector_settings', $settings_connectors);
283 Hook::callAll('display_settings', $o);
284 Hook::callAll('settings_form', $o);
288 Hook::callAll('photo_post_init', $_POST);
289 Hook::callAll('photo_post_file', $ret);
290 Hook::callAll('photo_post_end', $foo);
291 Hook::callAll('photo_post_end', $foo);
292 Hook::callAll('photo_post_end', $foo);
293 Hook::callAll('photo_post_end', $foo);
294 Hook::callAll('photo_post_end', intval($item_id));
295 Hook::callAll('photo_upload_form', $ret);
299 Hook::callAll('profile_advanced', $o);
303 Hook::callAll('home_init', $ret);
304 Hook::callAll("home_content", $content);
308 Hook::callAll('post_local_end', $arr);
312 Hook::callAll('contact_edit_post', $_POST);
313 Hook::callAll('contact_edit', $arr);
317 Hook::callAll('post_local_end', $arr);
321 Hook::callAll('lockview_content', $item);
325 Hook::callAll('uexport_options', $options);
329 Hook::callAll('register_post', $arr);
330 Hook::callAll('register_form', $arr);
334 Hook::callAll('post_local_start', $_REQUEST);
335 Hook::callAll('post_local', $datarray);
336 Hook::callAll('post_local_end', $datarray);
340 Hook::callAll('jot_tool', $jotplugins);
342 ### src/Network/FKOAuth1.php
344 Hook::callAll('logged_in', $a->user);
346 ### src/Render/FriendicaSmartyEngine.php
348 Hook::callAll("template_vars", $arr);
350 ### src/Model/Item.php
352 Hook::callAll('post_local', $item);
353 Hook::callAll('post_remote', $item);
354 Hook::callAll('post_local_end', $posted_item);
355 Hook::callAll('post_remote_end', $posted_item);
356 Hook::callAll('tagged', $arr);
357 Hook::callAll('post_local_end', $new_item);
358 Hook::callAll('put_item_in_cache', $hook_data);
359 Hook::callAll('prepare_body_init', $item);
360 Hook::callAll('prepare_body_content_filter', $hook_data);
361 Hook::callAll('prepare_body', $hook_data);
362 Hook::callAll('prepare_body_final', $hook_data);
364 ### src/Model/Contact.php
366 Hook::callAll('contact_photo_menu', $args);
367 Hook::callAll('follow', $arr);
369 ### src/Model/Profile.php
371 Hook::callAll('profile_sidebar_enter', $profile);
372 Hook::callAll('profile_sidebar', $arr);
373 Hook::callAll('profile_tabs', $arr);
374 Hook::callAll('zrl_init', $arr);
376 ### src/Model/Event.php
378 Hook::callAll('event_updated', $event['id']);
379 Hook::callAll("event_created", $event['id']);
381 ### src/Model/User.php
383 Hook::callAll('register_account', $uid);
384 Hook::callAll('remove_user', $user);
386 ### src/Content/ContactBlock.php
388 Hook::callAll('contact_block_end', $arr);
390 ### src/Content/Text/BBCode.php
392 Hook::callAll('bbcode', $text);
393 Hook::callAll('bb2diaspora', $text);
395 ### src/Content/Text/HTML.php
397 Hook::callAll('html2bbcode', $message);
399 ### src/Content/Smilies.php
401 Hook::callAll('smilie', $params);
403 ### src/Content/Feature.php
405 Hook::callAll('isEnabled', $arr);
406 Hook::callAll('get', $arr);
408 ### src/Content/ContactSelector.php
410 Hook::callAll('network_to_name', $nets);
411 Hook::callAll('gender_selector', $select);
412 Hook::callAll('sexpref_selector', $select);
413 Hook::callAll('marital_selector', $select);
415 ### src/Content/OEmbed.php
417 Hook::callAll('oembed_fetch_url', $embedurl, $j);
419 ### src/Content/Nav.php
421 Hook::callAll('page_header', DI::page()['nav']);
422 Hook::callAll('nav_info', $nav);
424 ### src/Core/Authentication.php
426 Hook::callAll('logged_in', $a->user);
428 ### src/Core/StorageManager
430 Hook::callAll('storage_instance', $data);
432 ### src/Worker/Directory.php
434 Hook::callAll('globaldir_update', $arr);
436 ### src/Worker/Notifier.php
438 Hook::callAll('notifier_end', $target_item);
440 ### src/Module/Login.php
442 Hook::callAll('authenticate', $addon_auth);
443 Hook::callAll('login_hook', $o);
445 ### src/Module/Logout.php
447 Hook::callAll("logging_out");
449 ### src/Object/Post.php
451 Hook::callAll('render_location', $locate);
452 Hook::callAll('display_item', $arr);
456 Hook::callAll('contact_select_options', $x);
457 Hook::callAll($a->module.'_pre_'.$selname, $arr);
458 Hook::callAll($a->module.'_post_'.$selname, $o);
459 Hook::callAll($a->module.'_pre_'.$selname, $arr);
460 Hook::callAll($a->module.'_post_'.$selname, $o);
461 Hook::callAll('jot_networks', $jotnets);
463 ### src/Core/Authentication.php
465 Hook::callAll('logged_in', $a->user);
467 ### src/Core/Hook.php
469 self::callSingle(self::getApp(), 'hook_fork', $fork_hook, $hookdata);
471 ### src/Core/L10n/L10n.php
473 Hook::callAll('poke_verbs', $arr);
475 ### src/Core/Worker.php
477 Hook::callAll("proc_run", $arr);
479 ### src/Util/Emailer.php
481 Hook::callAll('emailer_send_prepare', $params);
482 Hook::callAll("emailer_send", $hookdata);
486 Hook::callAll('generate_map', $arr);
487 Hook::callAll('generate_named_map', $arr);
488 Hook::callAll('Map::getCoordinates', $arr);
490 ### src/Util/Network.php
492 Hook::callAll('avatar_lookup', $avatar);
494 ### src/Util/ParseUrl.php
496 Hook::callAll("getsiteinfo", $siteinfo);
498 ### src/Protocol/DFRN.php
500 Hook::callAll('atom_feed_end', $atom);
501 Hook::callAll('atom_feed_end', $atom);
503 ### src/Protocol/Email.php
505 Hook::callAll('email_getmessage', $message);
506 Hook::callAll('email_getmessage_end', $ret);