DiscordPHP Documentation

Basics

First step is to include the Composer autoload file and import any required classes.

<?php

use Discord\Discord;
use Discord\WebSockets\Intents;
use Discord\WebSockets\Event;

include __DIR__.'/vendor/autoload.php';

The Discord instance can be set up with an array of options. All are optional except for token:

$discord = new Discord([
    'token' => 'Your-Token-Here',
    'intents' => [
        Intents::GUILDS, Intents::GUILD_BANS, // ...
    ],
    // or
    'intents' => 12345,
    // or
    'intents' => Intents::getDefaultIntents() | Intents::GUILD_MEMBERS, // default intents as well as guild members
    'loadAllMembers' => false,
    'storeMessages' => false,
    'retrieveBans' => false,
    'pmChannels' => false,
    'disabledEvents' => [
        Event::MESSAGE_CREATE, Event::MESSAGE_DELETE, // ...
    ],
    'loop' => \React\EventLoop\Factory::create(),
    'logger' => new \Monolog\Logger('New logger'),
    'dnsConfig' => '1.1.1.1',
    'shardId' => 0,
    'shardCount' => 5,
]);

token is your Discord token. Required.

intents can be an array of valid intents or an integer representing the intents. Default is all intents minus any privileged intents. At the moment this means all intents minus GUILD_MEMBERS and GUILD_PRESENCES. To enable these intents you must first enable them in your Discord developer portal.

loadAllMembers is a boolean whether all members should be fetched and stored on bot start. Loading members takes a while to retrieve from Discord and store, so default is false. This requires the GUILD_MEMBERS intent to be enabled in DiscordPHP. See above for more details.

storeMessages is a boolean whether messages received and sent should be stored. Default is false.

retrieveBans is a boolean whether bans should be retrieved on bot load. Default is false.

pmChannels is a boolean whether PM channels should be stored on bot load. Default is false.

disabledEvents is an array of events that will be disabled. By default all events are enabled.

loop is an instance of a ReactPHP event loop that can be provided to the client rather than creating a new loop. Useful if you want to use other React components. By default, a new loop is created.

logger is an instance of a logger that implements LoggerInterface. By default, a new Monolog logger with log level DEBUG is created to print to stdout.

dnsConfig is an instace of Config or a string of name server address. By default system setting is used and fall back to 8.8.8.8 when system configuration is not found. Currently only used for VoiceClient.

The following options should only be used by large bots that require sharding. If you plan to use sharding, read up on how Discord implements it.

shardId is the ID of the bot shard.

shardCount is the number of shards that you are using.

Gateway events should be registered inside the init event, which is emitted once when the bot first starts and has connected to the gateway.

To register an event we use the $discord->on(...) function, which registers a handler. A list of events is available here. They are described in more detail in further sections of the documentation. All events take a callback which is called when the event is triggered, and the callback is called with an object representing the content of the event and an instance of the Discord client.

$discord->on('init', function (Discord $discord) {

    $discord->on(Event::MESSAGE_CREATE, function (Message $message, Discord $discord) {
        // ... handle message sent
    });

});

Finally, the event loop needs to be started. Treat this as an infinite loop.

$discord->run();

If you want to stop the bot you can run:

$discord->close();

If you want to stop the bot without stopping the event loop, the close function takes a boolean:

$discord->close(false);

Search results