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 `$data` is an array containing:
 246
 247 - **addon** (output): Required. The addon folder name.
 248 - **title** (output): Required. The addon settings panel title.
 249 - **href** (output): Optional. If set, will reduce the panel to a link pointing to this URL, can be relative. Incompatible with the following keys.
 250 - **html** (output): Optional. Raw HTML of the addon form elements. Both the `<form>` tags and the submit buttons are taken care of elsewhere.
 251 - **submit** (output): Optional. If unset, a default submit button with `name="<addon name>-submit"` will be generated.
 252   Can take different value types:
 253   - **string**: The label to replace the default one.
 254   - **associative array**: A list of submit button, the key is the value of the `name` attribute, the value is the displayed label.
 255     The first submit button in this list is considered the main one and themes might emphasize its display.
 256
 257 #### Examples
 258
 259 ##### With link
 260 ```php
 261 $data = [
 262         'addon' => 'advancedcontentfilter',
 263         'title' => DI::l10n()->t('Advanced Content Filter'),
 264         'href'  => 'advancedcontentfilter',
 265 ];
 266 ```
 267 ##### With default submit button
 268 ```php
 269 $data = [
 270         'addon' => 'fromapp',
 271         'title' => DI::l10n()->t('FromApp Settings'),
 272         'html'  => $html,
 273 ];
 274 ```
 275 ##### With no HTML, just a submit button
 276 ```php
 277 $data = [
 278         'addon'  => 'opmlexport',
 279         'title'  => DI::l10n()->t('OPML Export'),
 280         'submit' => DI::l10n()->t('Export RSS/Atom contacts'),
 281 ];
 282 ```
 283 ##### With multiple submit buttons
 284 ```php
 285 $data = [
 286         'addon'  => 'catavar',
 287         'title'  => DI::l10n()->t('Cat Avatar Settings'),
 288         'html'   => $html,
 289         'submit' => [
 290                 'catavatar-usecat'   => DI::l10n()->t('Use Cat as Avatar'),
 291                 'catavatar-morecat'  => DI::l10n()->t('Another random Cat!'),
 292                 'catavatar-emailcat' => DI::pConfig()->get(local_user(), 'catavatar', 'seed', false) ? DI::l10n()->t('Reset to email Cat') : null,
 293         ],
 294 ];
 295 ```
 296
 297 ### addon_settings_post
 298 Called when the Addon Settings pages are submitted.
 299 `$b` is the $_POST array.
 300
 301 ### profile_post
 302 Called when posting a profile page.
 303 `$b` is the $_POST array.
 304
 305 ### profile_edit
 306 Called prior to output of profile edit page.
 307 `$b` is an array containing:
 308
 309 - **profile**: profile (array) record from the database
 310 - **entry**: the (string) HTML of the generated entry
 311
 312 ### profile_advanced
 313 Called when the HTML is generated for the Advanced profile, corresponding to the Profile tab within a person's profile page.
 314 `$b` is the HTML string representation of the generated profile.
 315 The profile array details are in `$a->profile`.
 316
 317 ### directory_item
 318 Called from the Directory page when formatting an item for display.
 319 `$b` is an array:
 320
 321 - **contact**: contact record array for the person from the database
 322 - **entry**: the HTML string of the generated entry
 323
 324 ### profile_sidebar_enter
 325 Called prior to generating the sidebar "short" profile for a page.
 326 `$b` is the person's profile array
 327
 328 ### profile_sidebar
 329 Called when generating the sidebar "short" profile for a page.
 330 `$b` is an array:
 331
 332 - **profile**: profile record array for the person from the database
 333 - **entry**: the HTML string of the generated entry
 334
 335 ### contact_block_end
 336 Called when formatting the block of contacts/friends on a profile sidebar has completed.
 337 `$b` is an array:
 338
 339 - **contacts**: array of contacts
 340 - **output**: the generated HTML string of the contact block
 341
 342 ### bbcode
 343 Called after conversion of bbcode to HTML.
 344 `$b` is an HTML string converted text.
 345
 346 ### html2bbcode
 347 Called after tag conversion of HTML to bbcode (e.g. remote message posting)
 348 `$b` is a string converted text
 349
 350 ### head
 351 Called when building the `<head>` sections.
 352 Stylesheets should be registered using this hook.
 353 `$b` is an HTML string of the `<head>` tag.
 354
 355 ### page_header
 356 Called after building the page navigation section.
 357 `$b` is a string HTML of nav region.
 358
 359 ### personal_xrd
 360 Called prior to output of personal XRD file.
 361 `$b` is an array:
 362
 363 - **user**: the user record array for the person
 364 - **xml**: the complete XML string to be output
 365
 366 ### home_content
 367 Called prior to output home page content, shown to unlogged users.
 368 `$b` is the HTML sring of section region.
 369
 370 ### contact_edit
 371 Called when editing contact details on an individual from the Contacts page.
 372 $b is an array:
 373
 374 - **contact**: contact record (array) of target contact
 375 - **output**: the (string) generated HTML of the contact edit page
 376
 377 ### contact_edit_post
 378 Called when posting the contact edit page.
 379 `$b` is the `$_POST` array
 380
 381 ### init_1
 382 Called just after DB has been opened and before session start.
 383 No hook data.
 384
 385 ### page_end
 386 Called after HTML content functions have completed.
 387 `$b` is (string) HTML of content div.
 388
 389 ### footer
 390 Called after HTML content functions have completed.
 391 Deferred Javascript files should be registered using this hook.
 392 `$b` is (string) HTML of footer div/element.
 393
 394 ### avatar_lookup
 395 Called when looking up the avatar. `$b` is an array:
 396
 397 - **size**: the size of the avatar that will be looked up
 398 - **email**: email to look up the avatar for
 399 - **url**: the (string) generated URL of the avatar
 400
 401 ### emailer_send_prepare
 402 Called from `Emailer::send()` before building the mime message.
 403 `$b` is an array of params to `Emailer::send()`.
 404
 405 - **fromName**: name of the sender
 406 - **fromEmail**: email fo the sender
 407 - **replyTo**: replyTo address to direct responses
 408 - **toEmail**: destination email address
 409 - **messageSubject**: subject of the message
 410 - **htmlVersion**: html version of the message
 411 - **textVersion**: text only version of the message
 412 - **additionalMailHeader**: additions to the smtp mail header
 413 - **sent**: default false, if set to true in the hook, the default mailer will be skipped.
 414
 415 ### emailer_send
 416 Called before calling PHP's `mail()`.
 417 `$b` is an array of params to `mail()`.
 418
 419 - **to**
 420 - **subject**
 421 - **body**
 422 - **headers**
 423 - **sent**: default false, if set to true in the hook, the default mailer will be skipped.
 424
 425 ### load_config
 426 Called during `App` initialization to allow addons to load their own configuration file(s) with `App::loadConfigFile()`.
 427
 428 ### nav_info
 429 Called after the navigational menu is build in `include/nav.php`.
 430 `$b` is an array containing `$nav` from `include/nav.php`.
 431
 432 ### template_vars
 433 Called before vars are passed to the template engine to render the page.
 434 The registered function can add,change or remove variables passed to template.
 435 `$b` is an array with:
 436
 437 - **template**: filename of template
 438 - **vars**: array of vars passed to the template
 439
 440 ### acl_lookup_end
 441 Called after the other queries have passed.
 442 The registered function can add, change or remove the `acl_lookup()` variables.
 443
 444 - **results**: array of the acl_lookup() vars
 445
 446 ### prepare_body_init
 447 Called at the start of prepare_body
 448 Hook data:
 449
 450 - **item** (input/output): item array
 451
 452 ### prepare_body_content_filter
 453 Called before the HTML conversion in prepare_body. If the item matches a content filter rule set by an addon, it should
 454 just add the reason to the filter_reasons element of the hook data.
 455 Hook data:
 456
 457 - **item**: item array (input)
 458 - **filter_reasons** (input/output): reasons array
 459
 460 ### prepare_body
 461 Called after the HTML conversion in `prepare_body()`.
 462 Hook data:
 463
 464 - **item** (input): item array
 465 - **html** (input/output): converted item body
 466 - **is_preview** (input): post preview flag
 467 - **filter_reasons** (input): reasons array
 468
 469 ### prepare_body_final
 470 Called at the end of `prepare_body()`.
 471 Hook data:
 472
 473 - **item**: item array (input)
 474 - **html**: converted item body (input/output)
 475
 476 ### put_item_in_cache
 477 Called after `prepare_text()` in `put_item_in_cache()`.
 478 Hook data:
 479
 480 - **item** (input): item array
 481 - **rendered-html** (input/output): final item body HTML
 482 - **rendered-hash** (input/output): original item body hash
 483
 484 ### magic_auth_success
 485 Called when a magic-auth was successful.
 486 Hook data:
 487
 488     visitor => array with the contact record of the visitor
 489     url => the query string
 490
 491 ### jot_networks
 492 Called when displaying the post permission screen.
 493 Hook data is a list of form fields that need to be displayed along the ACL.
 494 Form field array structure is:
 495
 496 - **type**: `checkbox` or `select`.
 497 - **field**: Standard field data structure to be used by `field_checkbox.tpl` and `field_select.tpl`.
 498
 499 For `checkbox`, **field** is:
 500   - [0] (String): Form field name; Mandatory.
 501   - [1]: (String): Form field label; Optional, default is none.
 502   - [2]: (Boolean): Whether the checkbox should be checked by default; Optional, default is false.
 503   - [3]: (String): Additional help text; Optional, default is none.
 504   - [4]: (String): Additional HTML attributes; Optional, default is none.
 505
 506 For `select`, **field** is:
 507   - [0] (String): Form field name; Mandatory.
 508   - [1] (String): Form field label; Optional, default is none.
 509   - [2] (Boolean): Default value to be selected by default; Optional, default is none.
 510   - [3] (String): Additional help text; Optional, default is none.
 511   - [4] (Array): Associative array of options. Item key is option value, item value is option label; Mandatory.
 512
 513 ### route_collection
 514 Called just before dispatching the router.
 515 Hook data is a `\FastRoute\RouterCollector` object that should be used to add addon routes pointing to classes.
 516
 517 **Notice**: The class whose name is provided in the route handler must be reachable via auto-loader.
 518
 519 ### probe_detect
 520
 521 Called before trying to detect the target network of a URL.
 522 If any registered hook function sets the `result` key of the hook data array, it will be returned immediately.
 523 Hook functions should also return immediately if the hook data contains an existing result.
 524
 525 Hook data:
 526
 527 - **uri** (input): the profile URI.
 528 - **network** (input): the target network (can be empty for auto-detection).
 529 - **uid** (input): the user to return the contact data for (can be empty for public contacts).
 530 - **result** (output): Leave null if address isn't relevant to the connector, set to contact array if probe is successful, false otherwise.
 531
 532 ### item_by_link
 533
 534 Called when trying to probe an item from a given URI.
 535 If any registered hook function sets the `item_id` key of the hook data array, it will be returned immediately.
 536 Hook functions should also return immediately if the hook data contains an existing `item_id`.
 537
 538 Hook data:
 539 - **uri** (input): the item URI.
 540 - **uid** (input): the user to return the item data for (can be empty for public contacts).
 541 - **item_id** (output): Leave null if URI isn't relevant to the connector, set to created item array if probe is successful, false otherwise.
 542
 543 ### support_follow
 544
 545 Called to assert whether a connector addon provides follow capabilities.
 546
 547 Hook data:
 548 - **protocol** (input): shorthand for the protocol. List of values is available in `src/Core/Protocol.php`.
 549 - **result** (output): should be true if the connector provides follow capabilities, left alone otherwise.
 550
 551 ### support_revoke_follow
 552
 553 Called to assert whether a connector addon provides follow revocation capabilities.
 554
 555 Hook data:
 556 - **protocol** (input): shorthand for the protocol. List of values is available in `src/Core/Protocol.php`.
 557 - **result** (output): should be true if the connector provides follow revocation capabilities, left alone otherwise.
 558
 559 ### follow
 560
 561 Called before adding a new contact for a user to handle non-native network remote contact (like Twitter).
 562
 563 Hook data:
 564
 565 - **url** (input): URL of the remote contact.
 566 - **contact** (output): should be filled with the contact (with uid = user creating the contact) array if follow was successful.
 567
 568 ### unfollow
 569
 570 Called when unfollowing a remote contact on a non-native network (like Twitter)
 571
 572 Hook data:
 573 - **contact** (input): the remote contact (uid = local unfollowing user id) array.
 574 - **result** (output): wether the unfollowing is successful or not.
 575
 576 ### revoke_follow
 577
 578 Called when making a remote contact on a non-native network (like Twitter) unfollow you.
 579
 580 Hook data:
 581 - **contact** (input): the remote contact (uid = local revoking user id) array.
 582 - **result** (output): a boolean value indicating wether the operation was successful or not.
 583
 584 ### block
 585
 586 Called when blocking a remote contact on a non-native network (like Twitter).
 587
 588 Hook data:
 589 - **contact** (input): the remote contact (uid = 0) array.
 590 - **uid** (input): the user id to issue the block for.
 591 - **result** (output): a boolean value indicating wether the operation was successful or not.
 592
 593 ### unblock
 594
 595 Called when unblocking a remote contact on a non-native network (like Twitter).
 596
 597 Hook data:
 598 - **contact** (input): the remote contact (uid = 0) array.
 599 - **uid** (input): the user id to revoke the block for.
 600 - **result** (output): a boolean value indicating wether the operation was successful or not.
 601
 602 ### storage_instance
 603
 604 Called when a custom storage is used (e.g. webdav_storage)
 605
 606 Hook data:
 607 - **name** (input): the name of the used storage backend
 608 - **data['storage']** (output): the storage instance to use (**must** implement `\Friendica\Core\Storage\IWritableStorage`)
 609
 610 ### storage_config
 611
 612 Called when the admin of the node wants to configure a custom storage (e.g. webdav_storage)
 613
 614 Hook data:
 615 - **name** (input): the name of the used storage backend
 616 - **data['storage_config']** (output): the storage configuration instance to use (**must** implement `\Friendica\Core\Storage\Capability\IConfigureStorage`)
 617
 618 ## Complete list of hook callbacks
 619
 620 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.
 621
 622 ### index.php
 623
 624     Hook::callAll('init_1');
 625     Hook::callAll('app_menu', $arr);
 626     Hook::callAll('page_content_top', DI::page()['content']);
 627     Hook::callAll($a->module.'_mod_init', $placeholder);
 628     Hook::callAll($a->module.'_mod_init', $placeholder);
 629     Hook::callAll($a->module.'_mod_post', $_POST);
 630     Hook::callAll($a->module.'_mod_content', $arr);
 631     Hook::callAll($a->module.'_mod_aftercontent', $arr);
 632     Hook::callAll('page_end', DI::page()['content']);
 633
 634 ### include/api.php
 635
 636     Hook::callAll('logged_in', $a->user);
 637     Hook::callAll('authenticate', $addon_auth);
 638     Hook::callAll('logged_in', $a->user);
 639
 640 ### include/enotify.php
 641
 642     Hook::callAll('enotify', $h);
 643     Hook::callAll('enotify_store', $datarray);
 644     Hook::callAll('enotify_mail', $datarray);
 645     Hook::callAll('check_item_notification', $notification_data);
 646
 647 ### src/Content/Conversation.php
 648
 649     Hook::callAll('conversation_start', $cb);
 650     Hook::callAll('render_location', $locate);
 651     Hook::callAll('display_item', $arr);
 652     Hook::callAll('display_item', $arr);
 653     Hook::callAll('item_photo_menu', $args);
 654     Hook::callAll('jot_tool', $jotplugins);
 655
 656 ### mod/directory.php
 657
 658     Hook::callAll('directory_item', $arr);
 659
 660 ### mod/xrd.php
 661
 662     Hook::callAll('personal_xrd', $arr);
 663
 664 ### mod/ping.php
 665
 666     Hook::callAll('network_ping', $arr);
 667
 668 ### mod/parse_url.php
 669
 670     Hook::callAll("parse_link", $arr);
 671
 672 ### src/Module/Delegation.php
 673
 674     Hook::callAll('home_init', $ret);
 675
 676 ### mod/acl.php
 677
 678     Hook::callAll('acl_lookup_end', $results);
 679
 680 ### mod/network.php
 681
 682     Hook::callAll('network_content_init', $arr);
 683     Hook::callAll('network_tabs', $arr);
 684
 685 ### mod/friendica.php
 686
 687     Hook::callAll('about_hook', $o);
 688
 689 ### mod/profiles.php
 690
 691     Hook::callAll('profile_post', $_POST);
 692     Hook::callAll('profile_edit', $arr);
 693
 694 ### mod/settings.php
 695
 696     Hook::callAll('addon_settings_post', $_POST);
 697     Hook::callAll('connector_settings_post', $_POST);
 698     Hook::callAll('display_settings_post', $_POST);
 699     Hook::callAll('settings_post', $_POST);
 700     Hook::callAll('addon_settings', $settings_addons);
 701     Hook::callAll('connector_settings', $settings_connectors);
 702     Hook::callAll('display_settings', $o);
 703     Hook::callAll('settings_form', $o);
 704
 705 ### mod/photos.php
 706
 707     Hook::callAll('photo_post_init', $_POST);
 708     Hook::callAll('photo_post_file', $ret);
 709     Hook::callAll('photo_post_end', $foo);
 710     Hook::callAll('photo_post_end', $foo);
 711     Hook::callAll('photo_post_end', $foo);
 712     Hook::callAll('photo_post_end', $foo);
 713     Hook::callAll('photo_post_end', intval($item_id));
 714     Hook::callAll('photo_upload_form', $ret);
 715
 716 ### mod/profile.php
 717
 718     Hook::callAll('profile_advanced', $o);
 719
 720 ### mod/home.php
 721
 722     Hook::callAll('home_init', $ret);
 723     Hook::callAll("home_content", $content);
 724
 725 ### mod/poke.php
 726
 727     Hook::callAll('post_local_end', $arr);
 728
 729 ### mod/contacts.php
 730
 731     Hook::callAll('contact_edit_post', $_POST);
 732     Hook::callAll('contact_edit', $arr);
 733
 734 ### mod/tagger.php
 735
 736     Hook::callAll('post_local_end', $arr);
 737
 738 ### mod/uexport.php
 739
 740     Hook::callAll('uexport_options', $options);
 741
 742 ### mod/register.php
 743
 744     Hook::callAll('register_post', $arr);
 745     Hook::callAll('register_form', $arr);
 746
 747 ### mod/item.php
 748
 749     Hook::callAll('post_local_start', $_REQUEST);
 750     Hook::callAll('post_local', $datarray);
 751     Hook::callAll('post_local_end', $datarray);
 752
 753 ### mod/editpost.php
 754
 755     Hook::callAll('jot_tool', $jotplugins);
 756
 757 ### src/Render/FriendicaSmartyEngine.php
 758
 759     Hook::callAll("template_vars", $arr);
 760
 761 ### src/App.php
 762
 763     Hook::callAll('load_config');
 764     Hook::callAll('head');
 765     Hook::callAll('footer');
 766     Hook::callAll('route_collection');
 767
 768 ### src/Model/Item.php
 769
 770     Hook::callAll('post_local', $item);
 771     Hook::callAll('post_remote', $item);
 772     Hook::callAll('post_local_end', $posted_item);
 773     Hook::callAll('post_remote_end', $posted_item);
 774     Hook::callAll('tagged', $arr);
 775     Hook::callAll('post_local_end', $new_item);
 776     Hook::callAll('put_item_in_cache', $hook_data);
 777     Hook::callAll('prepare_body_init', $item);
 778     Hook::callAll('prepare_body_content_filter', $hook_data);
 779     Hook::callAll('prepare_body', $hook_data);
 780     Hook::callAll('prepare_body_final', $hook_data);
 781
 782 ### src/Model/Contact.php
 783
 784     Hook::callAll('contact_photo_menu', $args);
 785     Hook::callAll('follow', $arr);
 786
 787 ### src/Model/Profile.php
 788
 789     Hook::callAll('profile_sidebar_enter', $profile);
 790     Hook::callAll('profile_sidebar', $arr);
 791     Hook::callAll('profile_tabs', $arr);
 792     Hook::callAll('zrl_init', $arr);
 793     Hook::callAll('magic_auth_success', $arr);
 794
 795 ### src/Model/Event.php
 796
 797     Hook::callAll('event_updated', $event['id']);
 798     Hook::callAll("event_created", $event['id']);
 799
 800 ### src/Model/Register.php
 801
 802     Hook::callAll('authenticate', $addon_auth);
 803
 804 ### src/Model/User.php
 805
 806     Hook::callAll('authenticate', $addon_auth);
 807     Hook::callAll('register_account', $uid);
 808     Hook::callAll('remove_user', $user);
 809
 810 ### src/Module/PermissionTooltip.php
 811
 812     Hook::callAll('lockview_content', $item);
 813
 814 ### src/Module/Settings/Delegation.php
 815
 816     Hook::callAll('authenticate', $addon_auth);
 817
 818 ### src/Module/Settings/TwoFactor/Index.php
 819
 820     Hook::callAll('authenticate', $addon_auth);
 821
 822 ### src/Security/Authenticate.php
 823
 824     Hook::callAll('authenticate', $addon_auth);
 825
 826 ### src/Security/ExAuth.php
 827
 828     Hook::callAll('authenticate', $addon_auth);
 829
 830 ### src/Content/ContactBlock.php
 831
 832     Hook::callAll('contact_block_end', $arr);
 833
 834 ### src/Content/Text/BBCode.php
 835
 836     Hook::callAll('bbcode', $text);
 837     Hook::callAll('bb2diaspora', $text);
 838
 839 ### src/Content/Text/HTML.php
 840
 841     Hook::callAll('html2bbcode', $message);
 842
 843 ### src/Content/Smilies.php
 844
 845     Hook::callAll('smilie', $params);
 846
 847 ### src/Content/Feature.php
 848
 849     Hook::callAll('isEnabled', $arr);
 850     Hook::callAll('get', $arr);
 851
 852 ### src/Content/ContactSelector.php
 853
 854     Hook::callAll('network_to_name', $nets);
 855
 856 ### src/Content/OEmbed.php
 857
 858     Hook::callAll('oembed_fetch_url', $embedurl, $j);
 859
 860 ### src/Content/Nav.php
 861
 862     Hook::callAll('page_header', DI::page()['nav']);
 863     Hook::callAll('nav_info', $nav);
 864
 865 ### src/Core/Authentication.php
 866
 867     Hook::callAll('logged_in', $a->user);
 868
 869 ### src/Core/Protocol.php
 870
 871     Hook::callAll('support_follow', $hook_data);
 872     Hook::callAll('support_revoke_follow', $hook_data);
 873     Hook::callAll('unfollow', $hook_data);
 874     Hook::callAll('revoke_follow', $hook_data);
 875     Hook::callAll('block', $hook_data);
 876     Hook::callAll('unblock', $hook_data);
 877
 878 ### src/Core/StorageManager
 879
 880     Hook::callAll('storage_instance', $data);
 881     Hook::callAll('storage_config', $data);
 882
 883 ### src/Worker/Directory.php
 884
 885     Hook::callAll('globaldir_update', $arr);
 886
 887 ### src/Worker/Notifier.php
 888
 889     Hook::callAll('notifier_end', $target_item);
 890
 891 ### src/Module/Login.php
 892
 893     Hook::callAll('login_hook', $o);
 894
 895 ### src/Module/Logout.php
 896
 897     Hook::callAll("logging_out");
 898
 899 ### src/Object/Post.php
 900
 901     Hook::callAll('render_location', $locate);
 902     Hook::callAll('display_item', $arr);
 903
 904 ### src/Core/ACL.php
 905
 906     Hook::callAll('contact_select_options', $x);
 907     Hook::callAll($a->module.'_pre_'.$selname, $arr);
 908     Hook::callAll($a->module.'_post_'.$selname, $o);
 909     Hook::callAll($a->module.'_pre_'.$selname, $arr);
 910     Hook::callAll($a->module.'_post_'.$selname, $o);
 911     Hook::callAll('jot_networks', $jotnets);
 912
 913 ### src/Core/Authentication.php
 914
 915     Hook::callAll('logged_in', $a->user);
 916     Hook::callAll('authenticate', $addon_auth);
 917
 918 ### src/Core/Hook.php
 919
 920     self::callSingle(self::getApp(), 'hook_fork', $fork_hook, $hookdata);
 921
 922 ### src/Core/L10n/L10n.php
 923
 924     Hook::callAll('poke_verbs', $arr);
 925
 926 ### src/Core/Worker.php
 927
 928     Hook::callAll("proc_run", $arr);
 929
 930 ### src/Util/Emailer.php
 931
 932     Hook::callAll('emailer_send_prepare', $params);
 933     Hook::callAll("emailer_send", $hookdata);
 934
 935 ### src/Util/Map.php
 936
 937     Hook::callAll('generate_map', $arr);
 938     Hook::callAll('generate_named_map', $arr);
 939     Hook::callAll('Map::getCoordinates', $arr);
 940
 941 ### src/Util/Network.php
 942
 943     Hook::callAll('avatar_lookup', $avatar);
 944
 945 ### src/Util/ParseUrl.php
 946
 947     Hook::callAll("getsiteinfo", $siteinfo);
 948
 949 ### src/Protocol/DFRN.php
 950
 951     Hook::callAll('atom_feed_end', $atom);
 952     Hook::callAll('atom_feed_end', $atom);
 953
 954 ### src/Protocol/Email.php
 955
 956     Hook::callAll('email_getmessage', $message);
 957     Hook::callAll('email_getmessage_end', $ret);
 958
 959 ### view/js/main.js
 960
 961     document.dispatchEvent(new Event('postprocess_liveupdate'));