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 das App\Arguments Objekt geparst.
65 So würde `http://example.com/addon/arg1/arg2` dies ergeben:
67 DI::args()->getArgc(); // = 3
68 DI::args()->get(0); // = 'addon'
69 DI::args()->get(1); // = 'arg1'
70 DI::args()->get(2); // = 'arg2'
73 Deine Modulfunktionen umfassen oft die Funktion addon_name_content(App $a), welche den Seiteninhalt definiert und zurückgibt.
74 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.
75 Du kannst ebenso addon_name_init(App $a) nutzen, was oft frühzeitig aufgerufen wird und das Modul initialisert.
81 **'authenticate'** - wird aufgerufen, wenn sich der User einloggt.
83 'username' => der übertragene Nutzername
84 'password' => das übertragene Passwort
85 'authenticated' => setze das auf einen anderen Wert als "0", damit der User sich authentifiziert
86 'user_record' => die erfolgreiche Authentifizierung muss auch einen gültigen Nutzereintrag aus der Datenbank zurückgeben
88 **'logged_in'** - wird aufgerufen, sobald ein Nutzer sich erfolgreich angemeldet hat.
89 $b beinhaltet den $a->Nutzer-Array
92 **'display_item'** - wird aufgerufen, wenn ein Beitrag für die Anzeige formatiert wird.
94 'item' => Die Item-Details (Array), die von der Datenbank ausgegeben werden
95 'output' => Die HTML-Ausgabe (String) des Items, bevor es zur Seite hinzugefügt wird
97 **'post_local'** - wird aufgerufen, wenn der Statusbeitrag oder ein Kommentar im lokalen System eingetragen wird.
98 $b ist das Item-Array der Information, die in der Datenbank hinterlegt wird.
99 {Bitte beachte: der Seiteninhalt ist bbcode - nicht HTML)
101 **'post_local_end'** - wird aufgerufen, wenn ein lokaler Statusbeitrag oder Kommentar im lokalen System gespeichert wird.
102 $b ist das Item-Array einer Information, die gerade in der Datenbank gespeichert wurden.
103 {Bitte beachte: der Seiteninhalt ist bbcode - nicht HTML)
105 **'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.
106 $b ist das Item-Array einer Information, die in der Datenbank und im Item gespeichert ist.
107 {Bitte beachte: der Seiteninhalt ist bbcode - nicht HTML)
109 **'addon_settings'** - wird aufgerufen, wenn die HTML-Ausgabe der Addon-Einstellungsseite generiert wird.
110 $b ist die HTML-Ausgabe (String) der Addon-Einstellungsseite vor dem finalen "</form>"-Tag.
112 **'addon_settings_post'** - wird aufgerufen, wenn die Addon-Einstellungsseite geladen wird.
113 $b ist der $_POST-Array
115 **'profile_post'** - wird aufgerufen, wenn die Profilseite angezeigt wird.
116 $b ist der $_POST-Array
118 **'profile_edit'** - wird aufgerufen, bevor die Profil-Bearbeitungsseite angezeigt wird.
120 'profile' => Profileintrag (Array) aus der Datenbank
121 'entry' => die HTML-Ausgabe (string) des generierten Eintrags
123 **'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.
124 $b ist die HTML-Ausgabe (String) des erstellten Profils
125 (Die Details des Profil-Arrays sind in $a->profile)
127 **'directory_item'** - wird von der Verzeichnisseite aufgerufen, wenn ein Item für die Anzeige formatiert wird.
129 'contact' => Kontakteintrag (Array) einer Person aus der Datenbank
130 'entry' => die HTML-Ausgabe (String) des generierten Eintrags
132 **'profile_sidebar_enter'** - wird aufgerufen, bevor die Sidebar "Kurzprofil" einer Seite erstellt wird.
133 $b ist der Profil-Array einer Person
135 **'profile_sidebar'** - wird aufgerufen, wenn die Sidebar "Kurzprofil" einer Seite erstellt wird.
137 'profile' => Kontakteintrag (Array) einer Person aus der Datenbank
138 'entry' => die HTML-Ausgabe (String) des generierten Eintrags
140 **'contact_block_end'** - wird aufgerufen, wenn der Block "Kontakte/Freunde" der Profil-Sidebar komplett formatiert wurde.
142 'contacts' => Array von "contacts"
143 'output' => die HTML-Ausgabe (String) des Kontaktblocks
145 **'bbcode'** - wird während der Umwandlung von bbcode auf HTML aufgerufen.
146 $b ist der konvertierte Text (String)
148 **'html2bbcode'** - wird während der Umwandlung von HTML zu bbcode aufgerufen (z.B. bei Nachrichtenbeiträgen).
149 $b ist der konvertierte Text (String)
151 **'page_header'** - wird aufgerufen, nachdem der Bereich der Seitennavigation geladen wurde.
152 $b ist die HTML-Ausgabe (String) der "nav"-Region
154 **'personal_xrd'** - wird aufgerufen, bevor die Ausgabe der persönlichen XRD-Datei erzeugt wird.
156 'user' => die hinterlegten Einträge der Person
157 'xml' => die komplette XML-Datei die ausgegeben wird
159 **'home_content'** - wird aufgerufen, bevor die Ausgabe des Homepage-Inhalts erstellt wird; wird nicht eingeloggten Nutzern angezeigt.
160 $b ist die HTML-Ausgabe (String) der Auswahlregion
162 **'contact_edit'** - wird aufgerufen, wenn die Kontaktdetails vom Nutzer auf der "Kontakte"-Seite bearbeitet werden.
164 'contact' => Kontakteintrag (Array) des abgezielten Kontakts
165 'output' => die HTML-Ausgabe (String) der "Kontakt bearbeiten"-Seite
167 **'contact_edit_post'** - wird aufgerufen, wenn die "Kontakt bearbeiten"-Seite ausgegeben wird.
168 $b ist der $_POST-Array
170 **'init_1'** - wird aufgerufen, kurz nachdem die Datenbank vor Beginn der Sitzung geöffnet wird.
171 $b wird nicht genutzt
173 **'page_end'** - wird aufgerufen, nachdem die Funktion des HTML-Inhalts komplett abgeschlossen ist.
174 $b ist die HTML-Ausgabe (String) vom Inhalt-"div"
176 **'avatar_lookup'** - wird aufgerufen, wenn der Avatar geladen wird.
178 'size' => Größe des Avatars, der geladen wird
179 'email' => Email-Adresse, um nach dem Avatar zu suchen
180 'url' => generierte URL (String) des Avatars
183 - wird aufgerufen nachdem in include/nav,php der Inhalt des Navigations Menüs erzeugt wurde.
184 - $b ist ein Array, das $nav wiederspiegelt.
186 Komplette Liste der Hook-Callbacks
189 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.
193 Hook::callAll('init_1');
194 Hook::callAll('app_menu', $arr);
195 Hook::callAll('page_content_top', DI::page()['content']);
196 Hook::callAll($a->module.'_mod_init', $placeholder);
197 Hook::callAll($a->module.'_mod_init', $placeholder);
198 Hook::callAll($a->module.'_mod_post', $_POST);
199 Hook::callAll($a->module.'_mod_content', $arr);
200 Hook::callAll($a->module.'_mod_aftercontent', $arr);
201 Hook::callAll('page_end', DI::page()['content']);
205 Hook::callAll('logged_in', $a->user);
206 Hook::callAll('authenticate', $addon_auth);
207 Hook::callAll('logged_in', $a->user);
209 ### include/enotify.php
211 Hook::callAll('enotify', $h);
212 Hook::callAll('enotify_store', $datarray);
213 Hook::callAll('enotify_mail', $datarray);
214 Hook::callAll('check_item_notification', $notification_data);
216 ### src/Content/Conversation.php
218 Hook::callAll('conversation_start', $cb);
219 Hook::callAll('render_location', $locate);
220 Hook::callAll('display_item', $arr);
221 Hook::callAll('display_item', $arr);
222 Hook::callAll('item_photo_menu', $args);
223 Hook::callAll('jot_tool', $jotplugins);
225 ### mod/directory.php
227 Hook::callAll('directory_item', $arr);
231 Hook::callAll('personal_xrd', $arr);
233 ### mod/parse_url.php
235 Hook::callAll("parse_link", $arr);
237 ### src/Module/Delegation.php
239 Hook::callAll('home_init', $ret);
243 Hook::callAll('acl_lookup_end', $results);
247 Hook::callAll('network_content_init', $arr);
248 Hook::callAll('network_tabs', $arr);
250 ### mod/friendica.php
252 Hook::callAll('about_hook', $o);
256 Hook::callAll('profile_post', $_POST);
257 Hook::callAll('profile_edit', $arr);
261 Hook::callAll('addon_settings_post', $_POST);
262 Hook::callAll('connector_settings_post', $_POST);
263 Hook::callAll('display_settings_post', $_POST);
264 Hook::callAll('addon_settings', $settings_addons);
265 Hook::callAll('connector_settings', $settings_connectors);
266 Hook::callAll('display_settings', $o);
270 Hook::callAll('photo_post_init', $_POST);
271 Hook::callAll('photo_post_file', $ret);
272 Hook::callAll('photo_post_end', $foo);
273 Hook::callAll('photo_post_end', $foo);
274 Hook::callAll('photo_post_end', $foo);
275 Hook::callAll('photo_post_end', $foo);
276 Hook::callAll('photo_post_end', intval($item_id));
277 Hook::callAll('photo_upload_form', $ret);
281 Hook::callAll('profile_advanced', $o);
285 Hook::callAll('home_init', $ret);
286 Hook::callAll("home_content", $content);
290 Hook::callAll('contact_edit_post', $_POST);
291 Hook::callAll('contact_edit', $arr);
295 Hook::callAll('post_local_end', $arr);
299 Hook::callAll('uexport_options', $options);
303 Hook::callAll('register_post', $arr);
304 Hook::callAll('register_form', $arr);
308 Hook::callAll('post_local_start', $_REQUEST);
309 Hook::callAll('post_local', $datarray);
310 Hook::callAll('post_local_end', $datarray);
314 Hook::callAll('jot_tool', $jotplugins);
316 ### src/Network/FKOAuth1.php
318 Hook::callAll('logged_in', $a->user);
320 ### src/Render/FriendicaSmartyEngine.php
322 Hook::callAll("template_vars", $arr);
324 ### src/Model/Item.php
326 Hook::callAll('post_local', $item);
327 Hook::callAll('post_remote', $item);
328 Hook::callAll('post_local_end', $posted_item);
329 Hook::callAll('post_remote_end', $posted_item);
330 Hook::callAll('tagged', $arr);
331 Hook::callAll('post_local_end', $new_item);
332 Hook::callAll('put_item_in_cache', $hook_data);
333 Hook::callAll('prepare_body_init', $item);
334 Hook::callAll('prepare_body_content_filter', $hook_data);
335 Hook::callAll('prepare_body', $hook_data);
336 Hook::callAll('prepare_body_final', $hook_data);
338 ### src/Model/Contact.php
340 Hook::callAll('contact_photo_menu', $args);
341 Hook::callAll('follow', $arr);
343 ### src/Model/Profile.php
345 Hook::callAll('profile_sidebar_enter', $profile);
346 Hook::callAll('profile_sidebar', $arr);
347 Hook::callAll('profile_tabs', $arr);
348 Hook::callAll('zrl_init', $arr);
350 ### src/Model/Event.php
352 Hook::callAll('event_updated', $event['id']);
353 Hook::callAll("event_created", $event['id']);
355 ### src/Model/User.php
357 Hook::callAll('register_account', $uid);
358 Hook::callAll('remove_user', $user);
360 ### src/Content/ContactBlock.php
362 Hook::callAll('contact_block_end', $arr);
364 ### src/Content/Text/BBCode.php
366 Hook::callAll('bbcode', $text);
367 Hook::callAll('bb2diaspora', $text);
369 ### src/Content/Text/HTML.php
371 Hook::callAll('html2bbcode', $message);
373 ### src/Content/Smilies.php
375 Hook::callAll('smilie', $params);
377 ### src/Content/Feature.php
379 Hook::callAll('isEnabled', $arr);
380 Hook::callAll('get', $arr);
382 ### src/Content/ContactSelector.php
384 Hook::callAll('network_to_name', $nets);
386 ### src/Content/OEmbed.php
388 Hook::callAll('oembed_fetch_url', $embedurl, $j);
390 ### src/Content/Nav.php
392 Hook::callAll('page_header', DI::page()['nav']);
393 Hook::callAll('nav_info', $nav);
395 ### src/Core/Authentication.php
397 Hook::callAll('logged_in', $a->user);
399 ### src/Core/Protocol.php
401 Hook::callAll('support_follow', $hook_data);
402 Hook::callAll('support_revoke_follow', $hook_data);
403 Hook::callAll('unfollow', $hook_data);
404 Hook::callAll('revoke_follow', $hook_data);
405 Hook::callAll('block', $hook_data);
406 Hook::callAll('unblock', $hook_data);
408 ### src/Core/StorageManager
410 Hook::callAll('storage_instance', $data);
411 Hook::callAll('storage_config', $data);
413 ### src/Module/Notifications/Ping.php
415 Hook::callAll('network_ping', $arr);
417 ### src/Module/PermissionTooltip.php
419 Hook::callAll('lockview_content', $item);
421 ### src/Worker/Directory.php
423 Hook::callAll('globaldir_update', $arr);
425 ### src/Worker/Notifier.php
427 Hook::callAll('notifier_end', $target_item);
429 ### src/Module/Login.php
431 Hook::callAll('authenticate', $addon_auth);
432 Hook::callAll('login_hook', $o);
434 ### src/Module/Logout.php
436 Hook::callAll("logging_out");
438 ### src/Object/Post.php
440 Hook::callAll('render_location', $locate);
441 Hook::callAll('display_item', $arr);
445 Hook::callAll('contact_select_options', $x);
446 Hook::callAll($a->module.'_pre_'.$selname, $arr);
447 Hook::callAll($a->module.'_post_'.$selname, $o);
448 Hook::callAll($a->module.'_pre_'.$selname, $arr);
449 Hook::callAll($a->module.'_post_'.$selname, $o);
450 Hook::callAll('jot_networks', $jotnets);
452 ### src/Core/Authentication.php
454 Hook::callAll('logged_in', $a->user);
456 ### src/Core/Hook.php
458 self::callSingle(self::getApp(), 'hook_fork', $fork_hook, $hookdata);
460 ### src/Core/Worker.php
462 Hook::callAll("proc_run", $arr);
464 ### src/Util/Emailer.php
466 Hook::callAll('emailer_send_prepare', $email);
467 Hook::callAll("emailer_send", $hookdata);
471 Hook::callAll('generate_map', $arr);
472 Hook::callAll('generate_named_map', $arr);
473 Hook::callAll('Map::getCoordinates', $arr);
475 ### src/Util/Network.php
477 Hook::callAll('avatar_lookup', $avatar);
479 ### src/Util/ParseUrl.php
481 Hook::callAll("getsiteinfo", $siteinfo);
483 ### src/Protocol/DFRN.php
485 Hook::callAll('atom_feed_end', $atom);
486 Hook::callAll('atom_feed_end', $atom);
488 ### src/Protocol/Email.php
490 Hook::callAll('email_getmessage', $message);
491 Hook::callAll('email_getmessage_end', $ret);