DiscordPHP Documentation

TextInput extends Component
in package

Text inputs are an interactive component that render on modals. They can be used to collect short-form or long-form text.

Tags
link
https://discord.com/developers/docs/interactions/message-components#text-inputs
since
7.0.0

Table of Contents

STYLE_PARAGRAPH  = 2
STYLE_SHORT  = 1
TYPE_ACTION_ROW  = 1
TYPE_BUTTON  = 2
TYPE_CHANNEL_SELECT  = 8
TYPE_MENTIONABLE_SELECT  = 7
TYPE_ROLE_SELECT  = 6
TYPE_SELECT_MENU  = 3
TYPE_STRING_SELECT  = 3
TYPE_TEXT_INPUT  = 4
TYPE_USER_SELECT  = 5
$custom_id  : string
Custom ID to identify the text input.
$label  : string
Label for the text input.
$max_length  : int|null
Maximum input length for a text input, min 1, max 4000.
$min_length  : int|null
Minimum input length for a text input, min 0, max 4000.
$placeholder  : string|null
Placeholder string to display if text input is empty. Maximum 100 characters.
$required  : bool
Whether the text input is required.
$style  : int
Style of text input.
$value  : string|null
Pre-filled value for text input. Max 4000 characters.
__construct()  : mixed
Creates a new text input.
getCustomId()  : string
Returns the Custom ID of the text input.
getMaxLength()  : int|null
Returns the maximum length of the text input.
getMinLength()  : int|null
Returns the minimum length of the text input.
getPlaceholder()  : string|null
Returns the placeholder string of the text input.
isRequired()  : bool|null
Returns wether the text input is disabled.
jsonSerialize()  : array<string|int, mixed>
{@inheritDoc}
new()  : self
Creates a new text input.
setCustomId()  : $this
Sets the custom ID for the text input.
setLabel()  : $this
Sets the label of the text input.
setMaxLength()  : $this
Sets the maximum input length for a text input.
setMinLength()  : $this
Sets the minimum input length for a text input.
setPlaceholder()  : $this
Sets the placeholder string to display if text input is empty.
setRequired()  : $this
Set if this component is required to be filled, default false.
setStyle()  : $this
Sets the style of the text input.
setValue()  : $this
Sets a pre-filled value for the text input.
generateUuid()  : string
Generates a UUID which can be used for component custom IDs.

Constants

STYLE_PARAGRAPH

public mixed STYLE_PARAGRAPH = 2

TYPE_ACTION_ROW

public mixed TYPE_ACTION_ROW = 1

TYPE_CHANNEL_SELECT

public mixed TYPE_CHANNEL_SELECT = 8

TYPE_MENTIONABLE_SELECT

public mixed TYPE_MENTIONABLE_SELECT = 7

TYPE_ROLE_SELECT

public mixed TYPE_ROLE_SELECT = 6

TYPE_SELECT_MENU

public mixed TYPE_SELECT_MENU = 3
Tags
deprecated
7.4.0

Use Component::TYPE_STRING_SELECT

TYPE_STRING_SELECT

public mixed TYPE_STRING_SELECT = 3

TYPE_TEXT_INPUT

public mixed TYPE_TEXT_INPUT = 4

TYPE_USER_SELECT

public mixed TYPE_USER_SELECT = 5

Properties

$custom_id

Custom ID to identify the text input.

private string $custom_id

$label

Label for the text input.

private string $label

$max_length

Maximum input length for a text input, min 1, max 4000.

private int|null $max_length

$min_length

Minimum input length for a text input, min 0, max 4000.

private int|null $min_length

$placeholder

Placeholder string to display if text input is empty. Maximum 100 characters.

private string|null $placeholder

$required

Whether the text input is required.

private bool $required

$style

Style of text input.

private int $style

$value

Pre-filled value for text input. Max 4000 characters.

private string|null $value

Methods

__construct()

Creates a new text input.

public __construct(string $label, int $style[, string|null $custom_id = null ]) : mixed
Parameters
$label : string

The label of the text input.

$style : int

The style of the text input.

$custom_id : string|null = null

The custom ID of the text input. If not given, an UUID will be used

Return values
mixed —

getCustomId()

Returns the Custom ID of the text input.

public getCustomId() : string
Return values
string —

getMaxLength()

Returns the maximum length of the text input.

public getMaxLength() : int|null
Return values
int|null —

getMinLength()

Returns the minimum length of the text input.

public getMinLength() : int|null
Return values
int|null —

getPlaceholder()

Returns the placeholder string of the text input.

public getPlaceholder() : string|null
Return values
string|null —

isRequired()

Returns wether the text input is disabled.

public isRequired() : bool|null
Return values
bool|null —

jsonSerialize()

{@inheritDoc}

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

new()

Creates a new text input.

public static new(string $label, int $style[, string|null $custom_id = null ]) : self
Parameters
$label : string

The label of the text input.

$style : int

The style of the text input.

$custom_id : string|null = null

The custom ID of the text input.

Return values
self —

setCustomId()

Sets the custom ID for the text input.

public setCustomId(string $custom_id) : $this
Parameters
$custom_id : string
Tags
throws
LengthException
Return values
$this —

setLabel()

Sets the label of the text input.

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

Label of the text input. Maximum 45 characters.

Tags
throws
LengthException
Return values
$this —

setMaxLength()

Sets the maximum input length for a text input.

public setMaxLength(int|null $max_length) : $this
Parameters
$max_length : int|null

Minimum 1 and maximum 4000. null to set as default.

Tags
throws
LengthException
Return values
$this —

setMinLength()

Sets the minimum input length for a text input.

public setMinLength(int|null $min_length) : $this
Parameters
$min_length : int|null

Minimum 0 and maximum 4000. null to set as default.

Tags
throws
LengthException
Return values
$this —

setPlaceholder()

Sets the placeholder string to display if text input is empty.

public setPlaceholder(string|null $placeholder) : $this
Parameters
$placeholder : string|null

Maximum 100 characters. null to clear placeholder.

Tags
throws
LengthException
Return values
$this —

setRequired()

Set if this component is required to be filled, default false.

public setRequired(bool $required) : $this
Parameters
$required : bool
Return values
$this —

setStyle()

Sets the style of the text input.

public setStyle(int $style) : $this
Parameters
$style : int
Tags
throws
InvalidArgumentException
Return values
$this —

setValue()

Sets a pre-filled value for the text input.

public setValue(string|null $value) : $this
Parameters
$value : string|null

A pre-filled value, max 4000 characters.

Tags
throws
LengthException
Return values
$this —

generateUuid()

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

protected static generateUuid() : string
Return values
string —

Search results