Skip to content

Install the PHP YAML extension

The PHP YAML extension provides PHP functions for parsing and serializing files and text containing YAML markup.

The YAML extension supports PHP 5.6+.

Install the YAML extension

Installing the extension involves the following steps:

  1. Install build dependencies (packages that are required to build the extension).
  2. Build the extension’s library file.
  3. Enable the extension in the PHP configuration.

Install build dependencies

Set environment variables for the package manager.

Terminal window
export DEBIAN_FRONTEND=noninteractive

Install a compiler and other packages that are required for building PHP extensions.

Terminal window
sudo apt-get -y install gcc g++ make autoconf libc-dev pkg-config

Install additional packages that are required to build the YAML extension.

Terminal window
sudo apt-get -y install libyaml-dev

Build the extension

The PECL install command compiles the extension’s .so library file.

Terminal window
yes '' | sudo pecl8.4-sp install yaml

Enable the extension

Configure PHP to load the extension.

Terminal window
sudo bash -c "echo extension=yaml.so > /etc/php8.4-sp/conf.d/yaml.ini"

Restart PHP-FPM.

Terminal window
sudo service php8.4-fpm-sp restart

Verify the extension is enabled in PHP.

Terminal window
php8.4-sp -i | grep yaml

If the extension is enabled, you will see output like the following.

/etc/phpX.Y-sp/conf.d/yaml.ini
yaml
yaml.decode_binary => 0 => 0
yaml.decode_php => 0 => 0
yaml.decode_timestamp => 0 => 0
yaml.output_canonical => 0 => 0
yaml.output_indent => 2 => 2
yaml.output_width => 80 => 80

Uninstall the YAML extension

Uninstalling the extension involves the following steps:

  1. Disable the extension in the PHP configuration.
  2. Remove the extension’s library file.

Disable the extension

Remove the extension’s configuration from PHP.

Terminal window
sudo rm /etc/php8.4-sp/conf.d/yaml.ini

Restart PHP-FPM.

Terminal window
sudo service php8.4-fpm-sp restart

Remove the extension

The PECL uninstall command removes the extension’s .so library file.

Terminal window
sudo pecl8.4-sp uninstall yaml