Manual:$wgConf/ja

詳細
サイト設定のオブジェクトを作成します. 初期設定のままインストールする場合はほとんど使われません.

この設定はWikimediaの大規模インストールを行う際、数百のウィキに対する設定を集約するのに用いられるもので、サイトグループごとの初期値を設定し、ウィキごとに設定を上書きできるようにします.

しかし、少しややこしいかもしれません. :) 今のところ、 がサイトごとの情報 (例: 各ウィキの適切なユーザページへのリンク) を得るのに必要です.

設定
ウィキはデータベース名に接尾辞をつけてグループ分けされています. 大規模インストールでは例えば 'enwiki'、'enwiktionary'、'enwikibooks'のようになり、それぞれが異なる接尾辞グループになります. を使う場合、接尾辞は$wgConfの メンバー変数で宣言する必要があります.

は設定値群を格納している配列です. 書式は  です.

設定は以下の対象に対する指定となります (範囲の狭い設定から範囲の広い設定への順、これは上記 のうち の部分になります):


 * 特定のデータベース名
 * ウィキタグ（1.12.0から）
 * （ によって決まる）接尾辞グループ内すべてに影響する接尾辞（'wiki' や 'wiktionary' など）
 * すべてのウィキに影響する'初期値'

文字列設定のため、設定を抽出するときに置き換えられるパラメータを定義することができます. すべてのウィキで書式を揃えておくと使いやすいでしょう. の書式で指定します. シングルクォート（ ）を使うときや をエスケープするとき（ ）は注意してください. さもないと（設定するときには値が決まらない）PHP変数に置換されてしまいます. It can be useful when the setting has the same format for all wikis. The format is. Be careful to use single quotes or to escape the    or it will be replaced with the PHP variable (that can be not defined at that time).

1.13以前
When extracting global settings, the object will search first the more specific level (the first one in the list above) and if it doesn't find the setting, it will search in less specific levels. When it finds one, if won't search for less specific ones. This means that you have to pay attention for some specific settings, such as, because it doesn't merge the setting with less specific levels, nor the default value (the one in DefaultSettings.php), you'll need to do it by yourself.

To extract the settings in global variables, you can use.

Parameters are:
 * - Wiki's database name (generally ). You have to define it yourself.
 * - Wiki's suffix, used to to get the suffix level.
 * - array of parameters mapping its name to its value.
 * - array of wiki tags.

1.14以降
1.14.0でいくつかの新機能が追加されました. 1.13以前の部分も引き続き使えます.

コールバック関数
1.14より、コールバックが導入され、 やそれに関連する関数に渡すパラメータを調整できるようになりました. パラメータの変更が使われるのは、そのような関数がLocalSettings.phpよりも後で呼び出されるときでしょう（CentralAuthがこのケースに該当します）. これは で定義することができます. コールバック関数は最初の引数でサイト設定オブジェクトを、2つ目の引数でウィキ名を受け取ります. そして以下のキーを持つ配列を返します（いずれも必ずあるとは限らない）. It might be used to change parameters when such functions are called after LocalSettings.php (this is the case with CentralAuth). You can define it in. The callback function will receive the SiteConfiguration object in the first argument and the wiki name in the second one. It has to return an array with the following keys (all optional):


 * : サイトの接尾辞（ およびこれに類似する $suffix パラメータ）
 * : サイトの言語
 * : ウィキタグの配列（$wikiTags パラメータに関係）
 * : 置き換えられるパラメータの配列（$params パラメータに関係）

これらはパラメータに統合され およびこれに似た関数に渡されます. と  に値が設定されていた場合、既定の の挙動を上書きするのに使われます.

設定の統合
配列はこれで統合できます. これは  の設定に役立つでしょう. これを使うには統合しようとする設定のキーの前に"+"付け加えてください. 両方を併用しても構いません.
 * DefaultSettings.phpにある設定にカスタマイズした設定を統合するには、（ のように）設定名の前に"+"を付け加えてください
 * より限定した階層の設定を統合するには、その対象となる階層のキー名の前に"+"を付け加えてください.


 * To merge your customized version of the setting with the one in DefaultSettings.php, prefix the setting's name with "+" (such as )
 * To merge a more specific level with a less-specific one, prefix the level with a "+".

The two possibilities can be used together.

統合は以下の順に行われます:


 * 1) データベース名
 * 2) タグ（抽出法による順序にて. これはこの点において非常によくランダム化されているでしょう）
 * 3) ウィキ接尾辞
 * 4) 既定値

"+"が前についていないキーがあったとき、統合は終了します.

に関する設定例:

基本的な書式は以下の通りです:

例
この例では3つのウィキ - ,   and   - を使っています. これらは にあります（つまり、,  and  ）.

は既に定義されているものと仮定します.

ウィキメディアでの設定
ウィキメディアではどのように を設定しウィキを設定しているのかについては以下を参照してください.
 * [$common-set CommonSettings.php]（ウィキメディアで使用しているLocalSettings.php）
 * [$init-set InitialiseSettings.php]（ 用）
 * [$wgconf wgConf.php]（$wgConf を初期化するためにCommonSettings.phpで使用）


 * CommonSettings.php (Wikimedia's version of LocalSettings.php)
 * InitialiseSettings.php (for )
 * wgConf.php (used by CommonSettings.php to initialize $wgConf)

関連項目

 * ファイルを見る（またはGitHubで見る）と、$wgConf がどのように機能するのかの案内があり、このページを見るよりも簡単に理解することができるでしょう.