DiscordPHP Documentation

Label extends Layout
in package

A Label is a top-level component.

Tags
link
https://discord.com/developers/docs/components/reference#label
todo

Update Label class to extend the relevant base class.

todo

Confirm if Label will be usable in Message components.

since
10.19.0
@property

?string|null $id Optional identifier for component.

@property

?string|null $description Optional description for the label. Max 100 characters.

Table of Contents

Constants

TYPE_ACTION_ROW  = 1
TYPE_BUTTON  = 2
TYPE_CHANNEL_SELECT  = 8
TYPE_CONTAINER  = 17
TYPE_CONTENT_INVENTORY_ENTRY  = 16
TYPE_FILE  = 13
TYPE_LABEL  = 18
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  = ['Modal']

Properties

$component  : SelectMenu|TextInput
The component associated with the label.
$description  : string|null
Optional description for the label.
$id  : int|null
32 bit integer used as an optional identifier for component.
$label  : string
The text for the label.
$type  : int
Component type.

Methods

getCustomId()  : string|null
Returns the custom ID of the button.
getType()  : int
Retrieves the type of the component.
jsonSerialize()  : array<string|int, mixed>
new()  : self
Creates a new label component.
setComponent()  : self
Sets the component associated with the label.
setDescription()  : self
Sets the description text.
setLabel()  : self
Sets the label text.
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.
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.

Constants

TYPE_ACTION_ROW

public mixed TYPE_ACTION_ROW = 1

TYPE_CHANNEL_SELECT

public mixed TYPE_CHANNEL_SELECT = 8

TYPE_CONTAINER

public mixed TYPE_CONTAINER = 17

TYPE_CONTENT_INVENTORY_ENTRY

public mixed TYPE_CONTENT_INVENTORY_ENTRY = 16

TYPE_MEDIA_GALLERY

public mixed TYPE_MEDIA_GALLERY = 12

TYPE_MENTIONABLE_SELECT

public mixed TYPE_MENTIONABLE_SELECT = 7

TYPE_ROLE_SELECT

public mixed TYPE_ROLE_SELECT = 6

TYPE_SELECT_MENU

Use Component::TYPE_STRING_SELECT

public mixed TYPE_SELECT_MENU = 3

TYPE_SEPARATOR

public mixed TYPE_SEPARATOR = 14

TYPE_STRING_SELECT

public mixed TYPE_STRING_SELECT = 3

TYPE_TEXT_DISPLAY

public mixed TYPE_TEXT_DISPLAY = 10

TYPE_TEXT_INPUT

public mixed TYPE_TEXT_INPUT = 4

TYPE_THUMBNAIL

public mixed TYPE_THUMBNAIL = 11

TYPE_USER_SELECT

public mixed TYPE_USER_SELECT = 5

USAGE

public mixed USAGE = ['Modal']

Properties

$description

Optional description for the label.

protected string|null $description

$id

32 bit integer used as an optional identifier for component.

protected int|null $id

$label

The text for the label.

protected string $label

$type

Component type.

protected int $type = \Discord\Builders\Components\Component::TYPE_LABEL

Methods

getCustomId()

Returns the custom ID of the button.

public getCustomId() : string|null
Return values
string|null

getType()

Retrieves the type of the component.

public getType() : int
Return values
int

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

new()

Creates a new label component.

public static new(string $label, SelectMenu|TextInput $component[, string|null $description = null ]) : self
Parameters
$label : string

The text for the label.

$component : SelectMenu|TextInput

The component associated with the label.

$description : string|null = null

Optional description for the label.

Return values
self

setComponent()

Sets the component associated with the label.

public setComponent(SelectMenu|TextInput $component) : self
Parameters
$component : SelectMenu|TextInput

The component associated with the label.

Return values
self

setDescription()

Sets the description text.

public setDescription([string|null $description = null ]) : self
Parameters
$description : string|null = null

The description for the label. Max 100 characters.

Return values
self

setLabel()

Sets the label text.

public setLabel(string $label) : self
Parameters
$label : string

The text for the label. Must be between 1 and 45 characters.

Return values
self

generateUuid()

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

protected static generateUuid() : string
Return values
string

getId()

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

protected getId() : int|null

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.

Return values
int|null

setId()

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.

protected setId([string|null $id = null ]) : self
Parameters
$id : string|null = null

32 bit integer used as an optional identifier for component.

Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results