Open main menu

Manual:フック/GetPreferences

This page is a translated version of the page Manual:Hooks/GetPreferences and the translation is 32% complete.

Other languages:
English • ‎español • ‎français • ‎polski • ‎português do Brasil • ‎中文 • ‎日本語
GetPreferences
version 1.16.0 から利用可能
Modify user preferences.
関数の定義:
public static function onGetPreferences( User $user, array &$preferences ) { ... }
フックのアタッチ:

extension.json 内:

{
	"Hooks": {
		"GetPreferences": "MyExtensionHooks::onGetPreferences"
	}
}

MediaWiki 1.25 以前では:

$wgHooks['GetPreferences'][] = 'MyExtensionHooks::onGetPreferences';
呼び出し元:ファイル: preferences/DefaultPreferencesFactory.php

フックの付け方の詳細はManual:フックの情報を参照してください。
このフックを使用する拡張機能の例については、Category:GetPreferences extensions/ja を参照してください。

使用法

パラメーター

パラメーター/オプション 説明
$user User whose preferences are being modified
&$preferences Preferences description array, to be fed to an HTMLForm object


In extension.json:

"Hooks": {
  "GetPreferences": [ "MediaWiki\\Extension\\ExampleExtension\\Hooks::onGetPreferences" ]
}

In includes/Hooks.php:

namespace MediaWiki\Extension\ExampleExtension;

class Hooks {
	/**
	 * @param User $user
	 * @param array $preferences
	 */
	public static function onGetPreferences( $user, &$preferences ) {
		// A checkbox
		$preferences['mypref'] = [
			'type' => 'toggle',
			'label-message' => 'tog-mypref', // a system message
			'section' => 'personal/info',
		];

		// A set of radio buttons. Notice that in the 'options' array,
		// the keys are the text (not system messages), and the values are the HTML values.
		// They keys/values might be the opposite of what you expect. PHP's array_flip()
		// can be helpful here.
		$preferences['mypref2'] = [
			'type' => 'radio',
			'label-message' => 'tog-mypref2', // a system message
			'section' => 'personal/info',
			// Array of options. Key = text to display. Value = HTML <option> value.
			'options' => [
				'Pick me please' => 'choice1',
				'No, pick me!' => 'choice2',
				'Seriously, pick me right now' => 'choice3',
			],
			'default' => 'choice1',  // A 'default' key is required!
			'help-message' => 'tog-help-mypref2', // a system message (optional)
		];
	}
}


Tabs and sections

The section array key specifies which tab and section of Preferences contains your preferences. If your section value is foo/bar, this means your preference will appear on the foo tab (named by system message prefs-foo) within the bar section (named by system message prefs-bar). If no such tab or section exists, it is created automatically.

List of default tabs

識別子 Displays as
personal 利用者情報
rendering 表示
editing 編集
rc 最近の更新
watchlist ウォッチリスト
misc その他

Supported types

Visible types

The type can take on various values found in the HTMLForm::$typeMappings array in the file includes/htmlform/HTMLForm.php, including info, multiselect, radio, etc.

Most preferences are stored in the same format as is used by the HTMLFormField, but in the case of 'type' => 'usersmultiselect' a transformation should be carried out from a newline-separated list of usernames (which is what the form widget works with) and a newline-separated list of user IDs (which is what gets stored in the database). See the treatment of email-blacklist (in core) or echo-notifications-blacklist (in Echo) for examples of this.

API preferences

API preferences use type 'api'. They are not displayed in Special:Preferences.

Default preferences

To set the default value for a preference (i.e. the value that is set for a new user that hasn't customized their preferences yet), add the setting to the $wgDefaultUserOptions global variable. Use the same key name as you use for $preferences in the hook.

Alternatively, if you're writing an extension, you can add to the DefaultUserOptions section of the file extensions.json.