PHP 8.4.1 Released!

fileperms

(PHP 4, PHP 5, PHP 7, PHP 8)

filepermsファイルのパーミッションを取得する

説明

fileperms(string $filename): int|false

指定したファイルのパーミッションを取得します。

パラメータ

filename

ファイルへのパス。

戻り値

ファイルのパーミッションを数値モードで返します。このモードの下位ビットは chmod() に渡すのと同じ形式です。 しかし、大半のプラットフォームでは、それだけではなく filename のファイル形式に関する情報も含まれます。 以下の例で示すのは、ファイルのパーミッションやファイル形式を POSIX システム (Linux や macOS など) で調べる方法です。

ローカルファイルの場合、その戻り値は C ライブラリ関数 stat() が返す構造体の st_mode メンバーの値となります。 どのビットがセットされるかはプラットフォームによって異なるので、 パーミッション部分以外のビットをパースしたい場合は各プラットフォームのドキュメントを参照することをおすすめします。

失敗時に false を返します。

エラー / 例外

失敗したときは E_WARNING が発生します。

例1 八進形式でのパーミッションの表示

<?php
echo substr(sprintf('%o', fileperms('/tmp')), -4);
echo
substr(sprintf('%o', fileperms('/etc/passwd')), -4);
?>

上の例の出力は以下となります。

1777
0644

例2 完全なパーミッションの表示

<?php
$perms
= fileperms('/etc/passwd');

switch (
$perms & 0xF000) {
case
0xC000: // ソケット
$info = 's';
break;
case
0xA000: // シンボリックリンク
$info = 'l';
break;
case
0x8000: // 通常のファイル
$info = 'r';
break;
case
0x6000: // ブロックスペシャルファイル
$info = 'b';
break;
case
0x4000: // ディレクトリ
$info = 'd';
break;
case
0x2000: // キャラクタスペシャルファイル
$info = 'c';
break;
case
0x1000: // FIFO パイプ
$info = 'p';
break;
default:
// 不明
$info = 'u';
}

// 所有者
$info .= (($perms & 0x0100) ? 'r' : '-');
$info .= (($perms & 0x0080) ? 'w' : '-');
$info .= (($perms & 0x0040) ?
((
$perms & 0x0800) ? 's' : 'x' ) :
((
$perms & 0x0800) ? 'S' : '-'));

// グループ
$info .= (($perms & 0x0020) ? 'r' : '-');
$info .= (($perms & 0x0010) ? 'w' : '-');
$info .= (($perms & 0x0008) ?
((
$perms & 0x0400) ? 's' : 'x' ) :
((
$perms & 0x0400) ? 'S' : '-'));

// 全体
$info .= (($perms & 0x0004) ? 'r' : '-');
$info .= (($perms & 0x0002) ? 'w' : '-');
$info .= (($perms & 0x0001) ?
((
$perms & 0x0200) ? 't' : 'x' ) :
((
$perms & 0x0200) ? 'T' : '-'));

echo
$info;
?>

上の例の出力は以下となります。

-rw-r--r--

注意

注意: この関数の結果は キャッシュされます。詳細は、clearstatcache() を参照してください。

ヒント

PHP 5.0.0 以降、この関数は、 何らかの URL ラッパーと組合せて使用することができます。 どのラッパーが stat() ファミリーをサポートしているかを調べるには サポートするプロトコル/ラッパー を参照してください。

参考

  • chmod() - ファイルのモードを変更する
  • is_readable() - ファイルが存在し、読み込み可能であるかどうかを知る
  • stat() - ファイルに関する情報を取得する

add a note

User Contributed Notes 4 notes

up
36
coolmic at example dot com
11 years ago
Don't use substr, use bit operator
<?php
decoct
(fileperms($file) & 0777); // return "755" for example
?>

If you want to compare permission
<?php
0755
=== (fileperms($file) & 0777);
?>
up
6
admin at torntech dot com
12 years ago
This may not be immediately apparent to some, but you can use octdec( $octal_value ) to match the permissions retrieved by file perms

<?php

//assumes file has 2770 permissions
$perm= fileperms( __FILE__ );
$bit = "102770";

printf( "%s\n", octdec( $bit ) );
printf( "%s\n", $perm);

?>
up
4
paul2712 at gmail dot com
17 years ago
Do not forget: clearstatcache();
==============================

When ever you make a:

mkdir($dstdir, 0770 ))

or a:

chmod($dstdir, 0774 );

You have to call:

clearstatcache();

before you can call:

fileperms($dstdir);
up
0
chris at ocproducts dot com
4 years ago
Windows has a very different file permission model to Unix and integrates them only minimally.

Here's how Windows calculates the bitmask...

u+w/g+w/o+w is set based on whether the file has the read only flag.

u+r/g+w/o+w is always set.

u+x/g+x/o+x is set based on whether $filename is an inherently executable file (e.g. bat) or a directory.

Windows isn't integrating its ACLs at all.

Here's the source of all this: https://docs.microsoft.com/en-us/cpp/c-runtime-library/reference/stat-functions?view=vs-2019 (but it doesn't provide many details)
To Top