The Hubzilla
 All Classes Namespaces Files Functions Variables Pages
Hooks List
Member anon_identity_init ($reqvars)
anon_identity_init
  • array request_vars
  • string xchan - return value
  • string|int success - Must be a number, so xchan return value gets used
Member App::build_pagehead ()
build_pagehead Called when creating the HTML page header.
  • string header - Return the HTML header which should be added
Member atom_author ($tag, $nick, $name, $uri, $h, $w, $type, $photo)
atom_author Possibility to add further tags to returned XML string
  • string - The created XML tag as a string without closing tag
Member atom_entry ($item, $type, $author, $owner, $comment=false, $cid=0, $compat=false)
atom_entry
  • array item
  • string type
  • array author
  • array owner
  • string comment
  • number abook_id
  • string entry - The generated entry and what will get returned
Member atom_render_author ($tag, $xchan)
atom_render_author Possibility to add further tags to returned XML string.
  • string The created XML tag as a string without closing tag
Member attach_store ($channel, $observer_hash, $options= '', $arr=null)

photo_upload_begin Called when attempting to upload a photo.

photo_upload_file Called to generate alternate filenames for an upload.

  • string src - return value, default empty
  • string filename - return value, default empty
  • number filesize - return value, default 0
  • string type - return value, default empty

attach_upload_file Called when uploading a file.

  • string src - return value, default empty
  • string filename - return value, default empty
  • number filesize - return value, default 0
  • string type - return value, default empty

photo_upload_end Called when a photo upload has been processed.

photo_upload_end Called when a photo upload has been processed.

photo_upload_end Called when a photo upload has been processed.

photo_upload_end Called when a photo upload has been processed.

photo_upload_end Called when a photo upload has been processed. This would've been called already with a success result in photos_upload() if it was a photo.

Member bb_to_markdown ($Text, $options=[])

bb_to_markdown_bb

  • string bbcode - The message as bbcode and what will get returned
  • array options

bb_to_markdown

  • string - The already converted message as bbcode and what will get returned
Member can_comment_on_post ($observer_xchan, $item)
can_comment_on_post Called when deciding whether or not to present a comment box for a post.
  • string observer_hash
  • array item
  • boolean allowed - return value
Member channel_remove ($channel_id, $local=true, $unset_session=false)
channel_remove Called when removing a channel.
  • array with entry from channel tabel for $channel_id
Member check_channelallowed ($hash)
check_channelallowed Used to over-ride or bypass the channel black/white block lists.
  • string hash
  • boolean allowed - optional return value set in hook
Member check_location_move ($sender_hash, $locations)
location_move Called when a new location has been provided to a UNO channel (indicating a move rather than a clone).
  • array channel
  • array locations
Member check_siteallowed ($url)
check_siteallowed Used to over-ride or bypass the site black/white block lists.
  • string url
  • boolean allowed - optional return value set in hook
Member construct_page ()
construct_page General purpose hook to provide content to certain page regions. Called when constructing the Comanche page.
  • string module
  • string layout
Member create_identity ($arr)

create_channel_photo

  • array account
  • array channel
  • string photo_url - Return value

create_identity Called when creating a channel.

  • int - The UID of the created identity
Member delivery_report_is_storable ($dr)
dreport_is_storable Called before storing a dreport record to determine whether to store it.
  • array
Member discover_by_webbie ($webbie, $protocol= '')
discover_channel_webfinger Called when performing a webfinger lookup.
  • string address - The webbie
  • string protocol
  • array webfinger - The result from webfinger_rfc7033()
  • boolean success - The return value, default false
Member drop_item ($id, $interactive=true, $stage=DROPITEM_NORMAL, $force=false)
drop_item Called when an 'item' is removed.
Member event_store_event ($arr)
event_store_event Called when an event record is created or updated.
  • array event
  • array existing_event
  • boolean cancel - default false
Member event_store_item ($arr, $event)

event_updated Called when an event record is modified.

event_created Called when an event record is created.

Member get_atom_elements ($feed, $item, &$author)
parse_atom
  • SimplePie feed - The original SimplePie feed
  • array item
  • array author
  • array result - the result array that will also get returned
Member get_default_export_sections ()
get_default_export_sections Called to get the default list of functional data groups to export in identity_basic_export().
  • array sections - return value
Member get_feed_for ($channel, $observer_hash, $params)

atom_feed_top

  • string xml - the generated feed and what will get returned from the hook
  • array channel
  • string observer_hash
  • array params

atom_feed A much simpler interface than atom_feed_top.

  • string - the feed after atom_feed_top hook

atom_feed_end string - The created XML feed as a string without closing tag

Member identity_basic_export ($channel_id, $sections=null)
identity_basic_export Called when exporting a channel's basic information for backup or transfer.
  • number channel_id - The channel ID
  • array sections
  • array data - The data will get returned
Member import_author_unknown ($x)
import_author
  • array author
  • boolean|string result - Return value, default false
Member import_author_xchan ($x)
import_author_xchan Called when looking up an author of a post by xchan_hash to ensure they have an xchan record on our site.
  • array xchan
  • string xchan_hash - Thre returned value
Member import_directory_profile ($hash, $profile, $addr, $ud_flags=UPDATE_FLAGS_UPDATED, $suppress_update=0)
import_directory_profile Called when processing delivery of a profile structure from an external source (usually for directory storage).
  • array xprof
  • array profile
  • boolean update
Member import_xchan ($arr, $ud_flags=UPDATE_FLAGS_UPDATED, $ud_arr=null)
import_xchan Called when processing the result of zot_finger() to store the result
  • array
Member item_store ($arr, $allow_exec=false, $deliver=true)

item_store Called when item_store() stores a record of type item.

  • array item
  • boolean allow_exec

item_translate Called from item_store and item_store_update after the post language has been autodetected.

  • array item
  • string from
  • string to
  • boolean translated

item_store Called when item_store() stores a record of type item.

post_remote Called when an activity arrives from another site. This hook remains for backward compatibility.

post_remote_end Called after processing a remote post.

Member item_store_update ($arr, $allow_exec=false, $deliver=true)

item_store_update Called when item_store_update() is called to update a stored item. It overwrites the function's parameters $arr and $allow_exec.

  • array item
  • boolean allow_exec

item_translate Called from item_store() and item_store_update() after the post language has been autodetected.

  • array item - returned value
  • string from
  • string to
  • boolean translated - default false, set true if hook translated it and provide it in item

post_remote_update Called when processing a remote post that involved an edit or update.

post_remote_update_end Called after processing a remote post that involved an edit or update.

Member load_pdl ()
load_pdl Called when we load a PDL file or description.
  • string module
  • string layout
Member login ($register=false, $form_id= 'main-login', $hiddens=false, $login_page=true)
login_hook Called when generating the login form.
  • string with parsed HTML
Member mail_store ($arr)

post_mail Called when a mail message has been composed.

post_mail_end Called when a mail message has been delivered.

Member markdown_to_bb ($s, $use_zrl=false, $options=[])

markdown_to_bb_init

  • string text - The message as Markdown and what will get returned
  • boolean zrl
  • array options

markdown_to_bb

  • string - The already converted message as bbcode
Member network_to_name ($s)
network_to_name
Member owt_init ($token)
magic_auth_success Called when a magic-auth was successful.
  • array xchan
  • string url
  • array session
Member photo_upload ($channel, $observer, $args)

photo_upload_end Called when a photo upload has been processed.

photo_post_end Called after uploading a photo.

photo_post_end Called after uploading a photo.

photo_upload_end Called when a photo upload has been processed.

photo_upload_end Called when a photo upload has been processed.

photo_upload_end Called when a photo upload has been processed.

Member post_activity_item ($arr, $allow_code=false, $deliver=true)

post_local Called when an item has been posted on this machine via mod/item.php (also via API).

post_local_end Called after a local post operation has completed.

Member proc_run ()
proc_run Called when invoking PHP sub processes.
  • array args
  • boolean run_cmd
Member process_channel_sync_delivery ($sender, $arr, $deliveries)
process_channel_sync_delivery Called when accepting delivery of a 'sync packet' containing structure and table updates from a channel clone.
  • array channel
  • array data
Member process_delivery ($sender, $arr, $deliveries, $relay, $public=false, $request=false)

post_local Called when an item has been posted on this machine via mod/item.php (also via API).

  • array with an item

activity_received Called when an activity (post, comment, like, etc.) has been received from a zot source.

  • int item_id
  • array item
  • array sender
  • array channel
Member profile_sidebar ($profile, $block=0, $show_connect=true, $zcard=false)

profile_sidebar_enter Called before generating the 'channel sidebar' or mini-profile.

profile_sidebar Called when generating the 'channel sidebar' or mini-profile.

  • array profile
  • string entry - The parsed HTML template
Member service_plink ($contact, $guid)
service_plink
  • array xchan
  • string guid
  • string url
  • string plink will get returned
Member sys_boot ()
init_1
Member tag_deliver ($uid, $item_id)
tagged Called when a delivery is processed which results in you being tagged.
  • number channel_id
  • array item
  • string body
Member validate_channelname ($name)
validate_channelname Used to validate the names used by a channel.
  • string name
  • string message - return error message
Member z_mail ($params)
email_send
Member zid ($s, $address= '')
zid Called when adding the observer's zid to a URL.
  • string url - url to accept zid
  • string zid - urlencoded zid
  • string result - the return string we calculated, change it if you want to return something else
Member zid_init ()
zid_init
  • string zid - their zid
  • string url - the destination url
Member zot_best_algorithm ($methods)
zot_best_algorithm Called when negotiating crypto algorithms with remote sites.
  • string methods - comma separated list of encryption methods
  • string result - the algorithm to return
Member zotinfo ($arr)

channel_protocols

  • int channel_id
  • array protocols

zot_finger Called when a zot-info packet has been requested (this is our webfinger discovery mechanism).

  • array The final return array
Member Zotlabs::role_perms ($role)
get_role_perms
  • array
Member Zotlabs::BlockedAnonPerms ()
write_perms
  • array permissions
Member Zotlabs::Perms ($filter= '')
permissions_list
  • array permissions
  • string filter
Member Zotlabs::run ($argc, $argv)
thumbnail
  • array attach
  • int preview_style
  • int preview_width
  • int preview_height
  • string thumbnail
Member Zotlabs::message ($uid, $room_id, $xchan, $text)
chat_message Called to create a chat message.
  • int chat_room
  • string chat_xchan
  • string chat_text
Member Zotlabs::__construct (&$a)
module_loaded Called when a module has been successfully locate to server a URL request. This provides a place for plugins to register module handlers which don't otherwise exist on the system, or to completely over-ride an existing module. If the plugin sets 'installed' to true we won't throw a 404 error for the specified module even if there is no specific module file or matching plugin name. The plugin should catch at least one of the module hooks for this URL.
  • string module
  • boolean installed
  • mixed controller - The initialized module object