php8.5
Home/ Manual/ xattr / functions/ xattr_set

xattr_set

PHP function Edit on GitHub ✎

(PECL xattr >= 0.9.0)

Set an extended attribute

Description

xattr_set(string $filename, string $name, string $value, int $flags = 0): bool

This function sets the value of an extended attribute of a file.

Namespace

Parameters

filename

The file in which we set the attribute.

name

The name of the extended attribute. This attribute will be created if it doesn't exist or replaced otherwise. You can change this behaviour by using the flags parameter.

value

The value of the attribute.

flags
XATTR_CREATEFunction will fail if extended attribute already exists.
XATTR_REPLACEFunction will fail if extended attribute doesn't exist.
XATTR_DONTFOLLOWDo not follow the symbolic link but operate on symbolic link itself.
XATTR_ROOTSet attribute in root (trusted) namespace. Requires root privileges.

Return Values

Success

Examples

Sets extended attributes on .wav file

php
<?php
$file = 'my_favourite_song.wav';
xattr_set($file, 'Artist', 'Someone');
xattr_set($file, 'My ranking', 'Good');
xattr_set($file, 'Listen count', '34');

/* ... other code ... */

printf("You've played this song %d times", xattr_get($file, 'Listen count')); 
?>

See Also

Source: reference/xattr/functions/xattr-set.xml · from the official PHP manual (php/doc-en)