You are here

function hook_message_subscribe_get_subscribers_alter in Message Subscribe 8

Same name and namespace in other branches
  1. 7 message_subscribe.api.php \hook_message_subscribe_get_subscribers_alter()

Alter the subscribers list.

Parameters

\Drupal\message_subscribe\Subscribers\DeliveryCandidateInterface[] &$uids: The array of delivery candidates as defined by `hook_message_subscribe_get_subscribers()`.

array $values: A keyed array of values containing:

  • 'context' - The context array.
  • 'entity_type' - The entity type ID.
  • 'entity' - The entity object
  • 'subscribe_options' - The subscribe options array.
3 functions implement hook_message_subscribe_get_subscribers_alter()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

message_subscribe_email_message_subscribe_get_subscribers_alter in message_subscribe_email/message_subscribe_email.module
Implements hook_message_subscribe_get_subscribers_alter().
message_subscribe_example_message_subscribe_get_subscribers_alter in message_subscribe_example/message_subscribe_example.module
Implements hook_message_subscribe_get_subscribers_alter().
message_subscribe_test_message_subscribe_get_subscribers_alter in tests/modules/message_subscribe_test/message_subscribe_test.module
Implements hook_message_subscribe_test_message_subscribe_get_subscribers_alter().
1 invocation of hook_message_subscribe_get_subscribers_alter()
Subscribers::getSubscribers in src/Subscribers.php
Retrieve a list of subscribers for a given entity.

File

./message_subscribe.api.php, line 53
Hooks provided by the Message subscribe module.

Code

function hook_message_subscribe_get_subscribers_alter(array &$uids, array $values) {
}