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" and "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 most one argument
  64
  65     function <addon>_<hookname>(&$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 #### $b
  72 $b can be called anything you like.
  73 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.
  74 Remember to declare it with `&` if you wish to alter it.
  75
  76 ## Admin settings
  77
  78 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.
  79
  80 Simply declare a `<addon>_addon_admin()` function to display the form and a `<addon>_addon_admin_post()` function to process the data from the form.0
  81
  82 ## Global stylesheets
  83
  84 If your addon requires adding a stylesheet on all pages of Friendica, add the following hook:
  85
  86 ```php
  87 function <addon>_install()
  88 {
  89         \Friendica\Core\Hook::register('head', __FILE__, '<addon>_head');
  90         ...
  91 }
  92
  93
  94 function <addon>_head()
  95 {
  96         \Friendica\DI::page()->registerStylesheet(__DIR__ . '/relative/path/to/addon/stylesheet.css');
  97 }
  98 ```
  99
 100 `__DIR__` is the folder path of your addon.
 101
 102 ## JavaScript
 103
 104 ### Global scripts
 105
 106 If your addon requires adding a script on all pages of Friendica, add the following hook:
 107
 108
 109 ```php
 110 function <addon>_install()
 111 {
 112         \Friendica\Core\Hook::register('footer', __FILE__, '<addon>_footer');
 113         ...
 114 }
 115
 116 function <addon>_footer()
 117 {
 118         \Friendica\DI::page()->registerFooterScript(__DIR__ . '/relative/path/to/addon/script.js');
 119 }
 120 ```
 121
 122 `__DIR__` is the folder path of your addon.
 123
 124 ### JavaScript hooks
 125
 126 The main Friendica script provides hooks via events dispatched on the `document` property.
 127 In your JavaScript file included as described above, add your event listener like this:
 128
 129 ```js
 130 document.addEventListener(name, callback);
 131 ```
 132
 133 - *name* is the name of the hook and corresponds to a known Friendica JavaScript hook.
 134 - *callback* is a JavaScript anonymous function to execute.
 135
 136 More info about JavaScript event listeners: https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener
 137
 138 #### Current JavaScript hooks
 139
 140 ##### postprocess_liveupdate
 141 Called at the end of the live update process (XmlHttpRequest) and on a post preview.
 142 No additional data is provided.
 143
 144 ## Modules
 145
 146 Addons may also act as "modules" and intercept all page requests for a given URL path.
 147 In order for a addon to act as a module it needs to declare an empty function `<addon>_module()`.
 148
 149 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.
 150 These are parsed into the `App\Arguments` object.
 151 So `https://my.web.site/addon/arg1/arg2` would give this:
 152 ```php
 153 DI::args()->getArgc(); // = 3
 154 DI::args()->get(0); // = 'addon'
 155 DI::args()->get(1); // = 'arg1'
 156 DI::args()->get(2); // = 'arg2'
 157 ```
 158
 159 To display a module page, you need to declare the function `<addon>_content()`, which defines and returns the page body content.
 160 They may also contain `<addon>_post()` which is called before the `<addon>_content` function and typically handles the results of POST forms.
 161 You may also have `<addon>_init()` which is called before `<addon>_content` and should include common logic to your module.
 162
 163 ## Templates
 164
 165 If your addon needs some template, you can use the Friendica template system.
 166 Friendica uses [smarty3](http://www.smarty.net/) as a template engine.
 167
 168 Put your tpl files in the *templates/* subfolder of your addon.
 169
 170 In your code, like in the function addon_name_content(), load the template file and execute it passing needed values:
 171
 172 ```php
 173 use Friendica\Core\Renderer;
 174
 175 # load template file. first argument is the template name,
 176 # second is the addon path relative to friendica top folder
 177 $tpl = Renderer::getMarkupTemplate('mytemplate.tpl', __DIR__);
 178
 179 # apply template. first argument is the loaded template,
 180 # second an array of 'name' => 'values' to pass to template
 181 $output = Renderer::replaceMacros($tpl, array(
 182         'title' => 'My beautiful addon',
 183 ));
 184 ```
 185
 186 See also the wiki page [Quick Template Guide](https://github.com/friendica/friendica/wiki/Quick-Template-Guide).
 187
 188 ## Current PHP hooks
 189
 190 ### authenticate
 191 Called when a user attempts to login.
 192 `$b` is an array containing:
 193
 194 - **username**: the supplied username
 195 - **password**: the supplied password
 196 - **authenticated**: set this to non-zero to authenticate the user.
 197 - **user_record**: successful authentication must also return a valid user record from the database
 198
 199 ### logged_in
 200 Called after a user has successfully logged in.
 201 `$b` contains the `App->user` array.
 202
 203 ### display_item
 204 Called when formatting a post for display.
 205 $b is an array:
 206
 207 - **item**: The item (array) details pulled from the database
 208 - **output**: the (string) HTML representation of this item prior to adding it to the page
 209
 210 ### post_local
 211 Called when a status post or comment is entered on the local system.
 212 `$b` is the item array of the information to be stored in the database.
 213 Please note: body contents are bbcode - not HTML.
 214
 215 ### post_local_end
 216 Called when a local status post or comment has been stored on the local system.
 217 `$b` is the item array of the information which has just been stored in the database.
 218 Please note: body contents are bbcode - not HTML
 219
 220 ### post_remote
 221 Called when receiving a post from another source. This may also be used to post local activity or system generated messages.
 222 `$b` is the item array of information to be stored in the database and the item body is bbcode.
 223
 224 ### addon_settings
 225 Called when generating the HTML for the addon settings page.
 226 `$data` is an array containing:
 227
 228 - **addon** (output): Required. The addon folder name.
 229 - **title** (output): Required. The addon settings panel title.
 230 - **href** (output): Optional. If set, will reduce the panel to a link pointing to this URL, can be relative. Incompatible with the following keys.
 231 - **html** (output): Optional. Raw HTML of the addon form elements. Both the `<form>` tags and the submit buttons are taken care of elsewhere.
 232 - **submit** (output): Optional. If unset, a default submit button with `name="<addon name>-submit"` will be generated.
 233   Can take different value types:
 234   - **string**: The label to replace the default one.
 235   - **associative array**: A list of submit button, the key is the value of the `name` attribute, the value is the displayed label.
 236     The first submit button in this list is considered the main one and themes might emphasize its display.
 237
 238 #### Examples
 239
 240 ##### With link
 241 ```php
 242 $data = [
 243         'addon' => 'advancedcontentfilter',
 244         'title' => DI::l10n()->t('Advanced Content Filter'),
 245         'href'  => 'advancedcontentfilter',
 246 ];
 247 ```
 248 ##### With default submit button
 249 ```php
 250 $data = [
 251         'addon' => 'fromapp',
 252         'title' => DI::l10n()->t('FromApp Settings'),
 253         'html'  => $html,
 254 ];
 255 ```
 256 ##### With no HTML, just a submit button
 257 ```php
 258 $data = [
 259         'addon'  => 'opmlexport',
 260         'title'  => DI::l10n()->t('OPML Export'),
 261         'submit' => DI::l10n()->t('Export RSS/Atom contacts'),
 262 ];
 263 ```
 264 ##### With multiple submit buttons
 265 ```php
 266 $data = [
 267         'addon'  => 'catavatar',
 268         'title'  => DI::l10n()->t('Cat Avatar Settings'),
 269         'html'   => $html,
 270         'submit' => [
 271                 'catavatar-usecat'   => DI::l10n()->t('Use Cat as Avatar'),
 272                 'catavatar-morecat'  => DI::l10n()->t('Another random Cat!'),
 273                 'catavatar-emailcat' => DI::pConfig()->get(Session::getLocalUser(), 'catavatar', 'seed', false) ? DI::l10n()->t('Reset to email Cat') : null,
 274         ],
 275 ];
 276 ```
 277
 278 ### addon_settings_post
 279 Called when the Addon Settings pages are submitted.
 280 `$b` is the $_POST array.
 281
 282 ### connector_settings
 283 Called when generating the HTML for a connector addon settings page.
 284 `$data` is an array containing:
 285
 286 - **connector** (output): Required. The addon folder name.
 287 - **title** (output): Required. The addon settings panel title.
 288 - **image** (output): Required. The relative path of the logo image of the platform/protocol this addon is connecting to, max size 48x48px.
 289 - **enabled** (output): Optional. If set to a falsy value, the connector image will be dimmed.
 290 - **html** (output): Optional. Raw HTML of the addon form elements. Both the `<form>` tags and the submit buttons are taken care of elsewhere.
 291 - **submit** (output): Optional. If unset, a default submit button with `name="<addon name>-submit"` will be generated.
 292   Can take different value types:
 293     - **string**: The label to replace the default one.
 294       - **associative array**: A list of submit button, the key is the value of the `name` attribute, the value is the displayed label.
 295         The first submit button in this list is considered the main one and themes might emphasize its display.
 296
 297 #### Examples
 298
 299 ##### With default submit button
 300 ```php
 301 $data = [
 302         'connector' => 'diaspora',
 303         'title'     => DI::l10n()->t('Diaspora Export'),
 304         'image'     => 'images/diaspora-logo.png',
 305         'enabled'   => $enabled,
 306         'html'      => $html,
 307 ];
 308 ```
 309
 310 ##### With custom submit button label and no logo dim
 311 ```php
 312 $data = [
 313         'connector' => 'ifttt',
 314         'title'     => DI::l10n()->t('IFTTT Mirror'),
 315         'image'     => 'addon/ifttt/ifttt.png',
 316         'html'      => $html,
 317         'submit'    => DI::l10n()->t('Generate new key'),
 318 ];
 319 ```
 320
 321 ##### With conditional submit buttons
 322 ```php
 323 $submit = ['pumpio-submit' => DI::l10n()->t('Save Settings')];
 324 if ($oauth_token && $oauth_token_secret) {
 325         $submit['pumpio-delete'] = DI::l10n()->t('Delete this preset');
 326 }
 327
 328 $data = [
 329         'connector' => 'pumpio',
 330         'title'     => DI::l10n()->t('Pump.io Import/Export/Mirror'),
 331         'image'     => 'images/pumpio.png',
 332         'enabled'   => $enabled,
 333         'html'      => $html,
 334         'submit'    => $submit,
 335 ];
 336 ```
 337
 338 ### profile_post
 339 Called when posting a profile page.
 340 `$b` is the $_POST array.
 341
 342 ### profile_edit
 343 Called prior to output of profile edit page.
 344 `$b` is an array containing:
 345
 346 - **profile**: profile (array) record from the database
 347 - **entry**: the (string) HTML of the generated entry
 348
 349 ### profile_advanced
 350 Called when the HTML is generated for the Advanced profile, corresponding to the Profile tab within a person's profile page.
 351 `$b` is the HTML string representation of the generated profile.
 352 The profile array details are in `App->profile`.
 353
 354 ### directory_item
 355 Called from the Directory page when formatting an item for display.
 356 `$b` is an array:
 357
 358 - **contact**: contact record array for the person from the database
 359 - **entry**: the HTML string of the generated entry
 360
 361 ### profile_sidebar_enter
 362 Called prior to generating the sidebar "short" profile for a page.
 363 `$b` is the person's profile array
 364
 365 ### profile_sidebar
 366 Called when generating the sidebar "short" profile for a page.
 367 `$b` is an array:
 368
 369 - **profile**: profile record array for the person from the database
 370 - **entry**: the HTML string of the generated entry
 371
 372 ### contact_block_end
 373 Called when formatting the block of contacts/friends on a profile sidebar has completed.
 374 `$b` is an array:
 375
 376 - **contacts**: array of contacts
 377 - **output**: the generated HTML string of the contact block
 378
 379 ### bbcode
 380 Called after conversion of bbcode to HTML.
 381 `$b` is an HTML string converted text.
 382
 383 ### html2bbcode
 384 Called after tag conversion of HTML to bbcode (e.g. remote message posting)
 385 `$b` is a string converted text
 386
 387 ### head
 388 Called when building the `<head>` sections.
 389 Stylesheets should be registered using this hook.
 390 `$b` is an HTML string of the `<head>` tag.
 391
 392 ### page_header
 393 Called after building the page navigation section.
 394 `$b` is a string HTML of nav region.
 395
 396 ### personal_xrd
 397 Called prior to output of personal XRD file.
 398 `$b` is an array:
 399
 400 - **user**: the user record array for the person
 401 - **xml**: the complete XML string to be output
 402
 403 ### home_content
 404 Called prior to output home page content, shown to unlogged users.
 405 `$b` is the HTML string of section region.
 406
 407 ### contact_edit
 408 Called when editing contact details on an individual from the Contacts page.
 409 $b is an array:
 410
 411 - **contact**: contact record (array) of target contact
 412 - **output**: the (string) generated HTML of the contact edit page
 413
 414 ### contact_edit_post
 415 Called when posting the contact edit page.
 416 `$b` is the `$_POST` array
 417
 418 ### init_1
 419 Called just after DB has been opened and before session start.
 420 No hook data.
 421
 422 ### page_end
 423 Called after HTML content functions have completed.
 424 `$b` is (string) HTML of content div.
 425
 426 ### footer
 427 Called after HTML content functions have completed.
 428 Deferred JavaScript files should be registered using this hook.
 429 `$b` is (string) HTML of footer div/element.
 430
 431 ### avatar_lookup
 432 Called when looking up the avatar. `$b` is an array:
 433
 434 - **size**: the size of the avatar that will be looked up
 435 - **email**: email to look up the avatar for
 436 - **url**: the (string) generated URL of the avatar
 437
 438 ### emailer_send_prepare
 439 Called from `Emailer::send()` before building the mime message.
 440 `$b` is an array of params to `Emailer::send()`.
 441
 442 - **fromName**: name of the sender
 443 - **fromEmail**: email fo the sender
 444 - **replyTo**: replyTo address to direct responses
 445 - **toEmail**: destination email address
 446 - **messageSubject**: subject of the message
 447 - **htmlVersion**: html version of the message
 448 - **textVersion**: text only version of the message
 449 - **additionalMailHeader**: additions to the smtp mail header
 450 - **sent**: default false, if set to true in the hook, the default mailer will be skipped.
 451
 452 ### emailer_send
 453 Called before calling PHP's `mail()`.
 454 `$b` is an array of params to `mail()`.
 455
 456 - **to**
 457 - **subject**
 458 - **body**
 459 - **headers**
 460 - **sent**: default false, if set to true in the hook, the default mailer will be skipped.
 461
 462 ### load_config
 463 Called during `App` initialization to allow addons to load their own configuration file(s) with `App::loadConfigFile()`.
 464
 465 ### nav_info
 466 Called after the navigational menu is build in `include/nav.php`.
 467 `$b` is an array containing `$nav` from `include/nav.php`.
 468
 469 ### template_vars
 470 Called before vars are passed to the template engine to render the page.
 471 The registered function can add,change or remove variables passed to template.
 472 `$b` is an array with:
 473
 474 - **template**: filename of template
 475 - **vars**: array of vars passed to the template
 476
 477 ### acl_lookup_end
 478 Called after the other queries have passed.
 479 The registered function can add, change or remove the `acl_lookup()` variables.
 480
 481 - **results**: array of the acl_lookup() vars
 482
 483 ### prepare_body_init
 484 Called at the start of prepare_body
 485 Hook data:
 486
 487 - **item** (input/output): item array
 488
 489 ### prepare_body_content_filter
 490 Called before the HTML conversion in prepare_body. If the item matches a content filter rule set by an addon, it should
 491 just add the reason to the filter_reasons element of the hook data.
 492 Hook data:
 493
 494 - **item**: item array (input)
 495 - **filter_reasons** (input/output): reasons array
 496
 497 ### prepare_body
 498 Called after the HTML conversion in `prepare_body()`.
 499 Hook data:
 500
 501 - **item** (input): item array
 502 - **html** (input/output): converted item body
 503 - **is_preview** (input): post preview flag
 504 - **filter_reasons** (input): reasons array
 505
 506 ### prepare_body_final
 507 Called at the end of `prepare_body()`.
 508 Hook data:
 509
 510 - **item**: item array (input)
 511 - **html**: converted item body (input/output)
 512
 513 ### put_item_in_cache
 514 Called after `prepare_text()` in `put_item_in_cache()`.
 515 Hook data:
 516
 517 - **item** (input): item array
 518 - **rendered-html** (input/output): final item body HTML
 519 - **rendered-hash** (input/output): original item body hash
 520
 521 ### magic_auth_success
 522 Called when a magic-auth was successful.
 523 Hook data:
 524
 525     visitor => array with the contact record of the visitor
 526     url => the query string
 527
 528 ### jot_networks
 529 Called when displaying the post permission screen.
 530 Hook data is a list of form fields that need to be displayed along the ACL.
 531 Form field array structure is:
 532
 533 - **type**: `checkbox` or `select`.
 534 - **field**: Standard field data structure to be used by `field_checkbox.tpl` and `field_select.tpl`.
 535
 536 For `checkbox`, **field** is:
 537   - [0] (String): Form field name; Mandatory.
 538   - [1]: (String): Form field label; Optional, default is none.
 539   - [2]: (Boolean): Whether the checkbox should be checked by default; Optional, default is false.
 540   - [3]: (String): Additional help text; Optional, default is none.
 541   - [4]: (String): Additional HTML attributes; Optional, default is none.
 542
 543 For `select`, **field** is:
 544   - [0] (String): Form field name; Mandatory.
 545   - [1] (String): Form field label; Optional, default is none.
 546   - [2] (Boolean): Default value to be selected by default; Optional, default is none.
 547   - [3] (String): Additional help text; Optional, default is none.
 548   - [4] (Array): Associative array of options. Item key is option value, item value is option label; Mandatory.
 549
 550 ### route_collection
 551 Called just before dispatching the router.
 552 Hook data is a `\FastRoute\RouterCollector` object that should be used to add addon routes pointing to classes.
 553
 554 **Notice**: The class whose name is provided in the route handler must be reachable via auto-loader.
 555
 556 ### probe_detect
 557
 558 Called before trying to detect the target network of a URL.
 559 If any registered hook function sets the `result` key of the hook data array, it will be returned immediately.
 560 Hook functions should also return immediately if the hook data contains an existing result.
 561
 562 Hook data:
 563
 564 - **uri** (input): the profile URI.
 565 - **network** (input): the target network (can be empty for auto-detection).
 566 - **uid** (input): the user to return the contact data for (can be empty for public contacts).
 567 - **result** (output): Leave null if address isn't relevant to the connector, set to contact array if probe is successful, false otherwise.
 568
 569 ### item_by_link
 570
 571 Called when trying to probe an item from a given URI.
 572 If any registered hook function sets the `item_id` key of the hook data array, it will be returned immediately.
 573 Hook functions should also return immediately if the hook data contains an existing `item_id`.
 574
 575 Hook data:
 576 - **uri** (input): the item URI.
 577 - **uid** (input): the user to return the item data for (can be empty for public contacts).
 578 - **item_id** (output): Leave null if URI isn't relevant to the connector, set to created item array if probe is successful, false otherwise.
 579
 580 ### support_follow
 581
 582 Called to assert whether a connector addon provides follow capabilities.
 583
 584 Hook data:
 585 - **protocol** (input): shorthand for the protocol. List of values is available in `src/Core/Protocol.php`.
 586 - **result** (output): should be true if the connector provides follow capabilities, left alone otherwise.
 587
 588 ### support_revoke_follow
 589
 590 Called to assert whether a connector addon provides follow revocation capabilities.
 591
 592 Hook data:
 593 - **protocol** (input): shorthand for the protocol. List of values is available in `src/Core/Protocol.php`.
 594 - **result** (output): should be true if the connector provides follow revocation capabilities, left alone otherwise.
 595
 596 ### follow
 597
 598 Called before adding a new contact for a user to handle non-native network remote contact (like Twitter).
 599
 600 Hook data:
 601
 602 - **url** (input): URL of the remote contact.
 603 - **contact** (output): should be filled with the contact (with uid = user creating the contact) array if follow was successful.
 604
 605 ### unfollow
 606
 607 Called when unfollowing a remote contact on a non-native network (like Twitter)
 608
 609 Hook data:
 610 - **contact** (input): the target public contact (uid = 0) array.
 611 - **uid** (input): the id of the source local user.
 612 - **result** (output): wether the unfollowing is successful or not.
 613
 614 ### revoke_follow
 615
 616 Called when making a remote contact on a non-native network (like Twitter) unfollow you.
 617
 618 Hook data:
 619 - **contact** (input): the target public contact (uid = 0) array.
 620 - **uid** (input): the id of the source local user.
 621 - **result** (output): a boolean value indicating wether the operation was successful or not.
 622
 623 ### block
 624
 625 Called when blocking a remote contact on a non-native network (like Twitter).
 626
 627 Hook data:
 628 - **contact** (input): the remote contact (uid = 0) array.
 629 - **uid** (input): the user id to issue the block for.
 630 - **result** (output): a boolean value indicating wether the operation was successful or not.
 631
 632 ### unblock
 633
 634 Called when unblocking a remote contact on a non-native network (like Twitter).
 635
 636 Hook data:
 637 - **contact** (input): the remote contact (uid = 0) array.
 638 - **uid** (input): the user id to revoke the block for.
 639 - **result** (output): a boolean value indicating wether the operation was successful or not.
 640
 641 ### support_probe
 642
 643 Called to assert whether a connector addon provides probing capabilities.
 644
 645 Hook data:
 646 - **protocol** (input): shorthand for the protocol. List of values is available in `src/Core/Protocol.php`.
 647 - **result** (output): should be true if the connector provides follow capabilities, left alone otherwise.
 648
 649 ### storage_instance
 650
 651 Called when a custom storage is used (e.g. webdav_storage)
 652
 653 Hook data:
 654 - **name** (input): the name of the used storage backend
 655 - **data['storage']** (output): the storage instance to use (**must** implement `\Friendica\Core\Storage\IWritableStorage`)
 656
 657 ### storage_config
 658
 659 Called when the admin of the node wants to configure a custom storage (e.g. webdav_storage)
 660
 661 Hook data:
 662 - **name** (input): the name of the used storage backend
 663 - **data['storage_config']** (output): the storage configuration instance to use (**must** implement `\Friendica\Core\Storage\Capability\IConfigureStorage`)
 664
 665 ## Complete list of hook callbacks
 666
 667 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.
 668
 669 ### index.php
 670
 671     Hook::callAll('init_1');
 672     Hook::callAll('app_menu', $arr);
 673     Hook::callAll('page_content_top', DI::page()['content']);
 674     Hook::callAll($a->module.'_mod_init', $placeholder);
 675     Hook::callAll($a->module.'_mod_init', $placeholder);
 676     Hook::callAll($a->module.'_mod_post', $_POST);
 677     Hook::callAll($a->module.'_mod_content', $arr);
 678     Hook::callAll($a->module.'_mod_aftercontent', $arr);
 679     Hook::callAll('page_end', DI::page()['content']);
 680
 681 ### include/api.php
 682
 683     Hook::callAll('logged_in', $a->user);
 684     Hook::callAll('authenticate', $addon_auth);
 685     Hook::callAll('logged_in', $a->user);
 686
 687 ### include/enotify.php
 688
 689     Hook::callAll('enotify', $h);
 690     Hook::callAll('enotify_store', $datarray);
 691     Hook::callAll('enotify_mail', $datarray);
 692     Hook::callAll('check_item_notification', $notification_data);
 693
 694 ### src/Content/Conversation.php
 695
 696     Hook::callAll('conversation_start', $cb);
 697     Hook::callAll('render_location', $locate);
 698     Hook::callAll('display_item', $arr);
 699     Hook::callAll('display_item', $arr);
 700     Hook::callAll('item_photo_menu', $args);
 701     Hook::callAll('jot_tool', $jotplugins);
 702
 703 ### mod/directory.php
 704
 705     Hook::callAll('directory_item', $arr);
 706
 707 ### mod/xrd.php
 708
 709     Hook::callAll('personal_xrd', $arr);
 710
 711 ### mod/parse_url.php
 712
 713     Hook::callAll("parse_link", $arr);
 714
 715 ### src/Module/Delegation.php
 716
 717     Hook::callAll('home_init', $ret);
 718
 719 ### mod/acl.php
 720
 721     Hook::callAll('acl_lookup_end', $results);
 722
 723 ### mod/network.php
 724
 725     Hook::callAll('network_content_init', $arr);
 726     Hook::callAll('network_tabs', $arr);
 727
 728 ### mod/friendica.php
 729
 730     Hook::callAll('about_hook', $o);
 731
 732 ### mod/profiles.php
 733
 734     Hook::callAll('profile_post', $_POST);
 735     Hook::callAll('profile_edit', $arr);
 736
 737 ### mod/settings.php
 738
 739     Hook::callAll('addon_settings_post', $_POST);
 740     Hook::callAll('connector_settings_post', $_POST);
 741     Hook::callAll('display_settings_post', $_POST);
 742     Hook::callAll('addon_settings', $settings_addons);
 743     Hook::callAll('connector_settings', $settings_connectors);
 744     Hook::callAll('display_settings', $o);
 745
 746 ### mod/photos.php
 747
 748     Hook::callAll('photo_post_init', $_POST);
 749     Hook::callAll('photo_post_file', $ret);
 750     Hook::callAll('photo_post_end', $foo);
 751     Hook::callAll('photo_post_end', $foo);
 752     Hook::callAll('photo_post_end', $foo);
 753     Hook::callAll('photo_post_end', $foo);
 754     Hook::callAll('photo_post_end', intval($item_id));
 755     Hook::callAll('photo_upload_form', $ret);
 756
 757 ### mod/profile.php
 758
 759     Hook::callAll('profile_advanced', $o);
 760
 761 ### mod/home.php
 762
 763     Hook::callAll('home_init', $ret);
 764     Hook::callAll("home_content", $content);
 765
 766 ### mod/contacts.php
 767
 768     Hook::callAll('contact_edit_post', $_POST);
 769     Hook::callAll('contact_edit', $arr);
 770
 771 ### mod/tagger.php
 772
 773     Hook::callAll('post_local_end', $arr);
 774
 775 ### mod/uexport.php
 776
 777     Hook::callAll('uexport_options', $options);
 778
 779 ### mod/register.php
 780
 781     Hook::callAll('register_post', $arr);
 782     Hook::callAll('register_form', $arr);
 783
 784 ### mod/item.php
 785
 786     Hook::callAll('post_local_start', $_REQUEST);
 787     Hook::callAll('post_local', $datarray);
 788     Hook::callAll('post_local_end', $datarray);
 789
 790 ### src/Render/FriendicaSmartyEngine.php
 791
 792     Hook::callAll("template_vars", $arr);
 793
 794 ### src/App.php
 795
 796     Hook::callAll('load_config');
 797     Hook::callAll('head');
 798     Hook::callAll('footer');
 799     Hook::callAll('route_collection');
 800
 801 ### src/Model/Item.php
 802
 803     Hook::callAll('post_local', $item);
 804     Hook::callAll('post_remote', $item);
 805     Hook::callAll('post_local_end', $posted_item);
 806     Hook::callAll('post_remote_end', $posted_item);
 807     Hook::callAll('tagged', $arr);
 808     Hook::callAll('post_local_end', $new_item);
 809     Hook::callAll('put_item_in_cache', $hook_data);
 810     Hook::callAll('prepare_body_init', $item);
 811     Hook::callAll('prepare_body_content_filter', $hook_data);
 812     Hook::callAll('prepare_body', $hook_data);
 813     Hook::callAll('prepare_body_final', $hook_data);
 814
 815 ### src/Model/Contact.php
 816
 817     Hook::callAll('contact_photo_menu', $args);
 818     Hook::callAll('follow', $arr);
 819
 820 ### src/Model/Profile.php
 821
 822     Hook::callAll('profile_sidebar_enter', $profile);
 823     Hook::callAll('profile_sidebar', $arr);
 824     Hook::callAll('profile_tabs', $arr);
 825     Hook::callAll('zrl_init', $arr);
 826     Hook::callAll('magic_auth_success', $arr);
 827
 828 ### src/Model/Event.php
 829
 830     Hook::callAll('event_updated', $event['id']);
 831     Hook::callAll("event_created", $event['id']);
 832
 833 ### src/Model/Register.php
 834
 835     Hook::callAll('authenticate', $addon_auth);
 836
 837 ### src/Model/User.php
 838
 839     Hook::callAll('authenticate', $addon_auth);
 840     Hook::callAll('register_account', $uid);
 841     Hook::callAll('remove_user', $user);
 842
 843 ### src/Module/Notifications/Ping.php
 844
 845     Hook::callAll('network_ping', $arr);
 846
 847 ### src/Module/PermissionTooltip.php
 848
 849     Hook::callAll('lockview_content', $item);
 850
 851 ### src/Module/Post/Edit.php
 852
 853     Hook::callAll('jot_tool', $jotplugins);
 854
 855 ### src/Module/Settings/Delegation.php
 856
 857     Hook::callAll('authenticate', $addon_auth);
 858
 859 ### src/Module/Settings/TwoFactor/Index.php
 860
 861     Hook::callAll('authenticate', $addon_auth);
 862
 863 ### src/Security/Authenticate.php
 864
 865     Hook::callAll('authenticate', $addon_auth);
 866
 867 ### src/Security/ExAuth.php
 868
 869     Hook::callAll('authenticate', $addon_auth);
 870
 871 ### src/Content/ContactBlock.php
 872
 873     Hook::callAll('contact_block_end', $arr);
 874
 875 ### src/Content/Text/BBCode.php
 876
 877     Hook::callAll('bbcode', $text);
 878     Hook::callAll('bb2diaspora', $text);
 879
 880 ### src/Content/Text/HTML.php
 881
 882     Hook::callAll('html2bbcode', $message);
 883
 884 ### src/Content/Smilies.php
 885
 886     Hook::callAll('smilie', $params);
 887
 888 ### src/Content/Feature.php
 889
 890     Hook::callAll('isEnabled', $arr);
 891     Hook::callAll('get', $arr);
 892
 893 ### src/Content/ContactSelector.php
 894
 895     Hook::callAll('network_to_name', $nets);
 896
 897 ### src/Content/OEmbed.php
 898
 899     Hook::callAll('oembed_fetch_url', $embedurl, $j);
 900
 901 ### src/Content/Nav.php
 902
 903     Hook::callAll('page_header', DI::page()['nav']);
 904     Hook::callAll('nav_info', $nav);
 905
 906 ### src/Core/Authentication.php
 907
 908     Hook::callAll('logged_in', $a->user);
 909
 910 ### src/Core/Protocol.php
 911
 912     Hook::callAll('support_follow', $hook_data);
 913     Hook::callAll('support_revoke_follow', $hook_data);
 914     Hook::callAll('unfollow', $hook_data);
 915     Hook::callAll('revoke_follow', $hook_data);
 916     Hook::callAll('block', $hook_data);
 917     Hook::callAll('unblock', $hook_data);
 918     Hook::callAll('support_probe', $hook_data);
 919
 920 ### src/Core/Logger/Factory.php
 921
 922     Hook::callAll('logger_instance', $data);
 923
 924 ### src/Core/StorageManager
 925
 926     Hook::callAll('storage_instance', $data);
 927     Hook::callAll('storage_config', $data);
 928
 929 ### src/Worker/Directory.php
 930
 931     Hook::callAll('globaldir_update', $arr);
 932
 933 ### src/Worker/Notifier.php
 934
 935     Hook::callAll('notifier_end', $target_item);
 936
 937 ### src/Module/Login.php
 938
 939     Hook::callAll('login_hook', $o);
 940
 941 ### src/Module/Logout.php
 942
 943     Hook::callAll("logging_out");
 944
 945 ### src/Object/Post.php
 946
 947     Hook::callAll('render_location', $locate);
 948     Hook::callAll('display_item', $arr);
 949
 950 ### src/Core/ACL.php
 951
 952     Hook::callAll('contact_select_options', $x);
 953     Hook::callAll($a->module.'_pre_'.$selname, $arr);
 954     Hook::callAll($a->module.'_post_'.$selname, $o);
 955     Hook::callAll($a->module.'_pre_'.$selname, $arr);
 956     Hook::callAll($a->module.'_post_'.$selname, $o);
 957     Hook::callAll('jot_networks', $jotnets);
 958
 959 ### src/Core/Authentication.php
 960
 961     Hook::callAll('logged_in', $a->user);
 962     Hook::callAll('authenticate', $addon_auth);
 963
 964 ### src/Core/Hook.php
 965
 966     self::callSingle(self::getApp(), 'hook_fork', $fork_hook, $hookdata);
 967
 968 ### src/Core/Worker.php
 969
 970     Hook::callAll("proc_run", $arr);
 971
 972 ### src/Util/Emailer.php
 973
 974     Hook::callAll('emailer_send_prepare', $params);
 975     Hook::callAll("emailer_send", $hookdata);
 976
 977 ### src/Util/Map.php
 978
 979     Hook::callAll('generate_map', $arr);
 980     Hook::callAll('generate_named_map', $arr);
 981     Hook::callAll('Map::getCoordinates', $arr);
 982
 983 ### src/Util/Network.php
 984
 985     Hook::callAll('avatar_lookup', $avatar);
 986
 987 ### src/Util/ParseUrl.php
 988
 989     Hook::callAll("getsiteinfo", $siteinfo);
 990
 991 ### src/Protocol/DFRN.php
 992
 993     Hook::callAll('atom_feed_end', $atom);
 994     Hook::callAll('atom_feed_end', $atom);
 995
 996 ### src/Protocol/Email.php
 997
 998     Hook::callAll('email_getmessage', $message);
 999     Hook::callAll('email_getmessage_end', $ret);
1000
1001 ### view/js/main.js
1002
1003     document.dispatchEvent(new Event('postprocess_liveupdate'));