https://github.com/nikic/PHP-Parser Skip to content Navigation Menu Toggle navigation Sign in * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + GitHub Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions By size + Enterprise + Teams + Startups By industry + Healthcare + Financial services + Manufacturing By use case + CI/CD & Automation + DevOps + DevSecOps * Resources Topics + AI + DevOps + Security + Software Development + View all Explore + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Enterprise + Enterprise platform AI-powered developer platform Available add-ons + Advanced Security Enterprise-grade security features + GitHub Copilot Enterprise-grade AI features + Premium Support Enterprise-grade 24/7 support * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up Reseting focus You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} nikic / PHP-Parser Public * Notifications You must be signed in to change notification settings * Fork 1.1k * Star 16.9k A PHP parser written in PHP License BSD-3-Clause license 16.9k stars 1.1k forks Branches Tags Activity Star Notifications You must be signed in to change notification settings * Code * Issues 36 * Pull requests 6 * Actions * Wiki * Security * Insights Additional navigation options * Code * Issues * Pull requests * Actions * Wiki * Security * Insights nikic/PHP-Parser This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. master BranchesTags Go to file Code Folders and files Last commit Last Name Name message commit date Latest commit History 1,703 Commits .github/workflows .github/workflows bin bin doc doc grammar grammar lib/PhpParser lib/PhpParser test test test_old test_old tools tools .editorconfig .editorconfig .gitattributes .gitattributes .gitignore .gitignore .php-cs-fixer.dist.php .php-cs-fixer.dist.php CHANGELOG.md CHANGELOG.md CONTRIBUTING.md CONTRIBUTING.md LICENSE LICENSE Makefile Makefile README.md README.md UPGRADE-1.0.md UPGRADE-1.0.md UPGRADE-2.0.md UPGRADE-2.0.md UPGRADE-3.0.md UPGRADE-3.0.md UPGRADE-4.0.md UPGRADE-4.0.md UPGRADE-5.0.md UPGRADE-5.0.md composer.json composer.json phpstan-baseline.neon phpstan-baseline.neon phpstan.neon.dist phpstan.neon.dist phpunit.xml.dist phpunit.xml.dist View all files Repository files navigation * README * BSD-3-Clause license PHP Parser Coverage Status This is a PHP parser written in PHP. Its purpose is to simplify static code analysis and manipulation. Documentation for version 5.x (current; for running on PHP >= 7.4; for parsing PHP 7.0 to PHP 8.3, with limited support for parsing PHP 5.x). Documentation for version 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: 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: 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_) { // Clean out the function body $node->stmts = []; } } }); $ast = $traverser->traverse($ast); echo $dumper->dump($ast) . "\n"; This gives us an AST where the Function_::$stmts are empty: array( 0: Stmt_Function( attrGroups: array( ) byRef: false name: Identifier( name: test ) params: array( 0: Param( attrGroups: array( ) type: null byRef: false variadic: false var: Expr_Variable( name: foo ) default: null ) ) returnType: null stmts: array( ) ) ) Finally, we can convert the new AST back to PHP code: use PhpParser\PrettyPrinter; $prettyPrinter = new PrettyPrinter\Standard; echo $prettyPrinter->prettyPrintFile($ast); This gives us our original code, minus the var_dump() call inside the function: