DiscordPHP Documentation

Button extends Interactive

in package

• Application

Buttons are interactive components that render in messages.

Tags

link

https://discord.com/developers/docs/interactions/message-components#buttons

since

7.0.0

@property

?int|null $id Optional identifier for component.

@property

?string|null $label Text that appears on the button; max 80 characters.

@property

?array|null $emoji Partial emoji: name, id, and animated.

@property

?string|null $sku_id Identifier for a purchasable SKU, only available when using premium-style buttons.

@property

?string|null $url URL for link-style buttons; max 512 characters.

@property

?bool|null $disabled Whether the button is disabled (defaults to false).

Table of Contents

Constants

STYLE_DANGER  = 4

An action with irreversible consequences.

STYLE_LINK  = 5

Navigates to a URL.

STYLE_PREMIUM  = 6

Purchase.

STYLE_PRIMARY  = 1

The most important or recommended action in a group of options.

STYLE_SECONDARY  = 2

Alternative or supporting actions.

STYLE_SUCCESS  = 3

Positive confirmation or completion actions.

TYPE_ACTION_ROW  = 1

Container to display a row of interactive components.

TYPE_BUTTON  = 2

Button object.

TYPE_CHANNEL_SELECT  = 8

Select menu for channels.

TYPE_CHECKPOINT_CARD  = 20

Undocumented.

TYPE_CONTAINER  = 17

Container that visually groups a set of components.

TYPE_CONTENT_INVENTORY_ENTRY  = 16

Undocumented.

TYPE_FILE  = 13

Displays an attached file.

TYPE_FILE_UPLOAD  = 19

Component for uploading files.

TYPE_LABEL  = 18

Container associating a label and description with a component.

TYPE_MEDIA_GALLERY  = 12

Display images and other media.

TYPE_MENTIONABLE_SELECT  = 7

Select menu for mentionables (users and roles).

TYPE_ROLE_SELECT  = 6

Select menu for roles.

TYPE_SECTION  = 9

Container to display text alongside an accessory component.

TYPE_SELECT_MENU  = 3

TYPE_SEPARATOR  = 14

Component to add vertical padding between other components.

TYPE_STRING_SELECT  = 3

Select menu for picking from defined text options.

TYPE_TEXT_DISPLAY  = 10

Markdown text.

TYPE_TEXT_INPUT  = 4

Text input object.

TYPE_THUMBNAIL  = 11

Small image that can be used as an accessory.

TYPE_USER_SELECT  = 5

Select menu for users.

USAGE  = ['Message']

Properties

$custom_id  : string|null

Custom ID to send with interactive component.

$disabled  : bool|null

Whether the button is disabled.

$discord  : Discord|null

Discord instance when the listener is set.

$emoji  : array<string|int, mixed>|null

Emoji to display on the button.

$id  : int|null

32 bit integer used as an optional identifier for component.

$label  : string|null

Label for the button.

$listener  : callable|null

Listener for when the button is pressed.

$sku_id  : string|null

Identifier for a purchasable SKU, only available when using premium-style buttons.

$style  : int

Style of button.

$type  : int

Component type.

$url  : string|null

URL to send as the button. Only for link buttons.

Methods

__construct()  : mixed

Creates a new button.

__debugInfo()  : array<string|int, mixed>

__get()  : mixed

Handles dynamic get calls onto the part.

__set()  : void

Handles dynamic set calls onto the part.

danger()  : self

Creates a new danger button.

fromPart()  : self

Creates a new instance of the builder from a given Part.

getCustomId()  : string|null

Returns the custom ID of the button.

getEmoji()  : array<string|int, mixed>|null

Returns the emoji display on the button.

getLabel()  : string|null

Returns the label for the button.

getSkuId()  : string|null

Returns the SKU ID for the button. Only for premium buttons.

getStyle()  : int

Returns the style for the button.

getType()  : int

Retrieves the type of the component.

getURL()  : string|null

Returns the URL of the button. Only for link buttons.

isDisabled()  : bool

Returns whether the button is disabled.

jsonSerialize()  : array<string|int, mixed>

link()  : self

Creates a new link button.

new()  : self

Creates a new button.

premium()  : self

Creates a new premium button.

primary()  : self

Creates a new primary button.

removeListener()  : $this

Removes the listener from the button.

secondary()  : self

Creates a new secondary button.

setCustomId()  : $this

Sets the custom ID of the button.

setDisabled()  : $this

Sets the button as disabled/not disabled.

setEmoji()  : $this

Sets the emoji of the button.

setLabel()  : $this

Sets the label of the button.

setListener()  : $this

Sets the callable listener for the button. The `$callback` will be called when the button is pressed.

setSkuId()  : $this

Sets the SKU ID for the button. Only valid for premium buttons.

setStyle()  : $this

Sets the style of the button.

setUrl()  : $this

Sets the URL of the button. Only valid for link buttons.

success()  : self

Creates a new success button.

checkForGetMutator()  : string|false

Checks if there is a get mutator present.

checkForSetMutator()  : string|false

Checks if there is a set mutator present.

createListener()  : callable

Creates a listener.

generateUuid()  : string

Generates a UUID which can be used for component custom IDs.

getId()  : int|null

Retrieves the ID associated with the interactive component.

getProperty()  : mixed

Gets a property on the parent part.

setId()  : self

The id field is optional and is used to identify components in the response from an interaction. The id must be unique within the message and is generated sequentially if left empty. Generation of ids won't use another id that exists in the message if you have one defined for another component. Sending components with an id of 0 is allowed but will be treated as empty and replaced by the API. 32 bit integer used as an optional identifier for component.

setProperty()  : void

Sets an property on the parent part.

studly()  : string

Converts a string to studlyCase.