doc/de/Plugins.md

   1 **Friendica Addon/Plugin-Entwicklung**
   2 ==============
   3
   4 * [Zur Startseite der Hilfe](help)
   5
   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. Module arbeiten, indem bestimmte Seitenanfragen (durch den URL-Pfad) abgefangen werden
   9
  10 Plugin-Namen können keine Leerstellen oder andere Interpunktionen enthalten und werden als Datei- und Funktionsnamen genutzt.
  11 Du kannst einen lesbaren Namen im Kommentarblock eintragen.
  12 Jedes Addon muss beides beinhalten - eine Installations- und eine Deinstallationsfunktion, die auf dem Addon-/Plugin-Namen basieren; z.B. "plugin1name_install()".
  13 Diese beiden Funktionen haben keine Argumente und sind dafür verantwortlich, Event Hooks zu registrieren und abzumelden (unregistering), die dein Plugin benötigt.
  14 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.
  15 Zukünftige Extensions werden möglicherweise "Setup" und "Entfernen" anbieten.
  16
  17 Plugins sollten einen Kommentarblock mit den folgenden vier Parametern enthalten:
  18
  19         /*
  20         * Name: My Great Plugin
  21         * Description: This is what my plugin does. It's really cool
  22         * Version: 1.0
  23         * Author: John Q. Public <john@myfriendicasite.com>
  24         */
  25
  26 Registriere deine Plugin-Hooks während der Installation.
  27
  28     register_hook($hookname, $file, $function);
  29
  30 $hookname ist ein String und entspricht einem bekannten Friendica-Hook.
  31
  32 $file steht für den Pfadnamen, der relativ zum Top-Level-Friendicaverzeichnis liegt.
  33 Das *sollte* "addon/plugin_name/plugin_name.php' sein.
  34
  35 $function ist ein String und der Name der Funktion, die ausgeführt wird, wenn der Hook aufgerufen wird.
  36
  37 Deine Hook-Callback-Funktion wird mit mindestens einem und bis zu zwei Argumenten aufgerufen
  38
  39     function myhook_function(&$a, &$b) {
  40
  41     }
  42
  43 Wenn du Änderungen an den aufgerufenen Daten vornehmen willst, musst du diese als Referenzvariable (mit "&") während der Funktionsdeklaration deklarieren.
  44
  45 $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.
  46 Es ist empfohlen, diese Funktion "$a" zu nennen, um seine Nutzung an den Gebrauch an anderer Stelle anzugleichen.
  47
  48 $b kann frei benannt werden.
  49 Diese Information ist speziell auf den Hook bezogen, der aktuell bearbeitet wird, und beinhaltet normalerweise Daten, die du sofort nutzen, anzeigen oder bearbeiten kannst.
  50 Achte darauf, diese mit "&" zu deklarieren, wenn du sie bearbeiten willst.
  51
  52
  53 **Module**
  54
  55 Plugins/Addons können auch als "Module" agieren und alle Seitenanfragen für eine bestimte URL abfangen.
  56 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.
  57
  58 Wenn diese Funktion existiert, wirst du nun alle Seitenanfragen für "http://my.web.site/plugin_name" erhalten - mit allen URL-Komponenten als zusätzliche Argumente.
  59 Diese werden in ein Array $a->argv geparst und stimmen mit $a->argc überein, wobei sie die Anzahl der URL-Komponenten abbilden.
  60 So würde http://my.web.site/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:
  61
  62      $a->argc = 3
  63      $a->argv = array(0 => 'plugin', 1 => 'arg1', 2 => 'arg2');
  64
  65 Deine Modulfunktionen umfassen oft die Funktion plugin_name_content(&$a), welche den Seiteninhalt definiert und zurückgibt.
  66 Sie können auch plugin_name_post(&$a) umfassen, welches vor der content-Funktion aufgerufen wird und normalerweise die Resultate der POST-Formulare handhabt.
  67 Du kannst ebenso plugin_name_init(&$a) nutzen, was oft frühzeitig aufgerufen wird und das Modul initialisert.
  68
  69
  70 **Derzeitige Hooks:**
  71
  72 **'authenticate'** - wird aufgerufen, wenn sich der User einloggt.
  73     $b ist ein Array
  74         'username' => der übertragene Nutzername
  75         'password' => das übertragene Passwort
  76         'authenticated' => setze das auf einen anderen Wert als "0", damit der User sich authentifiziert
  77         'user_record' => die erfolgreiche Authentifizierung muss auch einen gültigen Nutzereintrag aus der Datenbank zurückgeben
  78
  79 **'logged_in'** - wird aufgerufen, sobald ein Nutzer sich erfolgreich angemeldet hat.
  80     $b beinhaltet den $a->Nutzer-Array
  81
  82
  83 **'display_item'** - wird aufgerufen, wenn ein Beitrag für die Anzeige formatiert wird.
  84     $b ist ein Array
  85         'item' => Die Item-Details (Array), die von der Datenbank ausgegeben werden
  86         'output' => Die HTML-Ausgabe (String) des Items, bevor es zur Seite hinzugefügt wird
  87
  88 **'post_local'** - wird aufgerufen, wenn der Statusbeitrag oder ein Kommentar im lokalen System eingetragen wird.
  89     $b ist das Item-Array der Information, die in der Datenbank hinterlegt wird.
  90         {Bitte beachte: der Seiteninhalt ist bbcode - nicht HTML)
  91
  92 **'post_local_end'** - wird aufgerufen, wenn ein lokaler Statusbeitrag oder Kommentar im lokalen System gespeichert wird.
  93     $b ist das Item-Array einer Information, die gerade in der Datenbank gespeichert wurden.
  94         {Bitte beachte: der Seiteninhalt ist bbcode - nicht HTML)
  95
  96 **'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.
  97     $b ist das Item-Array einer Information, die in der Datenbank und im Item gespeichert ist.
  98         {Bitte beachte: der Seiteninhalt ist bbcode - nicht HTML)
  99
 100 **'settings_form'** - wird aufgerufen, wenn die HTML-Ausgabe für die Einstellungsseite generiert wird.
 101     $b ist die HTML-Ausgabe (String) der Einstellungsseite vor dem finalen "</form>"-Tag.
 102
 103 **'settings_post'** - wird aufgerufen, wenn die Einstellungsseiten geladen werden.
 104     $b ist der $_POST-Array
 105
 106 **'plugin_settings'** - wird aufgerufen, wenn die HTML-Ausgabe der Addon-Einstellungsseite generiert wird.
 107     $b ist die HTML-Ausgabe (String) der Addon-Einstellungsseite vor dem finalen "</form>"-Tag.
 108
 109 **'plugin_settings_post'** - wird aufgerufen, wenn die Addon-Einstellungsseite geladen wird.
 110     $b ist der $_POST-Array
 111
 112 **'profile_post'** - wird aufgerufen, wenn die Profilseite angezeigt wird.
 113     $b ist der $_POST-Array
 114
 115 **'profile_edit'** - wird aufgerufen, bevor die Profil-Bearbeitungsseite angezeigt wird.
 116     $b ist ein Array
 117         'profile' => Profileintrag (Array) aus der Datenbank
 118         'entry' => die HTML-Ausgabe (string) des generierten Eintrags
 119
 120 **'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.
 121     $b ist die HTML-Ausgabe (String) des erstellten Profils
 122     (Die Details des Profil-Arrays sind in $a->profile)
 123
 124 **'directory_item'** - wird von der Verzeichnisseite aufgerufen, wenn ein Item für die Anzeige formatiert wird.
 125     $b ist ein Array
 126         'contact' => Kontakteintrag (Array) einer Person aus der Datenbank
 127         'entry' => die HTML-Ausgabe (String) des generierten Eintrags
 128
 129 **'profile_sidebar_enter'** - wird aufgerufen, bevor die Sidebar "Kurzprofil" einer Seite erstellt wird.
 130     $b ist der Profil-Array einer Person
 131
 132 **'profile_sidebar'** - wird aufgerufen, wenn die Sidebar "Kurzprofil" einer Seite erstellt wird.
 133     $b ist ein Array
 134         'profile' => Kontakteintrag (Array) einer Person aus der Datenbank
 135         'entry' => die HTML-Ausgabe (String) des generierten Eintrags
 136
 137 **'contact_block_end'** - wird aufgerufen, wenn der Block "Kontakte/Freunde" der Profil-Sidebar komplett formatiert wurde.
 138     $b ist ein Array
 139           'contacts' => Array von "contacts"
 140           'output' => die HTML-Ausgabe (String) des Kontaktblocks
 141
 142 **'bbcode'** - wird während der Umwandlung von bbcode auf HTML aufgerufen.
 143     $b ist der konvertierte Text (String)
 144
 145 **'html2bbcode'** - wird während der Umwandlung von HTML zu bbcode aufgerufen (z.B. bei Nachrichtenbeiträgen).
 146     $b ist der konvertierte Text (String)
 147
 148 **'page_header'** - wird aufgerufen, nachdem der Bereich der Seitennavigation geladen wurde.
 149     $b ist die HTML-Ausgabe (String) der "nav"-Region
 150
 151 **'personal_xrd'** - wird aufgerufen, bevor die Ausgabe der persönlichen XRD-Datei erzeugt wird.
 152     $b ist ein Array
 153         'user' => die hinterlegten Einträge der Person
 154         'xml' => die komplette XML-Datei die ausgegeben wird
 155
 156 **'home_content'** - wird aufgerufen, bevor die Ausgabe des Homepage-Inhalts erstellt wird; wird nicht eingeloggten Nutzern angezeigt.
 157     $b ist die HTML-Ausgabe (String) der Auswahlregion
 158
 159 **'contact_edit'** - wird aufgerufen, wenn die Kontaktdetails vom Nutzer auf der "Kontakte"-Seite bearbeitet werden.
 160     $b ist ein Array
 161         'contact' => Kontakteintrag (Array) des abgezielten Kontakts
 162         'output' => die HTML-Ausgabe (String) der "Kontakt bearbeiten"-Seite
 163
 164 **'contact_edit_post'** - wird aufgerufen, wenn die "Kontakt bearbeiten"-Seite ausgegeben wird.
 165     $b ist der $_POST-Array
 166
 167 **'init_1'** - wird aufgerufen, kurz nachdem die Datenbank vor Beginn der Sitzung geöffnet wird.
 168     $b wird nicht genutzt
 169
 170 **'page_end'** - wird aufgerufen, nachdem die Funktion des HTML-Inhalts komplett abgeschlossen ist.
 171     $b ist die HTML-Ausgabe (String) vom Inhalt-"div"
 172
 173 **'avatar_lookup'** - wird aufgerufen, wenn der Avatar geladen wird.
 174     $b ist ein Array
 175         'size' => Größe des Avatars, der geladen wird
 176         'email' => Email-Adresse, um nach dem Avatar zu suchen
 177         'url' => generierte URL (String) des Avatars
 178
 179 **'nav_info'**
 180  - wird aufgerufen nachdem in include/nav,php der Inhalt des Navigations Menüs erzeugt wurde.
 181  - $b ist ein Array, das $nav wiederspiegelt.
 182
 183 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.
 184
 185 boot.php:                       call_hooks('login_hook',$o);
 186
 187 boot.php:                       call_hooks('profile_sidebar_enter', $profile);
 188
 189 boot.php:                       call_hooks('profile_sidebar', $arr);
 190
 191 boot.php:                       call_hooks("proc_run", $arr);
 192
 193 include/contact_selectors.php:  call_hooks('network_to_name', $nets);
 194
 195 include/api.php:                call_hooks('logged_in', $a->user);
 196
 197 include/api.php:                call_hooks('logged_in', $a->user);
 198
 199 include/queue.php:              call_hooks('queue_predeliver', $a, $r);
 200
 201 include/queue.php:              call_hooks('queue_deliver', $a, $params);
 202
 203 include/text.php:               call_hooks('contact_block_end', $arr);
 204
 205 include/text.php:               call_hooks('smilie', $s);
 206
 207 include/text.php:               call_hooks('prepare_body_init', $item);
 208
 209 include/text.php:               call_hooks('prepare_body', $prep_arr);
 210
 211 include/text.php:               call_hooks('prepare_body_final', $prep_arr);
 212
 213 include/nav.php:                call_hooks('page_header', $a->page['nav']);
 214
 215 include/auth.php:               call_hooks('authenticate', $addon_auth);
 216
 217 include/bbcode.php:             call_hooks('bbcode',$Text);
 218
 219 include/oauth.php:              call_hooks('logged_in', $a->user);
 220
 221 include/acl_selectors.php:      call_hooks($a->module . '_pre_' . $selname, $arr);
 222
 223 include/acl_selectors.php:      call_hooks($a->module . '_post_' . $selname, $o);
 224
 225 include/acl_selectors.php:      call_hooks('contact_select_options', $x);
 226
 227 include/acl_selectors.php:      call_hooks($a->module . '_pre_' . $selname, $arr);
 228
 229 include/acl_selectors.php:      call_hooks($a->module . '_post_' . $selname, $o);
 230
 231 include/acl_selectors.php:      call_hooks($a->module . '_pre_' . $selname, $arr);
 232
 233 include/acl_selectors.php:      call_hooks($a->module . '_post_' . $selname, $o);
 234
 235 include/notifier.php:           call_hooks('notifier_normal',$target_item);
 236
 237 include/notifier.php:           call_hooks('notifier_end',$target_item);
 238
 239 include/items.php:              call_hooks('atom_feed', $atom);
 240
 241 include/items.php:              call_hooks('atom_feed_end', $atom);
 242
 243 include/items.php:              call_hooks('atom_feed_end', $atom);
 244
 245 include/items.php:              call_hooks('parse_atom', $arr);
 246
 247 include/items.php:              call_hooks('post_remote',$arr);
 248
 249 include/items.php:              call_hooks('atom_author', $o);
 250
 251 include/items.php:              call_hooks('atom_entry', $o);
 252
 253 include/bb2diaspora.php:        call_hooks('bb2diaspora',$Text);
 254
 255 include/cronhooks.php:          call_hooks('cron', $d);
 256
 257 include/security.php:           call_hooks('logged_in', $a->user);
 258
 259 include/html2bbcode.php:        call_hooks('html2bbcode', $text);
 260
 261 include/Contact.php:            call_hooks('remove_user',$r[0]);
 262
 263 include/Contact.php:            call_hooks('contact_photo_menu', $args);
 264
 265 include/conversation.php:       call_hooks('conversation_start',$cb);
 266
 267 include/conversation.php:       call_hooks('render_location',$locate);
 268
 269 include/conversation.php:       call_hooks('display_item', $arr);
 270
 271 include/conversation.php:       call_hooks('render_location',$locate);
 272
 273 include/conversation.php:       call_hooks('display_item', $arr);
 274
 275 include/conversation.php:       call_hooks('item_photo_menu', $args);
 276
 277 include/conversation.php:       call_hooks('jot_tool', $jotplugins);
 278
 279 include/conversation.php:       call_hooks('jot_networks', $jotnets);
 280
 281 include/plugin.php:             if(! function_exists('call_hooks')) {
 282
 283 include/plugin.php:function     call_hooks($name, &$data = null) {
 284
 285 index.php:                      call_hooks('init_1');
 286
 287 index.php:                      call_hooks('app_menu', $arr);
 288
 289 index.php:                      call_hooks('page_end', $a->page['content']);
 290
 291 mod/photos.php:                 call_hooks('photo_post_init', $_POST);
 292
 293 mod/photos.php:                 call_hooks('photo_post_file',$ret);
 294
 295 mod/photos.php:                 call_hooks('photo_post_end',$foo);
 296
 297 mod/photos.php:                 call_hooks('photo_post_end',$foo);
 298
 299 mod/photos.php:                 call_hooks('photo_post_end',$foo);
 300
 301 mod/photos.php:                 call_hooks('photo_post_end',intval($item_id));
 302
 303 mod/photos.php:                 call_hooks('photo_upload_form',$ret);
 304
 305 mod/friendica.php:              call_hooks('about_hook', $o);
 306
 307 mod/editpost.php:               call_hooks('jot_tool', $jotplugins);
 308
 309 mod/editpost.php:               call_hooks('jot_networks', $jotnets);
 310
 311 mod/parse_url.php:              call_hooks('parse_link', $arr);
 312
 313 mod/home.php:                   call_hooks('home_init',$ret);
 314
 315 mod/home.php:                   call_hooks("home_content",$o);
 316
 317 mod/contacts.php:               call_hooks('contact_edit_post', $_POST);
 318
 319 mod/contacts.php:               call_hooks('contact_edit', $arr);
 320
 321 mod/settings.php:               call_hooks('plugin_settings_post', $_POST);
 322
 323 mod/settings.php:               call_hooks('connector_settings_post', $_POST);
 324
 325 mod/settings.php:               call_hooks('settings_post', $_POST);
 326
 327 mod/settings.php:               call_hooks('plugin_settings', $settings_addons);
 328
 329 mod/settings.php:               call_hooks('connector_settings', $settings_connectors);
 330
 331 mod/settings.php:               call_hooks('settings_form',$o);
 332
 333 mod/register.php:               call_hooks('register_account', $newuid);
 334
 335 mod/like.php:                   call_hooks('post_local_end', $arr);
 336
 337 mod/xrd.php:                    call_hooks('personal_xrd', $arr);
 338
 339 mod/item.php:                   call_hooks('post_local_start', $_REQUEST);
 340
 341 mod/item.php:                   call_hooks('post_local',$datarray);
 342
 343 mod/item.php:                   call_hooks('post_local_end', $datarray);
 344
 345 mod/profile.php:                call_hooks('profile_advanced',$o);
 346
 347 mod/profiles.php:               call_hooks('profile_post', $_POST);
 348
 349 mod/profiles.php:               call_hooks('profile_edit', $arr);
 350
 351 mod/tagger.php:                 call_hooks('post_local_end', $arr);
 352
 353 mod/cb.php:                     call_hooks('cb_init');
 354
 355 mod/cb.php:                     call_hooks('cb_post', $_POST);
 356
 357 mod/cb.php:                     call_hooks('cb_afterpost');
 358
 359 mod/cb.php:                     call_hooks('cb_content', $o);
 360
 361 mod/directory.php:              call_hooks('directory_item', $arr);
 362