doc/Addons.md

   1 Friendica Addon development
   2 ==============
   3
   4 * [Home](help)
   5
   6 Please see the sample addon 'randplace' for a working example of using some of these features.
   7 Addons work by intercepting event hooks - which must be registered.
   8 Modules work by intercepting specific page requests (by URL path).
   9
  10 ## Naming
  11
  12 Addon names are used in file paths and functions names, and as such:
  13 - Can't contain spaces or punctuation.
  14 - Can't start with a number.
  15
  16 ## Metadata
  17
  18 You can provide human-readable information about your addon in the first multi-line comment of your addon file.
  19
  20 Here's the structure:
  21
  22 ```php
  23 /**
  24  * Name: {Human-readable name}
  25  * Description: {Short description}
  26  * Version: 1.0
  27  * Author: {Author1 Name}
  28  * Author: {Author2 Name} <{Author profile link}>
  29  * Maintainer: {Maintainer1 Name}
  30  * Maintainer: {Maintainer2 Name} <{Maintainer profile link}>
  31  * Status: {Unsupported|Arbitrary status}
  32  */
  33 ```
  34
  35 You can also provide a longer documentation in a `README` or `README.md` file.
  36 The latter will be converted from Markdown to HTML in the addon detail page.
  37
  38 ## Install/Uninstall
  39
  40 If your addon uses hooks, they have to be registered in a `<addon>_install()` function.
  41 This function also allows to perform arbitrary actions your addon needs to function properly.
  42
  43 Uninstalling an addon automatically unregisters any hook it registered, but if you need to provide specific uninstallation steps, you can add them in a `<addon>_uninstall()` function.
  44
  45 The install and uninstall functions will be called (i.e. re-installed) if the addon changes after installation.
  46 Therefore your uninstall should not destroy data and install should consider that data may already exist.
  47 Future extensions may provide for "setup" amd "remove".
  48
  49 ## PHP addon hooks
  50
  51 Register your addon hooks during installation.
  52
  53     \Friendica\Core\Hook::register($hookname, $file, $function);
  54
  55 `$hookname` is a string and corresponds to a known Friendica PHP hook.
  56
  57 `$file` is a pathname relative to the top-level Friendica directory.
  58 This *should* be 'addon/*addon_name*/*addon_name*.php' in most cases and can be shortened to `__FILE__`.
  59
  60 `$function` is a string and is the name of the function which will be executed when the hook is called.
  61
  62 ### Arguments
  63 Your hook callback functions will be called with at least one and possibly two arguments
  64
  65     function <addon>_<hookname>(App $a, &$b) {
  66
  67     }
  68
  69 If you wish to make changes to the calling data, you must declare them as reference variables (with `&`) during function declaration.
  70
  71 #### $a
  72 $a is the Friendica `App` class.
  73 It contains a wealth of information about the current state of Friendica:
  74
  75 * which module has been called,
  76 * configuration information,
  77 * the page contents at the point the hook was invoked,
  78 * profile and user information, etc.
  79
  80 It is recommeded you call this `$a` to match its usage elsewhere.
  81
  82 #### $b
  83 $b can be called anything you like.
  84 This is information specific to the hook currently being processed, and generally contains information that is being immediately processed or acted on that you can use, display, or alter.
  85 Remember to declare it with `&` if you wish to alter it.
  86
  87 ## Admin settings
  88
  89 Your addon can provide user-specific settings via the `addon_settings` PHP hook, but it can also provide node-wide settings in the administration page of your addon.
  90
  91 Simply declare a `<addon>_addon_admin(App $a)` function to display the form and a `<addon>_addon_admin_post(App $a)` function to process the data from the form.
  92
  93 ## Global stylesheets
  94
  95 If your addon requires adding a stylesheet on all pages of Friendica, add the following hook:
  96
  97 ```php
  98 function <addon>_install()
  99 {
 100         \Friendica\Core\Hook::register('head', __FILE__, '<addon>_head');
 101         ...
 102 }
 103
 104
 105 function <addon>_head(App $a)
 106 {
 107         \Friendica\DI::page()->registerStylesheet(__DIR__ . '/relative/path/to/addon/stylesheet.css');
 108 }
 109 ```
 110
 111 `__DIR__` is the folder path of your addon.
 112
 113 ## JavaScript
 114
 115 ### Global scripts
 116
 117 If your addon requires adding a script on all pages of Friendica, add the following hook:
 118
 119
 120 ```php
 121 function <addon>_install()
 122 {
 123         \Friendica\Core\Hook::register('footer', __FILE__, '<addon>_footer');
 124         ...
 125 }
 126
 127 function <addon>_footer(App $a)
 128 {
 129         \Friendica\DI::page()->registerFooterScript(__DIR__ . '/relative/path/to/addon/script.js');
 130 }
 131 ```
 132
 133 `__DIR__` is the folder path of your addon.
 134
 135 ### JavaScript hooks
 136
 137 The main Friendica script provides hooks via events dispatched on the `document` property.
 138 In your Javascript file included as described above, add your event listener like this:
 139
 140 ```js
 141 document.addEventListener(name, callback);
 142 ```
 143
 144 - *name* is the name of the hook and corresponds to a known Friendica JavaScript hook.
 145 - *callback* is a JavaScript anonymous function to execute.
 146
 147 More info about Javascript event listeners: https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener
 148
 149 #### Current JavaScript hooks
 150
 151 ##### postprocess_liveupdate
 152 Called at the end of the live update process (XmlHttpRequest) and on a post preview.
 153 No additional data is provided.
 154
 155 ## Modules
 156
 157 Addons may also act as "modules" and intercept all page requests for a given URL path.
 158 In order for a addon to act as a module it needs to declare an empty function `<addon>_module()`.
 159
 160 If this function exists, you will now receive all page requests for `https://my.web.site/<addon>` - with any number of URL components as additional arguments.
 161 These are parsed into the `App\Arguments` object.
 162 So `https://my.web.site/addon/arg1/arg2` would give this:
 163 ```php
 164 DI::args()->getArgc(); // = 3
 165 DI::args()->get(0); // = 'addon'
 166 DI::args()->get(1); // = 'arg1'
 167 DI::args()->get(2); // = 'arg2'
 168 ```
 169
 170 To display a module page, you need to declare the function `<addon>_content(App $a)`, which defines and returns the page body content.
 171 They may also contain `<addon>_post(App $a)` which is called before the `<addon>_content` function and typically handles the results of POST forms.
 172 You may also have `<addon>_init(App $a)` which is called before `<addon>_content` and should include common logic to your module.
 173
 174 ## Templates
 175
 176 If your addon needs some template, you can use the Friendica template system.
 177 Friendica uses [smarty3](http://www.smarty.net/) as a template engine.
 178
 179 Put your tpl files in the *templates/* subfolder of your addon.
 180
 181 In your code, like in the function addon_name_content(), load the template file and execute it passing needed values:
 182
 183 ```php
 184 use Friendica\Core\Renderer;
 185
 186 # load template file. first argument is the template name,
 187 # second is the addon path relative to friendica top folder
 188 $tpl = Renderer::getMarkupTemplate('mytemplate.tpl', __DIR__);
 189
 190 # apply template. first argument is the loaded template,
 191 # second an array of 'name' => 'values' to pass to template
 192 $output = Renderer::replaceMacros($tpl, array(
 193         'title' => 'My beautiful addon',
 194 ));
 195 ```
 196
 197 See also the wiki page [Quick Template Guide](https://github.com/friendica/friendica/wiki/Quick-Template-Guide).
 198
 199 ## Current PHP hooks
 200
 201 ### authenticate
 202 Called when a user attempts to login.
 203 `$b` is an array containing:
 204
 205 - **username**: the supplied username
 206 - **password**: the supplied password
 207 - **authenticated**: set this to non-zero to authenticate the user.
 208 - **user_record**: successful authentication must also return a valid user record from the database
 209
 210 ### logged_in
 211 Called after a user has successfully logged in.
 212 `$b` contains the `$a->user` array.
 213
 214 ### display_item
 215 Called when formatting a post for display.
 216 $b is an array:
 217
 218 - **item**: The item (array) details pulled from the database
 219 - **output**: the (string) HTML representation of this item prior to adding it to the page
 220
 221 ### post_local
 222 Called when a status post or comment is entered on the local system.
 223 `$b` is the item array of the information to be stored in the database.
 224 Please note: body contents are bbcode - not HTML.
 225
 226 ### post_local_end
 227 Called when a local status post or comment has been stored on the local system.
 228 `$b` is the item array of the information which has just been stored in the database.
 229 Please note: body contents are bbcode - not HTML
 230
 231 ### post_remote
 232 Called when receiving a post from another source. This may also be used to post local activity or system generated messages.
 233 `$b` is the item array of information to be stored in the database and the item body is bbcode.
 234
 235 ### settings_form
 236 Called when generating the HTML for the user Settings page.
 237 `$b` is the HTML string of the settings page before the final `</form>` tag.
 238
 239 ### settings_post
 240 Called when the Settings pages are submitted.
 241 `$b` is the $_POST array.
 242
 243 ### addon_settings
 244 Called when generating the HTML for the addon settings page.
 245 `$b` is the (string) HTML of the addon settings page before the final `</form>` tag.
 246
 247 ### addon_settings_post
 248 Called when the Addon Settings pages are submitted.
 249 `$b` is the $_POST array.
 250
 251 ### profile_post
 252 Called when posting a profile page.
 253 `$b` is the $_POST array.
 254
 255 ### profile_edit
 256 Called prior to output of profile edit page.
 257 `$b` is an array containing:
 258
 259 - **profile**: profile (array) record from the database
 260 - **entry**: the (string) HTML of the generated entry
 261
 262 ### profile_advanced
 263 Called when the HTML is generated for the Advanced profile, corresponding to the Profile tab within a person's profile page.
 264 `$b` is the HTML string representation of the generated profile.
 265 The profile array details are in `$a->profile`.
 266
 267 ### directory_item
 268 Called from the Directory page when formatting an item for display.
 269 `$b` is an array:
 270
 271 - **contact**: contact record array for the person from the database
 272 - **entry**: the HTML string of the generated entry
 273
 274 ### profile_sidebar_enter
 275 Called prior to generating the sidebar "short" profile for a page.
 276 `$b` is the person's profile array
 277
 278 ### profile_sidebar
 279 Called when generating the sidebar "short" profile for a page.
 280 `$b` is an array:
 281
 282 - **profile**: profile record array for the person from the database
 283 - **entry**: the HTML string of the generated entry
 284
 285 ### contact_block_end
 286 Called when formatting the block of contacts/friends on a profile sidebar has completed.
 287 `$b` is an array:
 288
 289 - **contacts**: array of contacts
 290 - **output**: the generated HTML string of the contact block
 291
 292 ### bbcode
 293 Called after conversion of bbcode to HTML.
 294 `$b` is an HTML string converted text.
 295
 296 ### html2bbcode
 297 Called after tag conversion of HTML to bbcode (e.g. remote message posting)
 298 `$b` is a string converted text
 299
 300 ### head
 301 Called when building the `<head>` sections.
 302 Stylesheets should be registered using this hook.
 303 `$b` is an HTML string of the `<head>` tag.
 304
 305 ### page_header
 306 Called after building the page navigation section.
 307 `$b` is a string HTML of nav region.
 308
 309 ### personal_xrd
 310 Called prior to output of personal XRD file.
 311 `$b` is an array:
 312
 313 - **user**: the user record array for the person
 314 - **xml**: the complete XML string to be output
 315
 316 ### home_content
 317 Called prior to output home page content, shown to unlogged users.
 318 `$b` is the HTML sring of section region.
 319
 320 ### contact_edit
 321 Called when editing contact details on an individual from the Contacts page.
 322 $b is an array:
 323
 324 - **contact**: contact record (array) of target contact
 325 - **output**: the (string) generated HTML of the contact edit page
 326
 327 ### contact_edit_post
 328 Called when posting the contact edit page.
 329 `$b` is the `$_POST` array
 330
 331 ### init_1
 332 Called just after DB has been opened and before session start.
 333 No hook data.
 334
 335 ### page_end
 336 Called after HTML content functions have completed.
 337 `$b` is (string) HTML of content div.
 338
 339 ### footer
 340 Called after HTML content functions have completed.
 341 Deferred Javascript files should be registered using this hook.
 342 `$b` is (string) HTML of footer div/element.
 343
 344 ### avatar_lookup
 345 Called when looking up the avatar. `$b` is an array:
 346
 347 - **size**: the size of the avatar that will be looked up
 348 - **email**: email to look up the avatar for
 349 - **url**: the (string) generated URL of the avatar
 350
 351 ### emailer_send_prepare
 352 Called from `Emailer::send()` before building the mime message.
 353 `$b` is an array of params to `Emailer::send()`.
 354
 355 - **fromName**: name of the sender
 356 - **fromEmail**: email fo the sender
 357 - **replyTo**: replyTo address to direct responses
 358 - **toEmail**: destination email address
 359 - **messageSubject**: subject of the message
 360 - **htmlVersion**: html version of the message
 361 - **textVersion**: text only version of the message
 362 - **additionalMailHeader**: additions to the smtp mail header
 363 - **sent**: default false, if set to true in the hook, the default mailer will be skipped.
 364
 365 ### emailer_send
 366 Called before calling PHP's `mail()`.
 367 `$b` is an array of params to `mail()`.
 368
 369 - **to**
 370 - **subject**
 371 - **body**
 372 - **headers**
 373 - **sent**: default false, if set to true in the hook, the default mailer will be skipped.
 374
 375 ### load_config
 376 Called during `App` initialization to allow addons to load their own configuration file(s) with `App::loadConfigFile()`.
 377
 378 ### nav_info
 379 Called after the navigational menu is build in `include/nav.php`.
 380 `$b` is an array containing `$nav` from `include/nav.php`.
 381
 382 ### template_vars
 383 Called before vars are passed to the template engine to render the page.
 384 The registered function can add,change or remove variables passed to template.
 385 `$b` is an array with:
 386
 387 - **template**: filename of template
 388 - **vars**: array of vars passed to the template
 389
 390 ### acl_lookup_end
 391 Called after the other queries have passed.
 392 The registered function can add, change or remove the `acl_lookup()` variables.
 393
 394 - **results**: array of the acl_lookup() vars
 395
 396 ### prepare_body_init
 397 Called at the start of prepare_body
 398 Hook data:
 399
 400 - **item** (input/output): item array
 401
 402 ### prepare_body_content_filter
 403 Called before the HTML conversion in prepare_body. If the item matches a content filter rule set by an addon, it should
 404 just add the reason to the filter_reasons element of the hook data.
 405 Hook data:
 406
 407 - **item**: item array (input)
 408 - **filter_reasons** (input/output): reasons array
 409
 410 ### prepare_body
 411 Called after the HTML conversion in `prepare_body()`.
 412 Hook data:
 413
 414 - **item** (input): item array
 415 - **html** (input/output): converted item body
 416 - **is_preview** (input): post preview flag
 417 - **filter_reasons** (input): reasons array
 418
 419 ### prepare_body_final
 420 Called at the end of `prepare_body()`.
 421 Hook data:
 422
 423 - **item**: item array (input)
 424 - **html**: converted item body (input/output)
 425
 426 ### put_item_in_cache
 427 Called after `prepare_text()` in `put_item_in_cache()`.
 428 Hook data:
 429
 430 - **item** (input): item array
 431 - **rendered-html** (input/output): final item body HTML
 432 - **rendered-hash** (input/output): original item body hash
 433
 434 ### magic_auth_success
 435 Called when a magic-auth was successful.
 436 Hook data:
 437
 438     visitor => array with the contact record of the visitor
 439     url => the query string
 440
 441 ### jot_networks
 442 Called when displaying the post permission screen.
 443 Hook data is a list of form fields that need to be displayed along the ACL.
 444 Form field array structure is:
 445
 446 - **type**: `checkbox` or `select`.
 447 - **field**: Standard field data structure to be used by `field_checkbox.tpl` and `field_select.tpl`.
 448
 449 For `checkbox`, **field** is:
 450   - [0] (String): Form field name; Mandatory.
 451   - [1]: (String): Form field label; Optional, default is none.
 452   - [2]: (Boolean): Whether the checkbox should be checked by default; Optional, default is false.
 453   - [3]: (String): Additional help text; Optional, default is none.
 454   - [4]: (String): Additional HTML attributes; Optional, default is none.
 455
 456 For `select`, **field** is:
 457   - [0] (String): Form field name; Mandatory.
 458   - [1] (String): Form field label; Optional, default is none.
 459   - [2] (Boolean): Default value to be selected by default; Optional, default is none.
 460   - [3] (String): Additional help text; Optional, default is none.
 461   - [4] (Array): Associative array of options. Item key is option value, item value is option label; Mandatory.
 462
 463 ### route_collection
 464 Called just before dispatching the router.
 465 Hook data is a `\FastRoute\RouterCollector` object that should be used to add addon routes pointing to classes.
 466
 467 **Notice**: The class whose name is provided in the route handler must be reachable via auto-loader.
 468
 469 ### probe_detect
 470
 471 Called before trying to detect the target network of a URL.
 472 If any registered hook function sets the `result` key of the hook data array, it will be returned immediately.
 473 Hook functions should also return immediately if the hook data contains an existing result.
 474
 475 Hook data:
 476
 477 - **uri** (input): the profile URI.
 478 - **network** (input): the target network (can be empty for auto-detection).
 479 - **uid** (input): the user to return the contact data for (can be empty for public contacts).
 480 - **result** (output): Set by the hook function to indicate a successful detection.
 481
 482 ### support_follow
 483
 484 Called to assert whether a connector addon provides follow capabilities.
 485
 486 Hook data:
 487 - **protocol** (input): shorthand for the protocol. List of values is available in `src/Core/Protocol.php`.
 488 - **result** (output): should be true if the connector provides follow capabilities, left alone otherwise.
 489
 490 ### support_revoke_follow
 491
 492 Called to assert whether a connector addon provides follow revocation capabilities.
 493
 494 Hook data:
 495 - **protocol** (input): shorthand for the protocol. List of values is available in `src/Core/Protocol.php`.
 496 - **result** (output): should be true if the connector provides follow revocation capabilities, left alone otherwise.
 497
 498 ### follow
 499
 500 Called before adding a new contact for a user to handle non-native network remote contact (like Twitter).
 501
 502 Hook data:
 503
 504 - **url** (input): URL of the remote contact.
 505 - **contact** (output): should be filled with the contact (with uid = user creating the contact) array if follow was successful.
 506
 507 ### unfollow
 508
 509 Called when unfollowing a remote contact on a non-native network (like Twitter)
 510
 511 Hook data:
 512 - **contact** (input): the remote contact (uid = local unfollowing user id) array.
 513 - **result** (output): wether the unfollowing is successful or not.
 514
 515 ### revoke_follow
 516
 517 Called when making a remote contact on a non-native network (like Twitter) unfollow you.
 518
 519 Hook data:
 520 - **contact** (input): the remote contact (uid = local revoking user id) array.
 521 - **result** (output): a boolean value indicating wether the operation was successful or not.
 522
 523 ### block
 524
 525 Called when blocking a remote contact on a non-native network (like Twitter).
 526
 527 Hook data:
 528 - **contact** (input): the remote contact (uid = 0) array.
 529 - **uid** (input): the user id to issue the block for.
 530 - **result** (output): a boolean value indicating wether the operation was successful or not.
 531
 532 ### unblock
 533
 534 Called when unblocking a remote contact on a non-native network (like Twitter).
 535
 536 Hook data:
 537 - **contact** (input): the remote contact (uid = 0) array.
 538 - **uid** (input): the user id to revoke the block for.
 539 - **result** (output): a boolean value indicating wether the operation was successful or not.
 540
 541 ### storage_instance
 542
 543 Called when a custom storage is used (e.g. webdav_storage)
 544
 545 Hook data:
 546 - **name** (input): the name of the used storage backend
 547 - **data['storage']** (output): the storage instance to use (**must** implement `\Friendica\Model\Storage\IWritableStorage`)
 548
 549 ### storage_config
 550
 551 Called when the admin of the node wants to configure a custom storage (e.g. webdav_storage)
 552
 553 Hook data:
 554 - **name** (input): the name of the used storage backend
 555 - **data['storage_config']** (output): the storage configuration instance to use (**must** implement `\Friendica\Model\Storage\IStorageConfiguration`)
 556
 557 ## Complete list of hook callbacks
 558
 559 Here is a complete list of all hook callbacks with file locations (as of 24-Sep-2018). Please see the source for details of any hooks not documented above.
 560
 561 ### index.php
 562
 563     Hook::callAll('init_1');
 564     Hook::callAll('app_menu', $arr);
 565     Hook::callAll('page_content_top', DI::page()['content']);
 566     Hook::callAll($a->module.'_mod_init', $placeholder);
 567     Hook::callAll($a->module.'_mod_init', $placeholder);
 568     Hook::callAll($a->module.'_mod_post', $_POST);
 569     Hook::callAll($a->module.'_mod_afterpost', $placeholder);
 570     Hook::callAll($a->module.'_mod_content', $arr);
 571     Hook::callAll($a->module.'_mod_aftercontent', $arr);
 572     Hook::callAll('page_end', DI::page()['content']);
 573
 574 ### include/api.php
 575
 576     Hook::callAll('logged_in', $a->user);
 577     Hook::callAll('authenticate', $addon_auth);
 578     Hook::callAll('logged_in', $a->user);
 579
 580 ### include/enotify.php
 581
 582     Hook::callAll('enotify', $h);
 583     Hook::callAll('enotify_store', $datarray);
 584     Hook::callAll('enotify_mail', $datarray);
 585     Hook::callAll('check_item_notification', $notification_data);
 586
 587 ### src/Content/Conversation.php
 588
 589     Hook::callAll('conversation_start', $cb);
 590     Hook::callAll('render_location', $locate);
 591     Hook::callAll('display_item', $arr);
 592     Hook::callAll('display_item', $arr);
 593     Hook::callAll('item_photo_menu', $args);
 594     Hook::callAll('jot_tool', $jotplugins);
 595
 596 ### mod/directory.php
 597
 598     Hook::callAll('directory_item', $arr);
 599
 600 ### mod/xrd.php
 601
 602     Hook::callAll('personal_xrd', $arr);
 603
 604 ### mod/ping.php
 605
 606     Hook::callAll('network_ping', $arr);
 607
 608 ### mod/parse_url.php
 609
 610     Hook::callAll("parse_link", $arr);
 611
 612 ### src/Module/Delegation.php
 613
 614     Hook::callAll('home_init', $ret);
 615
 616 ### mod/acl.php
 617
 618     Hook::callAll('acl_lookup_end', $results);
 619
 620 ### mod/network.php
 621
 622     Hook::callAll('network_content_init', $arr);
 623     Hook::callAll('network_tabs', $arr);
 624
 625 ### mod/friendica.php
 626
 627     Hook::callAll('about_hook', $o);
 628
 629 ### mod/profiles.php
 630
 631     Hook::callAll('profile_post', $_POST);
 632     Hook::callAll('profile_edit', $arr);
 633
 634 ### mod/settings.php
 635
 636     Hook::callAll('addon_settings_post', $_POST);
 637     Hook::callAll('connector_settings_post', $_POST);
 638     Hook::callAll('display_settings_post', $_POST);
 639     Hook::callAll('settings_post', $_POST);
 640     Hook::callAll('addon_settings', $settings_addons);
 641     Hook::callAll('connector_settings', $settings_connectors);
 642     Hook::callAll('display_settings', $o);
 643     Hook::callAll('settings_form', $o);
 644
 645 ### mod/photos.php
 646
 647     Hook::callAll('photo_post_init', $_POST);
 648     Hook::callAll('photo_post_file', $ret);
 649     Hook::callAll('photo_post_end', $foo);
 650     Hook::callAll('photo_post_end', $foo);
 651     Hook::callAll('photo_post_end', $foo);
 652     Hook::callAll('photo_post_end', $foo);
 653     Hook::callAll('photo_post_end', intval($item_id));
 654     Hook::callAll('photo_upload_form', $ret);
 655
 656 ### mod/profile.php
 657
 658     Hook::callAll('profile_advanced', $o);
 659
 660 ### mod/home.php
 661
 662     Hook::callAll('home_init', $ret);
 663     Hook::callAll("home_content", $content);
 664
 665 ### mod/poke.php
 666
 667     Hook::callAll('post_local_end', $arr);
 668
 669 ### mod/contacts.php
 670
 671     Hook::callAll('contact_edit_post', $_POST);
 672     Hook::callAll('contact_edit', $arr);
 673
 674 ### mod/tagger.php
 675
 676     Hook::callAll('post_local_end', $arr);
 677
 678 ### mod/uexport.php
 679
 680     Hook::callAll('uexport_options', $options);
 681
 682 ### mod/register.php
 683
 684     Hook::callAll('register_post', $arr);
 685     Hook::callAll('register_form', $arr);
 686
 687 ### mod/item.php
 688
 689     Hook::callAll('post_local_start', $_REQUEST);
 690     Hook::callAll('post_local', $datarray);
 691     Hook::callAll('post_local_end', $datarray);
 692
 693 ### mod/editpost.php
 694
 695     Hook::callAll('jot_tool', $jotplugins);
 696
 697 ### src/Render/FriendicaSmartyEngine.php
 698
 699     Hook::callAll("template_vars", $arr);
 700
 701 ### src/App.php
 702
 703     Hook::callAll('load_config');
 704     Hook::callAll('head');
 705     Hook::callAll('footer');
 706     Hook::callAll('route_collection');
 707
 708 ### src/Model/Item.php
 709
 710     Hook::callAll('post_local', $item);
 711     Hook::callAll('post_remote', $item);
 712     Hook::callAll('post_local_end', $posted_item);
 713     Hook::callAll('post_remote_end', $posted_item);
 714     Hook::callAll('tagged', $arr);
 715     Hook::callAll('post_local_end', $new_item);
 716     Hook::callAll('put_item_in_cache', $hook_data);
 717     Hook::callAll('prepare_body_init', $item);
 718     Hook::callAll('prepare_body_content_filter', $hook_data);
 719     Hook::callAll('prepare_body', $hook_data);
 720     Hook::callAll('prepare_body_final', $hook_data);
 721
 722 ### src/Model/Contact.php
 723
 724     Hook::callAll('contact_photo_menu', $args);
 725     Hook::callAll('follow', $arr);
 726
 727 ### src/Model/Profile.php
 728
 729     Hook::callAll('profile_sidebar_enter', $profile);
 730     Hook::callAll('profile_sidebar', $arr);
 731     Hook::callAll('profile_tabs', $arr);
 732     Hook::callAll('zrl_init', $arr);
 733     Hook::callAll('magic_auth_success', $arr);
 734
 735 ### src/Model/Event.php
 736
 737     Hook::callAll('event_updated', $event['id']);
 738     Hook::callAll("event_created", $event['id']);
 739
 740 ### src/Model/Register.php
 741
 742     Hook::callAll('authenticate', $addon_auth);
 743
 744 ### src/Model/User.php
 745
 746     Hook::callAll('authenticate', $addon_auth);
 747     Hook::callAll('register_account', $uid);
 748     Hook::callAll('remove_user', $user);
 749
 750 ### src/Module/PermissionTooltip.php
 751
 752     Hook::callAll('lockview_content', $item);
 753
 754 ### src/Module/Settings/Delegation.php
 755
 756     Hook::callAll('authenticate', $addon_auth);
 757
 758 ### src/Module/Settings/TwoFactor/Index.php
 759
 760     Hook::callAll('authenticate', $addon_auth);
 761
 762 ### src/Security/Authenticate.php
 763
 764     Hook::callAll('authenticate', $addon_auth);
 765
 766 ### src/Security/ExAuth.php
 767
 768     Hook::callAll('authenticate', $addon_auth);
 769
 770 ### src/Content/ContactBlock.php
 771
 772     Hook::callAll('contact_block_end', $arr);
 773
 774 ### src/Content/Text/BBCode.php
 775
 776     Hook::callAll('bbcode', $text);
 777     Hook::callAll('bb2diaspora', $text);
 778
 779 ### src/Content/Text/HTML.php
 780
 781     Hook::callAll('html2bbcode', $message);
 782
 783 ### src/Content/Smilies.php
 784
 785     Hook::callAll('smilie', $params);
 786
 787 ### src/Content/Feature.php
 788
 789     Hook::callAll('isEnabled', $arr);
 790     Hook::callAll('get', $arr);
 791
 792 ### src/Content/ContactSelector.php
 793
 794     Hook::callAll('network_to_name', $nets);
 795
 796 ### src/Content/OEmbed.php
 797
 798     Hook::callAll('oembed_fetch_url', $embedurl, $j);
 799
 800 ### src/Content/Nav.php
 801
 802     Hook::callAll('page_header', DI::page()['nav']);
 803     Hook::callAll('nav_info', $nav);
 804
 805 ### src/Core/Authentication.php
 806
 807     Hook::callAll('logged_in', $a->user);
 808
 809 ### src/Core/Protocol.php
 810
 811     Hook::callAll('support_follow', $hook_data);
 812     Hook::callAll('support_revoke_follow', $hook_data);
 813     Hook::callAll('unfollow', $hook_data);
 814     Hook::callAll('revoke_follow', $hook_data);
 815     Hook::callAll('block', $hook_data);
 816     Hook::callAll('unblock', $hook_data);
 817
 818 ### src/Core/StorageManager
 819
 820     Hook::callAll('storage_instance', $data);
 821     Hook::callAll('storage_config', $data);
 822
 823 ### src/Worker/Directory.php
 824
 825     Hook::callAll('globaldir_update', $arr);
 826
 827 ### src/Worker/Notifier.php
 828
 829     Hook::callAll('notifier_end', $target_item);
 830
 831 ### src/Module/Login.php
 832
 833     Hook::callAll('login_hook', $o);
 834
 835 ### src/Module/Logout.php
 836
 837     Hook::callAll("logging_out");
 838
 839 ### src/Object/Post.php
 840
 841     Hook::callAll('render_location', $locate);
 842     Hook::callAll('display_item', $arr);
 843
 844 ### src/Core/ACL.php
 845
 846     Hook::callAll('contact_select_options', $x);
 847     Hook::callAll($a->module.'_pre_'.$selname, $arr);
 848     Hook::callAll($a->module.'_post_'.$selname, $o);
 849     Hook::callAll($a->module.'_pre_'.$selname, $arr);
 850     Hook::callAll($a->module.'_post_'.$selname, $o);
 851     Hook::callAll('jot_networks', $jotnets);
 852
 853 ### src/Core/Authentication.php
 854
 855     Hook::callAll('logged_in', $a->user);
 856     Hook::callAll('authenticate', $addon_auth);
 857
 858 ### src/Core/Hook.php
 859
 860     self::callSingle(self::getApp(), 'hook_fork', $fork_hook, $hookdata);
 861
 862 ### src/Core/L10n/L10n.php
 863
 864     Hook::callAll('poke_verbs', $arr);
 865
 866 ### src/Core/Worker.php
 867
 868     Hook::callAll("proc_run", $arr);
 869
 870 ### src/Util/Emailer.php
 871
 872     Hook::callAll('emailer_send_prepare', $params);
 873     Hook::callAll("emailer_send", $hookdata);
 874
 875 ### src/Util/Map.php
 876
 877     Hook::callAll('generate_map', $arr);
 878     Hook::callAll('generate_named_map', $arr);
 879     Hook::callAll('Map::getCoordinates', $arr);
 880
 881 ### src/Util/Network.php
 882
 883     Hook::callAll('avatar_lookup', $avatar);
 884
 885 ### src/Util/ParseUrl.php
 886
 887     Hook::callAll("getsiteinfo", $siteinfo);
 888
 889 ### src/Protocol/DFRN.php
 890
 891     Hook::callAll('atom_feed_end', $atom);
 892     Hook::callAll('atom_feed_end', $atom);
 893
 894 ### src/Protocol/Email.php
 895
 896     Hook::callAll('email_getmessage', $message);
 897     Hook::callAll('email_getmessage_end', $ret);
 898
 899 ### view/js/main.js
 900
 901     document.dispatchEvent(new Event('postprocess_liveupdate'));