<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.settype" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>settype</refname>

<refpurpose>Set the type of a variable</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>bool</type><methodname>settype</methodname>

<methodparam><type>mixed</type><parameter role="reference">var</parameter></methodparam>

<methodparam><type>string</type><parameter>type</parameter></methodparam>

</methodsynopsis>

<para>

Set the type of variable <parameter>var</parameter> to

<parameter>type</parameter>.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>var</parameter></term>

<listitem>

<para>

The variable being converted.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>type</parameter></term>

<listitem>

<para>

Possibles values of <parameter>type</parameter> are:

<itemizedlist>

<listitem>

<simpara>

"boolean" or "bool"

</simpara>

</listitem>

<listitem>

<simpara>

"integer" or "int"

</simpara>

</listitem>

<listitem>

<simpara>

"float" or "double"

</simpara>

</listitem>

<listitem>

<simpara>

"string"

</simpara>

</listitem>

<listitem>

<simpara>

"array"

</simpara>

</listitem>

<listitem>

<simpara>

"object"

</simpara>

</listitem>

<listitem>

<simpara>

"null"

</simpara>

</listitem>

</itemizedlist>

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

&return.success;

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<para>

Throws a <exceptionname>ValueError</exceptionname> if the value of

<parameter>type</parameter> is not a valid type, as of PHP 8.0.0.

Prior to PHP 8.0.0, a <constant>E_WARNING</constant> was emitted

and &false; was returned.

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.0.0</entry>

<entry>

Now throws a <exceptionname>ValueError</exceptionname> when an invalid

type is passed to <parameter>type</parameter>. Previously, a

<constant>E_WARNING</constant> was emitted and the function returned

&false;.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>settype</function> example</title>

<programlisting role="php">

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<note>

<para>

Maximum value for "int" is <constant>PHP_INT_MAX</constant>.

</para>

</note>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>gettype</function></member>

<member><link linkend="language.types.typecasting">type-casting</link></member>

<member><link linkend="language.types.type-juggling">type-juggling</link></member>

</simplelist>

</para>

</refsect1>

</refentry>