DiscordPHP Documentation

Section extends Layout

in package

• Application

implements ComponentV2

Section components allow you to define up to 3 text display components and add either a thumbnail or button to the right side.

Tags

link

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

since

10.5.0

Table of Contents

Interfaces

ComponentV2

This interface is a contract for V2 components.

Constants

TYPE_ACTION_ROW  = 1

TYPE_BUTTON  = 2

TYPE_CHANNEL_SELECT  = 8

TYPE_CONTAINER  = 17

TYPE_CONTENT_INVENTORY_ENTRY  = 16

TYPE_FILE  = 13

TYPE_MEDIA_GALLERY  = 12

TYPE_MENTIONABLE_SELECT  = 7

TYPE_ROLE_SELECT  = 6

TYPE_SECTION  = 9

TYPE_SELECT_MENU  = 3

TYPE_SEPARATOR  = 14

TYPE_STRING_SELECT  = 3

TYPE_TEXT_DISPLAY  = 10

TYPE_TEXT_INPUT  = 4

TYPE_THUMBNAIL  = 11

TYPE_USER_SELECT  = 5

USAGE  = ['Message']

Properties

$id  : int|null

32 bit integer used as an optional identifier for component.

$type  : int

Component type.

$accessory  : Thumbnail|Button|null

Accessory component (Thumbnail or Button).

$components  : array<string|int, TextDisplay>

Array of text display components.

Methods

addComponent()  : $this

Adds a text display component to the section.

getAccessory()  : Thumbnail|Button|null

Returns the accessory component.

getComponents()  : array<string|int, TextDisplay>

Returns all the text components in the section.

getCustomId()  : string|null

Returns the custom ID of the button.

getType()  : int

Retrieves the type of the component.

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

{@inheritDoc}

new()  : self

Creates a new section.

setAccessory()  : $this

Sets the accessory component of the section.

generateUuid()  : string

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

getId()  : int|null

The id field is optional and is used to identify components in the response from an interaction that aren't interactive components.