[GitHub/WoltLab/woltlab.github.io.git] / docs / package / pip / pip.md

# Package Installation Plugin Package Installation Plugin

Registers new package installation plugins.

## Components

Each package installation plugin is described as an `<pip>` element with a `name` attribute and a PHP classname as the text content.

!!! warning "The package installation plugin’s class file must be installed into the `wcf` application and must not include classes outside the `\wcf\*` hierarchy to allow for proper uninstallation!"

## Example

{jinja{ codebox(
  title="packageInstallationPlugin.xml",
  language="xml",
  filepath="package/pip/packageInstallationPlugin.xml"
) }}
Commit	Line	Data
8659eb86	1	# Package Installation Plugin Package Installation Plugin
0b768461	2
be3fe035 TD	3	Registers new package installation plugins.
	4
	5	## Components
	6
	7	Each package installation plugin is described as an `<pip>` element with a `name` attribute and a PHP classname as the text content.
	8
9003992d	9	!!! warning "The package installation plugin’s class file must be installed into the `wcf` application and must not include classes outside the `\wcf\*` hierarchy to allow for proper uninstallation!"
be3fe035 TD	10
	11	## Example
	12
9a3f5fa3	13	{jinja{ codebox(
f778fce2 MS	14	title="packageInstallationPlugin.xml",
	15	language="xml",
	16	filepath="package/pip/packageInstallationPlugin.xml"
9a3f5fa3	17	) }}