diff --git a/includes/callback_user_status.inc b/includes/callback_user_status.inc index d8f664d..541f1b2 100644 --- a/includes/callback_user_status.inc +++ b/includes/callback_user_status.inc @@ -6,27 +6,19 @@ */ /** - * Data alteration that filters out users with blocked accounts. + * Filters out blocked user accounts. */ class SearchApiAlterUserStatus extends SearchApiAbstractAlterCallback { /** - * Overrides SearchApiAbstractAlterCallback::supportsIndex(). - * - * This plugin only supports indexes containing users. + * {@inheritdoc} */ public function supportsIndex(SearchApiIndex $index) { return $index->getEntityType() == 'user'; } /** - * Alter items before indexing. - * - * Items which are removed from the array won't be indexed, but will be marked - * as clean for future indexing. - * - * @param array $items - * An array of items to be altered, keyed by item IDs. + * {@inheritdoc} */ public function alterItems(array &$items) { foreach ($items as $id => $account) { @@ -37,4 +29,3 @@ class SearchApiAlterUserStatus extends SearchApiAbstractAlterCallback { } } - diff --git a/search_api.module b/search_api.module index 8648b79..f87ced8 100644 --- a/search_api.module +++ b/search_api.module @@ -1070,7 +1070,7 @@ function search_api_search_api_alter_callback_info() { ); $callbacks['search_api_alter_user_status'] = array( 'name' => t('Exclude blocked users'), - 'description' => t('Exclude blocked users from the index.'), + 'description' => t('Exclude blocked users from the index. Caution: This only affects the indexed users themselves. If an active user account includes a reference to a disabled user, that reference will still be indexed (or displayed) normally.'), 'class' => 'SearchApiAlterUserStatus', );