Function Module_admin_newsletter->_count_on_newsletter

Definitions

adminzone/pages/modules/admin_newsletter.php

  • Count the number of users on a certain newsletter and language of the newsletter.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: int

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$key string No No required parameter N/A N/A The newsletter identifier (as expected in $send_details parameter of newsletter_who_send_to)
$lang ID_TEXT No No required parameter N/A N/A The language

Returns

  • The count
  • Type: integer
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Count the number of users on a certain newsletter and language of the newsletter.
 *
 * @param  string $key The newsletter identifier (as expected in $send_details parameter of newsletter_who_send_to)
 * @param  ID_TEXT $lang The language
 * @return integer The count
 */
public function _count_on_newsletter(string $key, string $lang) : int