Guild

Guilds are part of discord. Guilds are known as 'Discord Servers' in the Discord application.

A Guild is Discord's equivalent of a server. It contains all the Members, Channels, Roles, Bans etc.

Methods

createdTimestamp()

createRole()

function createRole(array $data): Promise(Role)

Creates a role in the guild with a given array of attributes. Returns the created role in a promise.

getAuditLog()

getInvites()

function getInvites(): Promise(Collection[Invite])

Retrieves a list of invites in the guild. Returns a collection of invites in a promise.

getVoiceRegions()

function getVoiceRegions(): Promise(Collection[object])

Retrieves a list of valid voice regions. Returns a collection of objects describing voice regions in a promise.

transferOwnership()

function transferOwnership(Member|snowflake $member): Promise

Transfers the ownership of the guild to another member. The bot must be the owner of the guild. Returns a promise with no data.

unban()

function unban(User|string $user)

Unbans a member. Alias for $guild->bans->unban($user)

updateRolePositions()

Repositories

• BanRepository $guild->bans
• ChannelRepository $guild->channels
• EmojiRepository $guild->emojis
• InviteRepository $guild->invites
• MemberRepository $guild->members
• RoleRepository $guild->roles

Events

Requires GUILD intent

GUILD_CREATE

GUILD_DELETE

GUILD_UPDATE

---

Get a Specific Guild

Your BOT must be member of the guild

Change 123123123123123123 below with the Guild ID you want to retrieve

Cached, synchronous:

$guild = $discord->guilds->get('id', '123123123123123123');

If the code above returns null (which most likely won't since guilds are always cached), you may need to fetch it first (Promise, asynchronous):

$discord->guilds->fetch('123123123123123123')->done(function (Guild $guild) {
    // ...
});