ClearByTag
CUserCounter::ClearByTag( tag, code, site_id = SITE_ID, sendPull = true );
The method deletes counters by tag. Static method.
Parameters
Parameter | Description | Available from version |
---|---|---|
tag | Tag used to delete counters. | 11.5.6 |
code | Deleted counter code. | 11.5.6 |
site_id | Optional. Equals SITE_ID by default. | 11.5.6 |
sendPull | Optional. Specifies to immediately send data into the Push&Pull module for "real time counters" (sending is available when module is installed and "Queue server" is activated. Without queue server, the method works from the Push&Pull module version 12.5.4) If this counter must not be thrown, specify false.True by default. | 12.5.8 |
Returned value
Returns true on success and false otherwise.
Example
CUserCounter:: ClearByTag("task_11", "task");
© «Bitrix24», 2001-2024