Plugin API » Interfaces » Plugin » Auditing

Plugin auditing control

Plugins can write their own audit trail entries, and control which optional events are audited. See Audit trail and the hAuditEntryOptionalWrite hook.

Interface

function declareAuditEntryOptionalWritePolicy(policy)

If you implement the hAuditEntryOptionalWrite hook, you should call this function to declare the policy you are implementing. It will be shown on the audit configuration page in System Management.

The policy can be a String, or a function. If the latter, the function will be called every time the policy is displayed, with this set to your Plugin object.

P.declareAuditEntryOptionalWritePolicy(
    "Auditing policy description."
);