PHP configuration

PHP is a web template system that accidentally grew up into a fairly general language. PHP's syntax, capabilities, and execution model bear vague similarities to Perl; scripts are loaded by an "interpreter", compiled to bytecode, and then executed. The PHP interpreter can be run from the command line, CGI-style, or more commonly as an in-process Apache module.

MediaWiki compatibility
For the allowed set of PHP versions you can use with your version of MediaWiki, see comp-php>Special:MyLanguage/Compatibility#PHP|Compatibility#PHP.

Installation
Please see http://php.net/install.

Required
The following extensions are required by MediaWiki:


 * [http://php.net/pcre Perl Compatible Regular Expressions]


 * [http://php.net/session Session]


 * [http://php.net/spl Standard PHP Library]


 * [http://php.net/dom Document Object Module]


 * [http://php.net/iconv iconv] character set conversion library


 * [http://php.net/json JSON] (alternatively, the [http://pecl.php.net/package/jsonc</> pecl-json-c] fork)


 * [<tvar|mbstring>http://php.net/mbstring</> mbstring] multibyte character string support


 * [<tvar|fileinfo>http://php.net/fileinfo</> fileinfo] MIME type detection


 * At least one database driver:


 * [<tvar|mysql>http://php.net/mysql</> MySQL]


 * [<tvar|postgres>http://php.net/pgsql</> PostgreSQL]


 * [<tvar|sqlite>http://php.net/pdo-sqlite</> SQLite (through PDO)]

MySQL and PostgreSQL through PDO are not supported

Perl Compatible Regular Expressions, Session, Standard PHP Library, and JSON are enabled by default; Perl Compatible Regular Expressions and Standard PHP Library cannot be disabled since PHP 5.3.

Optional
MediaWiki either needs or wants a number of optional features of PHP that need to be enabled at compile time:


 * [<tvar|zlib>http://php.net/zlib</> zlib] compression library, optionally to compress the man-fcache>Special:MyLanguage/Manual:File cache</>|file cache


 * [<tvar|sockets>http://php.net/sockets</> sockets] support for network communication, if using memcached>Special:MyLanguage/Memcached</>|memcached


 * faststr>Special:MyLanguage/FastStringSearch</>|FastStringSearch

Example
We are successfully working with these compiler options:

<pre style="overflow:auto;"> './configure' \ '--with-mysql' \ '--with-apxs2=/usr/sbin/apxs2' \ '--with-zlib' \ '--with-ldap' \ '--with-gd' \ '--with-jpeg-dir' \ '--with-iconv-dir' \ '--enable-mbstring'

In detail, these configure options do the following:


 * --with-mysql : Allows PHP to query MySQL. This is an essential feature (I think). You will need to have MySQL installed to enable this option.


 * --with-apxs2=/usr/sbin/apxs2 : this is required if you want to build mod_php. APXS is for configuring compilation of an Apache module. You will need to change (or omit the path) for your specific system.


 * --with-zlib : Allows PHP to read / write zipped files and send compressed data to Apache ... or something like that


 * --with-ldap : Important if you want your wiki users to be verified by LDAP


 * --with-gd : Use this if you want image processing 'within' PHP, else you can use ImageMagick. Because this option requires that you have various libraries installed... but presumably IM has the same deps... oh well...


 * --with-jpeg-dir : Seems nonsensical


 * --with-iconv-dir : Seems nonsensical


 * --enable-mbstring : Allows multibyte character string support. This is optional, as slower custom code will be used if not available.

Opcode caching

 * See <tvar|1></>

Due to MediaWiki's large codebase, it is highly recommended that a system be used to cache the compiled scripts; there are a number of such plugins for PHP, some free, some proprietary. There is a list of some caches:


 * [<tvar|apc>http://www.php.net/apc/</> Alternative PHP Cache] -- used at Wikimedia


 * [<tvar|wincache>http://www.iis.net/download/wincacheforphp</> Windows Cache Extension for PHP] -- recommended for IIS users

Fortunately, these all seem to be easy to install as Zend plugins, you just drop in a library and change your php.ini. No fussy recompiling of the entire PHP!

Depending on the cache and options used, you may have to perform a special operation whenever updating script files.

MediaWiki can also interact with that caches and use them for object caching, see <tvar|MainCacheType> </>.

Runtime configuration (php.ini)
Some settings in [<tvar|phpini>http://www.php.net/ini</> php.ini] affects MediaWiki behavior and some of them are incompatible with MediaWiki


 * register_globals


 * safe_mode


 * safemode>Special:MyLanguage/Safe mode</>|Safe mode is an ill-conceived, broken-by-design setting in PHP; MediaWiki can work with this option on, but some features won't work.


 * magic_quotes_gpc


 * This options adds quotes to data in,   and  . MediaWiki can work with this option turned on, but will have to remove these quotes and thus will be slower.


 * magic_quotes_runtime


 * This option corrupts data input unpredictably by adding quotes in e.g. opened files, data received from database etc. MediaWiki will refuse to install if this option is turned on.


 * magic_quotes_sybase


 * same as magic_quotes_runtime


 * mbstring.func_overload


 * This option causes errors and may corrupt data unpredictably; MediaWiki will refuse to install if this option is turned on.


 * zend.ze1_compatibility_mode


 * This option causes horrible bugs; MediaWiki will refuse to install if this option is turned on.


 * memory_limit


 * MediaWiki needs sufficiently memory to work. The minimal limit should be something like 20 MB, but if you want MediaWiki to work correctly, consider using at least 50 MB.


 * disable_functions


 * To be able to find GNU diff3 and git during installation process this entry must not contain passthru


 * post_max_size


 * If you are getting the error "<tvar|editformincomplete> </>" then it could be because this is set with a "MB" prefix, instead of just "M" (the former is interpreted at bytes, not megabytes).

Image Resizing
ImageMagick can be used for image resizing When it is not available the GD PHP module is used instead where found.