docs/package/pip/pip.md

   1 # Package Installation Plugin Package Installation Plugin
   2
   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
   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!"
  10
  11 ## Example
  12
  13 ```xml
  14 <?xml version="1.0" encoding="UTF-8"?>
  15 <data xmlns="http://www.woltlab.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.woltlab.com http://www.woltlab.com/XSD/2019/packageInstallationPlugin.xsd">
  16         <import>
  17                 <pip name="custom">wcf\system\package\plugin\CustomPackageInstallationPlugin</pip>
  18         </import>
  19         <delete>
  20                 <pip name="outdated" />
  21         </delete>
  22 </data>
  23 ```