fgets

编辑

(PHP 4, PHP 5, PHP 7)

fgets — 从文件指针中读取一行

PHP中文网词条详解语法

fgets(file,length)

fgets() 函数从文件指针中读取一行。

如果碰到 PHP 在读取文件时不能识别 Macintosh 文件的行结束符,可以激活 auto_detect_line_endings 运行时配置选项。

PHP中文网词条详解参数

参数描述
file必需。规定要读取的文件。
length可选。规定要读取的字节数。默认是 1024 字节。


PHP中文网词条详解返回值

file 指向的文件中读取了 length - 1 字节后返回字符串。 碰到换行符(包括在返回值中)、EOF 或者已经读取了length - 1 字节后停止(要看先碰到那一种情况)。如果没有指定 length,则默认为 1K,或者说 1024 字节。如果文件指针中没有更多的数据了则返回 FALSE。

错误发生时返回 FALSE。

PHP中文网词条详解更新日志

length 参数从 PHP 4.2.0 起成为可选项,如果忽略,则行的长度被假定为 1024 字节。从 PHP 4.3 开始,忽略掉 length将继续从流中读取数据直到行结束。如果文件中的大多数行都大于 8 KB,则在脚本中指定最大行的长度在利用资源上更为有效。

从 PHP 4.3 开始本函数可以安全用于二进制文件。早期的版本则不行。

PHP中文网词条详解范例

Example #1 fgets() 例子

在test.txt文件中加入如下的内容

第一行:Hello, this is a test. 
第二行:This is the last line.

然后使用fgets()函数从test.txt文件中读取一行

<?php
  $file = fopen("test.txt","r");
  echo fgets($file);
  fclose($file);
?>

以上例程会输出:

第一行:Hello, this is a test.


PHP中文网词条详解参见

  • fgetss() - 从文件指针中读取一行并过滤掉 HTML 标记

  • fread() - 读取文件(可安全用于二进制文件)

  • fgetc() - 从文件指针中读取字符

  • stream_get_line() - 从资源流里读取一行直到给定的定界符

  • fopen() - 打开文件或者 URL

  • popen() - 打开进程文件指针

  • fsockopen() - 打开一个网络连接或者一个Unix套接字连接

  • stream_set_timeout() - Set timeout period on a stream

参考资料
词条标签:
fgets