Custom Logging Service

説明

This plugin is derived from the no longer supported
WordPress Logging Service.
Despite that it is not compatiple with it, and there is no upgrade path from one
to the other.

機能について

• No log entries generated by the plugin itself, all come from external API calls
• Organisation of log entries in freetext categories
• Severity levels
• Freetext log messages
• Entries can be marked as seen and then filtered from being displayed again
• Filtering by minimum severity level
• Sort by date, category, user name, severity or blog name (in Multisite installations)
• Access to the log page can be granted by user role

API

定数

Check to test if the plugin is active:

CLGS = true

Defined severity levels:

CLGS_NOSEVERITY = 0
CLGS_INFO = 1
CLGS_NOTICE = 2
CLGS_WARNING = 3
CLGS_ERROR = 4
CLGS_FATALERROR = 5

Functions

clgs_is_registered ( $category )

• string $category

returns true if $category is registered.

clgs_register ( $category, $description )

registers $category as a log category. $description will be shown in the
management page.
It is good practice to use unique categories for each plugin that publishes
log messages.

• string $category At most 190 (unicode) characters
• string $description can contain HTML same as comments (filtered by
  wp_kses_data)

returns false if the category is already registered or it is too long.

clgs_clear ( $category )

deletes all log entries of $category.

• string $description existing category

returns number of deleted entries or false if action failed.

clgs_unregister( $category );

deletes all log entries and then removes $category.

• string $description existing category

returns false if false if action failed.

clgs_log( $category, $text, $severity = null, $user = null, $blog_id = null, $date = null );

writes a new log entry in the specified category

• string $description a registered category name
• string $text the logged message, can contain HTML same as comments (filtered
  by wp_kses_data)
• int $severity one of defined severity levels (see above); if missing defaults to
  CLGS_NOCATEGORY
• int | string | WP_User $user user id, slug or WP user object are aceptable; if missing
  defaults to current user (or a placeholder if none is logged in)
• int $blog_id blog id; if missing defaults to current blog
• int | double | string $date a UNIX timestamp or a string recognized by strtotime();
  if missing defaults to current time

returns false if entering the log failed.