https://github.com/marcio1002/discord-webhook-sdk-php
This sdk provides a simple way to send messages by webhooks in discord
https://github.com/marcio1002/discord-webhook-sdk-php
discord discord-php webhooks
Last synced: 5 months ago
JSON representation
This sdk provides a simple way to send messages by webhooks in discord
- Host: GitHub
- URL: https://github.com/marcio1002/discord-webhook-sdk-php
- Owner: marcio1002
- License: other
- Created: 2022-05-03T12:37:56.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-06T00:05:28.000Z (over 3 years ago)
- Last Synced: 2024-03-22T22:02:25.880Z (about 2 years ago)
- Topics: discord, discord-php, webhooks
- Language: PHP
- Homepage: https://packagist.org/packages/marcio1002/discord-webhook-sdk-php
- Size: 234 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
# Discord Webhook PHP
---
## installation
```
composer require marcio1002/discord-webhook-sdk-php
```
## Constructor parameter options
Pass an array of options to the constructor, note that the webhook url is required.
| param | type | description | Required |
| ----------- | ------- | --------------------------------------------------------------------------------------------------------------------------------- | -------- |
| webhook_id | string | The webhook ID | Yes |
| token | string | The webhook token | Yes
| tts | boolean | If true read message to channel members | No |
| thread_id | string | Name of thread to create (requires the webhook channel to be a forum channel) | No |
## Sending simple message
```php
use Marcio1002\DiscordWebhook\DiscordWebhook;
$webhook = new DiscordWebhook([
'webhook_id' => '12345686',
'token' => 'dghjt4fw3tk7865edfgt67iykmdw45g$Gdeg4C_VGHT43RW',
]);
//Synchronous envio
$webhook->sendMessage('This is a message', true);
//Asynchronous envio
$webhook->sendMessage('This is a message');
```
## Changing the webhook
With the Message class you can change the name, url, define the content and create embeds
```php
use Marcio1002\DiscordWebhook\DiscordWebhook;
use Marcio1002\DiscordWebhook\Message;
$message = new Message();
->setUsername('DC Notification')
->setAvatar('URL');
->setContent('Alert message');
$webhook
->sendMessage($message)
->then(
fn() => print_r('Success!'),
fn(\Throwable $err) => print_r($err->getMessage())
)
```
## Sending embed
```php
use Marcio1002\DiscordWebhook\DiscordWebhook;
use Marcio1002\DiscordWebhook\MessageEmbed;
$message_embed = new MessageEmbed();
$message_embed
->setTitle('Title')
->setDescription('Description');
->setThumbnail('URL')
$discord->sendMessage($message_embed);
$embeds = range(0, 9); // limit 10 embeds
$embeds = array_map(
fn ($n) => (new MessageEmbed)
->setTitle("Title $n"),
->setColor(MessageEmbed::randomColor())
$embeds
);
$webhook->sendMessage($embeds);
```
## Sending facades class
```php
use Marcio1002\DiscordWebhook\Facades\DiscordWebhook;
DiscordWebhook::configure([
'webhook_id' => '12345686',
'token' => 'dghjt4fw3tk7865edfgt67iykmdw45g$Gdeg4C_VGHT43RW',
]);
DiscordWebhook::sendMessage('Message');
```
## Edit, get and delete message
When editing the message you can pass the same parameter that is passed in the **sendMessage** method
```php
DiscordWebhook::configure([
'webhook_id' => '12345686',
'token' => 'dghjt4fw3tk7865edfgt67iykmdw45g$Gdeg4C_VGHT43RW',
]);
DiscordWebhook::editMessage('ID', 'message', true);
DiscordWebhook::getMessage('ID')->then(fn($message) => print_r($message));
DiscordWebhook::deleteMessage('ID', true);
```