Manual:$wgUploadDialog

Translate this page

Files and file uploads: $wgUploadDialog
Configuration for Upload dialog and the files uploaded through it.
Introduced in version:	1.27.0 (Gerrit change 289126; git #2aaeb356)
Removed in version:	Still in use
Allowed values:	(multi-dimensional array)
Default value:	see below
Other settings: Alphabetical \| By function

The $wgUploadDialog global allows for configuration of the Upload dialog (selecting fields to display, modifying the licensing options, and choosing special formatting for the file page which will be created and the upload comment).

This applies also to foreign uploads to this wiki, if configured (the configuration is loaded by remote wikis using the action=query&meta=siteinfo API).

Default values

See below for documentation of each property. None of the properties may be omitted.

MediaWiki version:

≥ 1.28

$wgUploadDialog = [
	'fields' => [
		'description' => true,
		'date' => false,
		'categories' => false,
	],
	'licensemessages' => [
		'local' => 'generic-local',
		'foreign' => 'generic-foreign',
	],
	'comment' => [
		'local' => '',
		'foreign' => '',
	],
	'format' => [
		'filepage' => '$DESCRIPTION',
		'description' => '$TEXT',
		'ownwork' => '',
		'license' => '',
		'uncategorized' => '',
	],
];

MediaWiki version:

1.27

$wgUploadDialog = [
	'fields' => [
		'description' => true,
		'date' => false,
		'categories' => false,
	],
	'licensemessages' => [
		'local' => 'generic-local',
		'foreign' => 'generic-foreign',
	],
	'comment' => '',
	'format' => [
		'filepage' => '$DESCRIPTION',
		'description' => '$TEXT',
		'ownwork' => '',
		'license' => '',
		'uncategorized' => '',
	],
];

Properties

fields

Fields to make available in the dialog. true means that this field is visible, false means that it is hidden. Note that you also have to add the matching replacement to the 'filepage' format key to make use of these.

Available fields:

'description' - file description
'categories' - categories
'date' - file creation date

The "Name" field can't be hidden.

licensemessages

Suffix of localisation messages used to describe the license under which the uploaded file will be released. The same value may be set for both 'local' and 'foreign' uploads.

The 'local' messages are used for local uploads on the wiki. The 'foreign' messages are used for cross-wiki uploads from other wikis to the wiki, if configured.

The default values correspond to:

'generic-local'

upload-form-label-own-work-message-generic-local	I confirm that I am uploading this file following the terms of service and licensing policies on MediaWiki.
upload-form-label-not-own-work-message-generic-local	If you are not able to upload this file under the policies of MediaWiki, please close this dialog and try another method.
upload-form-label-not-own-work-local-generic-local	You may also want to try the default upload page.

'generic-foreign'

upload-form-label-own-work-message-generic-foreign	I understand that I am uploading this file to a shared repository. I confirm that I am doing so following the terms of service and licensing policies there.
upload-form-label-not-own-work-message-generic-foreign	If you are not able to upload this file under the policies of the shared repository, please close this dialog and try another method.
upload-form-label-not-own-work-local-generic-foreign	You may also want to try using the upload page on MediaWiki, if this file can be uploaded there under their policies.

comment

Upload comment to use. Available replacements:

$HOST - domain name from which a cross-wiki upload originates
$PAGENAME - wiki page name from which an upload originates

This allows the wiki and the page where the upload was initiated to be documented in the upload comment.

Starting with MediaWiki 1.28, this can also be set to an array to specify different upload comments for local and foreign uploads:

$wgUploadDialog = [
	...
	'comment' => [
		'local' => '...',
		'foreign' => '...',
	],
	...
];

format

Format of the file page wikitext to be generated from the fields input by the user. This defines how the specified fields are used to construct the file description page.

'filepage' - a wrapper for the whole page. Available replacements:
- $DESCRIPTION - file description, as input by the user (only if the 'description' field is enabled), wrapped as defined below in the 'description' key
- $DATE - file creation date, as input by the user (only if the 'date' field is enabled)
- $SOURCE - currently, this is always the value defined below in the 'ownwork' key. The upload dialog may be extended in the future to allow choosing other sources.
- $AUTHOR - linked user name of the uploader. The upload dialog may be extended in the future to allow choosing other authorship information.
- $LICENSE - currently, this is always the value defined below in the 'license' key. The upload dialog may be extended in the future to allow choosing other licenses.
- $CATEGORIES - file categories wikitext, as input by the user (only if the 'categories' field is enabled), or if no input, as defined below in the 'uncategorized' key
'description' - wrapper for the file description, as input by the user. Available replacements:
- $LANGUAGE - source wiki's content language. This is mostly useful for foreign uploads.
- $TEXT - input by the user
'ownwork' - used for $SOURCE in 'filepage'
'license' - used for $LICENSE in 'filepage'
'uncategorized' - used for $CATEGORIES in 'filepage' when the user input no categories