+0
Daily
17,478
stars
1,146
forks
207
watchers
505
prs
680
issues
109
releases
README
PHP Parser
==========
This is a PHP parser written in PHP. Its purpose is to simplify static code analysis and
manipulation.
[Documentation for version 5.x][doc_master] (current; for running on PHP = 7.4; for parsing PHP 7.0 to PHP 8.4, with limited support for parsing PHP 5.x).
[Documentation for version 4.x][doc_4_x] (supported; for running on PHP = 7.0; for parsing PHP 5.2 to PHP 8.3).
Features
--------
The main features provided by this library are:
Parsing PHP 7, and PHP 8 code into an abstract syntax tree (AST).
Invalid code can be parsed into a partial AST.
The AST contains accurate location information.
Dumping the AST in human-readable form.
Converting an AST back to PHP code.
Formatting can be preserved for partially changed ASTs.
Infrastructure to traverse and modify ASTs.
Resolution of namespaced names.
Evaluation of constant expressions.
Builders to simplify AST construction for code generation.
Converting an AST into JSON and back.
Quick Start
-----------
Install the library using composer:
php composer.phar require nikic/php-parser
Parse some PHP code into an AST and dump the result in human-readable form:
php
createForNewestSupportedVersion();
try {
$ast = $parser-parse($code);
} catch (Error $error) {
echo "Parse error: {$error-getMessage()}\n";
return;
}
$dumper = new NodeDumper;
echo $dumper-dump($ast) . "\n";
This dumps an AST looking something like this:
array(
0: Stmt_Function(
attrGroups: array(
)
byRef: false
name: Identifier(
name: test
)
params: array(
0: Param(
attrGroups: array(
)
flags: 0
type: null
byRef: false
variadic: false
var: Expr_Variable(
name: foo
)
default: null
)
)
returnType: null
stmts: array(
0: Stmt_Expression(
expr: Expr_FuncCall(
name: Name(
name: var_dump
)
args: array(
0: Arg(
name: null
value: Expr_Variable(
name: foo
)
byRef: false
unpack: false
)
)
)
)
)
)
)
Let's traverse the AST and perform some kind of modification. For example, drop all function bodies:
php
use PhpParser\Node;
use PhpParser\Node\Stmt\Function_;
use PhpParser\NodeTraverser;
use PhpParser\NodeVisitorAbstract;
$traverser = new NodeTraverser();
$traverser-addVisitor(new class extends NodeVisitorAbstract {
public function enterNode(Node $node) {
if ($node instanceof Function_) {
// CleaTop issues
#349Evaluate performance and memory usage17 comments · 2017-02-04#1008Allow opting in to multiline arrays explicitly15 comments · 2024-06-24#566Request: dumper that create php to create AST12 comments · 2019-01-04#56Even more fluid code generation12 comments · 2013-04-23#916Planned changes to NodeTraverser10 comments · 2023-03-05#550Hex chars greater than \x7f aborts silently the parsing8 comments · 2018-11-24#501Where can I get the reference table of the node type?7 comments · 2018-05-14#16Introducing PHPParser_Node_Stmt_Block7 comments · 2012-04-05
Latest release
PHP-Parser 5.9.0 v5.9.0 2026-09-13Fixed
Fix attribute insertion on enums and enum cases in formatting-preserving pretty printer.
Reject invalid Unicode escapes above \u{10FFFF}. Previously the limit was \u{1FFFFF}.
Don't allow newlines in (void) cast emulation.
Fix warning on float hex/binary/octal literals with PHP 8.6.
Added
Added support for PHP 8.6 partial function application. Placeholders are represented using ArgPlaceholder nodes.