WoW API: GetNumGuildMembers

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < GetNumGuildMembers

Returns the number of guild members.

numGuildMembers = GetNumGuildMembers([includeOffline]);

Parameters

Arguments

includeOffline

Boolean - include offline players in the headcount?

Returns

numGuildMembers

Integer - number of people in the guild (online / both online and offline) or 0 if the player is not in a guild.

Example

local numOnline, numTotal = (GetNumGuildMembers()), (GetNumGuildMembers(true));
DEFAULT_CHAT_FRAME:AddMessage(numTotal .. " guild members: " .. numOnline .. " online, " .. (numTotal - numOnline) .. " online.");

Result

Displays the number of people online, offline, and the total headcount of your guild in the default chat frame.

Notes

You may need to call GuildRoster() first in order to obtain correct data. May return wrong values immediately after quitting a guild. Maximum returned value is 500.