Inbox en live overname hooks

Deze pagina toont de 13 hooks van deze groep. Elke hook laat zijn type zien, de versie waarin hij verscheen, waar hij draait, zijn argumenten en een beginpunt.

• addochat_addofy_notifications
• addochat_agent_replied
• addochat_agent_roles
• addochat_agents_online
• addochat_can_edit_message
• addochat_conversation_claimed
• addochat_conversation_closed
• addochat_delivery
• addochat_is_open
• addochat_message_edited
• addochat_opening_hours
• addochat_ref_link
• addochat_single_view_url

addochat_addofy_notifications

FilterSinds 0.1.0 Draait in src/Inbox/Screen.php.

Filtert of de meldingen van Addofy de bureaubladmeldingen van de inbox vervangen.

Argument	Type	Beschrijving
$addofy	bool	Standaard: adba_alerts_browser() voor de huidige gebruiker (Addofy 2.36.0 en later), anders of Addofy draait met zijn meldingen-API.

add_filter( 'addochat_addofy_notifications', function ( $addofy ) {
	return $addofy;
} );

addochat_agent_replied

ActionSinds 0.1.0 Draait in src/Inbox/Actions.php.

Gaat af nadat een collega heeft geantwoord.

Argument	Type	Beschrijving
$conversation	array<string, mixed>	Rij van het gesprek.
$message_id	int	Id van het bericht.
$user_id	int	Collega.

add_action( 'addochat_agent_replied', function ( $conversation, $message_id, $user_id ) {
	// ...
}, 10, 3 );

addochat_agent_roles

FilterSinds 0.1.0 Draait in src/Inbox/Agents.php.

Filtert de rollen die chats mogen beantwoorden. Wordt toegepast bij activeren, bij elke update en bij het opslaan van de instellingen; een rol die niet in de lijst staat, verliest het recht.

Argument	Type	Beschrijving
$roles	string[]	Rolnamen, uit de instelling "Rollen die chats beantwoorden".

add_filter( 'addochat_agent_roles', function ( $roles ) {
	return $roles;
} );

addochat_agents_online

FilterSinds 0.1.0 Draait in src/Inbox/Agents.php.

Filtert of er voor bezoekers een collega online is (bijvoorbeeld openingstijden of een gedeelde telefoonlijn).

Argument	Type	Beschrijving
$online	bool	Of er een collega online is.

add_filter( 'addochat_agents_online', function ( $online ) {
	return $online;
} );

addochat_can_edit_message

FilterSinds 0.2.0 Draait in src/Inbox/Actions.php.

Bepaalt of een collega een bericht in de inbox mag bewerken.

Argument	Type	Beschrijving
$allowed	bool	Eigen antwoord, of elk collega-antwoord voor een beheerder.
$message	array<string, mixed>	Bericht.
$user_id	int	Collega.

add_filter( 'addochat_can_edit_message', function ( $allowed, $message, $user_id ) {
	return $allowed;
}, 10, 3 );

addochat_conversation_claimed

ActionSinds 0.1.0 Draait in src/Inbox/Actions.php.

Gaat af nadat een collega een gesprek heeft overgenomen.

Argument	Type	Beschrijving
$conversation	array<string, mixed>	Rij van het gesprek (voor de wijziging).
$user_id	int	Collega.

add_action( 'addochat_conversation_claimed', function ( $conversation, $user_id ) {
	// ...
}, 10, 2 );

addochat_conversation_closed

ActionSinds 0.1.0 Draait in src/Inbox/Actions.php.

Gaat af nadat een gesprek is gesloten.

Argument	Type	Beschrijving
$conversation	array<string, mixed>	Rij van het gesprek (voor de wijziging).
$user_id	int	Collega.

add_action( 'addochat_conversation_closed', function ( $conversation, $user_id ) {
	// ...
}, 10, 2 );

addochat_delivery

FilterSinds 0.1.0 Draait in src/Inbox/Actions.php.

Filtert hoe een bericht uit de inbox het gesprek bereikt. Geef een subklasse van \Addochat\Inbox\Delivery terug, bijvoorbeeld om het door te sturen naar een andere site.

Argument	Type	Beschrijving
$delivery	\Addochat\Inbox\Delivery	Bezorging.
$conversation	array<string, mixed>	Rij van het gesprek.

add_filter( 'addochat_delivery', function ( $delivery, $conversation ) {
	return $delivery;
}, 10, 2 );

addochat_is_open

FilterSinds 0.1.0 Draait in src/Inbox/Hours.php.

Filtert of de live chat op een moment open is. Bij false krijgen bezoekers meteen het e-mailformulier.

Argument	Type	Beschrijving
$open	bool	Of het open is.
$now	\DateTimeImmutable	Het moment, in de tijdzone van WordPress.
$settings	array<string, mixed>	Effectieve instellingen van de site.

add_filter( 'addochat_is_open', function ( $open, $now, $settings ) {
	return $open;
}, 10, 3 );

addochat_message_edited

ActionSinds 0.2.0 Draait in src/Inbox/Actions.php.

Gaat af nadat een collega de tekst van een bericht heeft aangepast.

Argument	Type	Beschrijving
$conversation	array<string, mixed>	Rij van het gesprek.
$message_id	int	Id van het bericht.
$old	string	Tekst ervoor.
$text	string	Tekst nu.
$user_id	int	Collega.

add_action( 'addochat_message_edited', function ( $conversation, $message_id, $old, $text, $user_id ) {
	// ...
}, 10, 5 );

addochat_opening_hours

FilterSinds 0.1.0 Draait in src/Inbox/Hours.php.

Filtert de openingstijden van de live chat, bijvoorbeeld om ze uit een eigen rooster te halen.

Argument	Type	Beschrijving
$schedule	array<string, mixed>	days: 1 (maandag) tot 7 => [begin, eind] in minuten na middernacht, of null als het die dag dicht is; closed: datums (Y-m-d); set: false als er geen dag is ingevuld (altijd open).
$settings	array<string, mixed>	Effectieve instellingen van de site.

add_filter( 'addochat_opening_hours', function ( $schedule, $settings ) {
	return $schedule;
}, 10, 2 );

addochat_ref_link

FilterSinds 0.2.0 Draait in src/Inbox/Links.php.

Bepaalt een link in de inbox naar iets wat een gesprek gebruikte: pas het label, de detailregel of het adres aan (bijvoorbeeld naar een ander beheerscherm), of geef null terug om hem weg te laten.

Argument	Type	Beschrijving
$link	array{label: string, detail: string, url: string}|null	Link, null als het object weg is.
$type	string	order, product, customer of page.
$id	int	Id.

add_filter( 'addochat_ref_link', function ( $link, $type, $id ) {
	return $link;
}, 10, 3 );

addochat_single_view_url

FilterSinds 0.2.0 Draait in src/Inbox/Screen.php.

Bepaalt het adres van het losse venster met een gesprek. De inbox zet er "#<uuid>" achter.

Argument	Type	Beschrijving
$url	string	Adres zonder het gesprek.

add_filter( 'addochat_single_view_url', function ( $url ) {
	return $url;
} );