Documentation du code de SPIP et de ses plugins

SPIP

Notifications

Table of Contents

Functions

inc_notifications_dist()  : mixed
La fonction de notification de base, qui dispatche le travail
notifications_nettoyer_emails()  : mixed
Néttoyage des emails avant un envoi
notifications_envoyer_mails()  : mixed
Envoyer un email de notification
email_notification_objet()  : string
Notifier un événement sur un objet
email_notification_article()  : string
Notifier un événement sur un article

Functions

inc_notifications_dist()

La fonction de notification de base, qui dispatche le travail

inc_notifications_dist(string $quoi[, int $id = 0 ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$quoi : string

Événement de notification

$id : int = 0

id de l'objet en relation avec l'événement

$options : array<string|int, mixed> = []

Options de notification, interprétées en fonction de la notification

notifications_nettoyer_emails()

Néttoyage des emails avant un envoi

notifications_nettoyer_emails(array<string|int, mixed> &$emails[, array<string|int, mixed> $exclure = [] ]) : mixed

On passe par référence pour la perf

les emails liste par $exclure seront exclus de la liste

Parameters
$emails : array<string|int, mixed>
$exclure : array<string|int, mixed> = []

notifications_envoyer_mails()

Envoyer un email de notification

notifications_envoyer_mails(array<string|int, mixed>|string $emails, string $texte[, string $sujet = '' ][, string $from = '' ][, string $headers = '' ]) : mixed

Le sujet peut être vide, dans ce cas il reprendra la première ligne non vide du texte

Parameters
$emails : array<string|int, mixed>|string
$texte : string
$sujet : string = ''
$from : string = ''
$headers : string = ''

email_notification_objet()

Notifier un événement sur un objet

email_notification_objet(int $id_objet, string $type_objet, string $modele) : string

Récupère le fond désigné dans $modele, prend la première ligne comme sujet et l'interprète pour envoyer l'email

Parameters
$id_objet : int
$type_objet : string
$modele : string
Return values
string

email_notification_article()

Notifier un événement sur un article

email_notification_article(int $id_article, string $modele) : string

Récupère le fond désigné dans $modele, prend la première ligne comme sujet et l'interprète pour envoyer l'email

Parameters
$id_article : int
$modele : string
Return values
string

        
On this page

Search results