simplenews.api.php in Simplenews 3.x

Hooks provided by the Simplenews module.

File

simplenews.api.php

<?php

/**
 * @file
 * Hooks provided by the Simplenews module.
 */
use Drupal\simplenews\Entity\Newsletter;
use Drupal\simplenews\Entity\Subscriber;
use Drupal\simplenews\Spool\SpoolStorageInterface;
use Drupal\simplenews\SubscriberInterface;

/**
 * Simplenews builds on the following basic concepts.
 *
 * @link subscriber Subscribers @endlink subscribe to @link newsletter
 * newsletters (categories) @endlink. That connection is called
 * a @link subscription subscription @endlink. Nodes of enabled content types
 * are @link issue newsletter issues @endlink. These are then sent to the
 * subscribers of the newsletter the issue is attached to.
 *
 * Sending is done by first adding a row for each subscriber to the @link spool
 * mail spool @endlink.
 * Then they are processed either immediatly or during cron runs. The actual
 * sending happens through a @link source source instance @endlink, which is
 * first instanciated based on the mail spool and then used to generated the
 * actual mail content.
 *
 * @mainpage Simplenews API documentation.
 */

/**
 * @defgroup subscriber Subscriber
 *
 * @todo
 */

/**
 * @defgroup newsletter (category)
 *
 * @todo
 */

/**
 * @defgroup subscription Subscription
 *
 * @todo
 */

/**
 * @defgroup issue Newsletter issue
 *
 * @todo
 */

/**
 * @defgroup spool Mail spool
 *
 * @todo
 */

/**
 * @defgroup source Source
 *
 * @todo
 */

/**
 * Return operations to be applied to newsletter issues.
 *
 * @ingroup issue
 */
function hook_simplenews_issue_operations() {
  $operations = [
    'activate' => [
      'label' => t('Send'),
      'callback' => 'simplenews_issue_send',
    ],
  ];
  return $operations;
}

/**
 * Return operations to be applied to subscriptions.
 *
 * @ingroup issue
 */
function hook_simplenews_subscription_operations() {
  $operations = [
    'activate' => [
      'label' => t('Activate'),
      'callback' => 'simplenews_subscription_activate',
      'callback arguments' => [
        SubscriberInterface::ACTIVE,
      ],
    ],
    'inactivate' => [
      'label' => t('Inactivate'),
      'callback' => 'simplenews_subscription_activate',
      'callback arguments' => [
        SubscriberInterface::INACTIVE,
      ],
    ],
    'delete' => [
      'label' => t('Delete'),
      'callback' => 'simplenews_subscription_delete_multiple',
    ],
  ];
  return $operations;
}

/**
 * Act after a newsletter category has been saved.
 *
 * @param \Drupal\simplenews\Entity\Newsletter $newsletter
 *   The newsletter object.
 *
 * @ingroup newsletter
 */
function hook_simplenews_newsletter_update(Newsletter $newsletter) {
}

/**
 * Act after a newsletter category has been deleted.
 *
 * @param \Drupal\simplenews\Entity\Newsletter $newsletter
 *   The newsletter object.
 *
 * @ingroup newsletter
 */
function hook_simplenews_newsletter_delete(Newsletter $newsletter) {
}

/**
 * Act after a newsletter category has been inserted.
 *
 * @param \Drupal\simplenews\Entity\Newsletter $newsletter
 *   The newsletter object.
 *
 * @ingroup newsletter
 */
function hook_simplenews_newsletter_insert(Newsletter $newsletter) {
}

/**
 * Act after a subscriber is updated.
 *
 * @param \Drupal\simplenews\Entity\Subscriber $subscriber
 *   The subscriber object including all subscriptions of this user.
 *
 * @ingroup subscriber
 */
function hook_simplenews_subscriber_update(Subscriber $subscriber) {
}

/**
 * Act after a new subscriber has been created.
 *
 * @param \Drupal\simplenews\Entity\Subscriber $subscriber
 *   The subscriber object including all subscriptions of this user.
 *
 * @ingroup subscriber
 */
function hook_simplenews_subscriber_insert(Subscriber $subscriber) {
}

/**
 * Act after a subscriber has been deleted.
 *
 * @param \Drupal\simplenews\Entity\Subscriber $subscriber
 *   The subscriber object including all subscriptions of this user.
 *
 * @ingroup subscriber
 */
function hook_simplenews_subscriber_delete(Subscriber $subscriber) {
}

/**
 * Invoked if a subscriber is subscribed to a newsletter.
 *
 * @param \Drupal\simplenews\Entity\Subscriber $subscriber
 *   The subscriber object including all subscriptions of this user.
 * @param string $subscription
 *   The subscription object for this specific subscribe action.
 *
 * @ingroup subscriber
 */
function hook_simplenews_subscribe_user(Subscriber $subscriber, $subscription) {
}

/**
 * Invoked if a subscriber is unsubscribed from a newsletter.
 *
 * @param \Drupal\simplenews\Entity\Subscriber $subscriber
 *   The subscriber object including all subscriptions of this user.
 * @param string $subscription
 *   The subscription object for this specific unsubscribe action.
 *
 * @ingroup subscriber
 */
function hook_simplenews_unsubscribe(Subscriber $subscriber, $subscription) {
}

/**
 * Expose SimplenewsSource cache implementations.
 *
 * @return array
 *   An array keyed by the name of the class that provides the implementation,
 *   the array value consists of another array with the keys label and
 *   description.
 *
 * @ingroup source
 */
function hook_simplenews_source_cache_info() {
  return [
    'SimplenewsSourceCacheNone' => [
      'label' => t('No caching'),
      'description' => t('This allows to theme each newsletter separately.'),
    ],
    'SimplenewsSourceCacheBuild' => [
      'label' => t('Cached content source'),
      'description' => t('This caches the rendered content to be sent for multiple recipients. It is not possible to use subscriber specific theming but tokens can be used for personalization.'),
    ],
  ];
}

/**
 * Invoked after sending of every mail to allow altering of the result.
 *
 * A common use of this hook is categorise errors and distinguish a global
 * failure from an error that is specific to a single recipient.
 *
 * @param int $result
 *   One of the SpoolStorageInterface::STATUS_* constants.
 * @param array $message
 *   The message returned by \Drupal\Core\Mail\MailManagerInterface::mail().
 */
function hook_simplenews_mail_result_alter(&$result, array $message) {
  if (specific_error()) {
    $result = SpoolStorageInterface::STATUS_FAILED;
  }
  if (global_error()) {
    throw new AbortSendingException('Mail transport error');
  }
}

Functions

Name	Description
hook_simplenews_issue_operations	Return operations to be applied to newsletter issues.
hook_simplenews_mail_result_alter	Invoked after sending of every mail to allow altering of the result.
hook_simplenews_newsletter_delete	Act after a newsletter category has been deleted.
hook_simplenews_newsletter_insert	Act after a newsletter category has been inserted.
hook_simplenews_newsletter_update	Act after a newsletter category has been saved.
hook_simplenews_source_cache_info	Expose SimplenewsSource cache implementations.
hook_simplenews_subscriber_delete	Act after a subscriber has been deleted.
hook_simplenews_subscriber_insert	Act after a new subscriber has been created.
hook_simplenews_subscriber_update	Act after a subscriber is updated.
hook_simplenews_subscribe_user	Invoked if a subscriber is subscribed to a newsletter.
hook_simplenews_subscription_operations	Return operations to be applied to subscriptions.
hook_simplenews_unsubscribe	Invoked if a subscriber is unsubscribed from a newsletter.