xref: /PHP-8.4/README.md (revision 13f04116)
1<div align="center">
2    <a href="https://www.php.net">
3        <img
4            alt="PHP"
5            src="https://www.php.net/images/logos/new-php-logo.svg"
6            width="150">
7    </a>
8</div>
9
10# The PHP Interpreter
11
12PHP is a popular general-purpose scripting language that is especially suited to
13web development. Fast, flexible and pragmatic, PHP powers everything from your
14blog to the most popular websites in the world. PHP is distributed under the
15[PHP License v3.01](LICENSE).
16
17[![Push](https://github.com/php/php-src/actions/workflows/push.yml/badge.svg)](https://github.com/php/php-src/actions/workflows/push.yml)
18[![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/php.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:php)
19
20## Documentation
21
22The PHP manual is available at [php.net/docs](https://www.php.net/docs).
23
24## Installation
25
26### Prebuilt packages and binaries
27
28Prebuilt packages and binaries can be used to get up and running fast with PHP.
29
30For Windows, the PHP binaries can be obtained from
31[windows.php.net](https://windows.php.net). After extracting the archive the
32`*.exe` files are ready to use.
33
34For other systems, see the [installation chapter](https://www.php.net/install).
35
36### Building PHP source code
37
38*For Windows, see [Build your own PHP on Windows](https://wiki.php.net/internals/windows/stepbystepbuild_sdk_2).*
39
40For a minimal PHP build from Git, you will need autoconf, bison, and re2c. For
41a default build, you will additionally need libxml2 and libsqlite3.
42
43On Ubuntu, you can install these using:
44
45    sudo apt install -y pkg-config build-essential autoconf bison re2c \
46                        libxml2-dev libsqlite3-dev
47
48On Fedora, you can install these using:
49
50    sudo dnf install re2c bison autoconf make libtool ccache libxml2-devel sqlite-devel
51
52Generate configure:
53
54    ./buildconf
55
56Configure your build. `--enable-debug` is recommended for development, see
57`./configure --help` for a full list of options.
58
59    # For development
60    ./configure --enable-debug
61    # For production
62    ./configure
63
64Build PHP. To speed up the build, specify the maximum number of jobs using `-j`:
65
66    make -j4
67
68The number of jobs should usually match the number of available cores, which
69can be determined using `nproc`.
70
71## Testing PHP source code
72
73PHP ships with an extensive test suite, the command `make test` is used after
74successful compilation of the sources to run this test suite.
75
76It is possible to run tests using multiple cores by setting `-jN` in
77`TEST_PHP_ARGS`:
78
79    make TEST_PHP_ARGS=-j4 test
80
81Shall run `make test` with a maximum of 4 concurrent jobs: Generally the maximum
82number of jobs should not exceed the number of cores available.
83
84The [qa.php.net](https://qa.php.net) site provides more detailed info about
85testing and quality assurance.
86
87## Installing PHP built from source
88
89After a successful build (and test), PHP may be installed with:
90
91    make install
92
93Depending on your permissions and prefix, `make install` may need super user
94permissions.
95
96## PHP extensions
97
98Extensions provide additional functionality on top of PHP. PHP consists of many
99essential bundled extensions. Additional extensions can be found in the PHP
100Extension Community Library - [PECL](https://pecl.php.net).
101
102## Contributing
103
104The PHP source code is located in the Git repository at
105[github.com/php/php-src](https://github.com/php/php-src). Contributions are most
106welcome by forking the repository and sending a pull request.
107
108Discussions are done on GitHub, but depending on the topic can also be relayed
109to the official PHP developer mailing list internals@lists.php.net.
110
111New features require an RFC and must be accepted by the developers. See
112[Request for comments - RFC](https://wiki.php.net/rfc) and
113[Voting on PHP features](https://wiki.php.net/rfc/voting) for more information
114on the process.
115
116Bug fixes don't require an RFC. If the bug has a GitHub issue, reference it in
117the commit message using `GH-NNNNNN`. Use `#NNNNNN` for tickets in the old
118[bugs.php.net](https://bugs.php.net) bug tracker.
119
120    Fix GH-7815: php_uname doesn't recognise latest Windows versions
121    Fix #55371: get_magic_quotes_gpc() throws deprecation warning
122
123See [Git workflow](https://wiki.php.net/vcs/gitworkflow) for details on how pull
124requests are merged.
125
126### Guidelines for contributors
127
128See further documents in the repository for more information on how to
129contribute:
130
131- [Contributing to PHP](/CONTRIBUTING.md)
132- [PHP coding standards](/CODING_STANDARDS.md)
133- [Internal documentation](https://php.github.io/php-src/)
134- [Mailing list rules](/docs/mailinglist-rules.md)
135- [PHP release process](/docs/release-process.md)
136
137## Credits
138
139For the list of people who've put work into PHP, please see the
140[PHP credits page](https://www.php.net/credits.php).
141