Skip to main content

Plugin Key Types

There are seven types of plugin keys that you should be aware of:

Thread

Store data related to a specific thread. Whenever the thread is displayed on the screen, the plugin key data will be available to access.

Post

Posts are the messages inside of thread. Post keys store data related to a specific post.

Conversation

Stores data related to a specific conversation. A conversation is like a thread, except between only specific people.

Message

A message is the individual message inside of a conversation, similar to how posts are inside of threads.

Private User

This key will store data related to a user on the forum. The key data is only accessible by the user themselves. Use this key to store a member's preferences, since the data stored in the key only applies to this user and not anyone else.

Super User

A super user is a special type of plugin key. Unlike a private user key (which stores data that only the current logged in user has access to), a super user key can store that is accessible by everyone on the forum. Whenever a user is displayed on the screen, their plugin key data will be available to access.

Super Forum

A super forum is the only key that is loaded on every page, and is therefore suitable for storing information globally across your forum.