Child pages
  • WHM API 1 Functions - _getpkgextensionform

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description


Excerpt

This function retrieves a hosting plan's package extension templates.

 When you call this function, the system checks the hosting plan's  _PACKAGE_EXTENSIONS value.


The function returns the contents of the /var/cpanel/packages/extensions/name.tt2 file for each package extension in the list, where name represents the package extension's name.

For more information, read our Guide to Package Extensions.

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/_getpkgextensionform?api.version=1&pkg=package1



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/_getpkgextensionform?api.version=1&pkg=package1



Expand
titleCommand Line


Code Block
languagebash
whmapi1 _getpkgextensionform pkg=package1

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "data":{  
      "html":"<div class="fatBorder" id="dog_Extension">\n<fieldset class="groupEditor">\n<div class="propertyGroup">\n<h3>Dog Settings</h3>\n<div class="propertyEditor">\n    <div class="propertyLabel">Dog Species</div>\n    <div class="propertyValue"><input id="dog_species" type="text" name="dog_species" value="dalmatian"></div>\n</div>\n\n<div class="propertyEditor">\n    <div class="propertyLabel">Tail Length</div>\n    <div class="propertyValue">\n            <input type="radio" id="dogTailLengthTiny" name="dog_tail_length" value="tiny">\n            <label for="dogTailLengthTiny">Tiny</label><br>\n            <input type="radio" id="dogTailLengthNormal" name="dog_tail_length" value="normal">\n            <label for="dogTailLengthNormal">Normal</label><br>\n            <input type="radio" id="dogTailLengthLong" name="dog_tail_length" value="long">\n            <label for="dogTailLengthLong">Long</label>\n    </div>\n</div>\n\n<div class="propertyEditor">\n    <div class="propertyLabel"><label for="dog_spots">Has Spots</label></div>\n    <div class="propertyValue">\n            <input id="dog_spots" type="checkbox" name="dog_spots" value="y" checked="checked">\n    </div>\n</div>\n\n</div>\n</fieldset>\n</div>\n"
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":1,
      "command":"_getpkgextensionform"
   }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
   <data>
      <html>
         <div class="fatBorder" id="dog_Extension"> <fieldset class="groupEditor"> <div class="propertyGroup"> <h3>Dog Settings</h3> <div class="propertyEditor"> <div class="propertyLabel">Dog Species</div> <div class="propertyValue"><input id="dog_species" type="text" name="dog_species" value="dalmatian"></div> </div> <div class="propertyEditor"> <div class="propertyLabel">Tail Length</div> <div class="propertyValue"> <input type="radio" id="dogTailLengthTiny" name="dog_tail_length" value="tiny"> <label for="dogTailLengthTiny">Tiny</label><br> <input type="radio" id="dogTailLengthNormal" name="dog_tail_length" value="normal"> <label for="dogTailLengthNormal">Normal</label><br> <input type="radio" id="dogTailLengthLong" name="dog_tail_length" value="long"> <label for="dogTailLengthLong">Long</label> </div> </div> <div class="propertyEditor"> <div class="propertyLabel"><label for="dog_spots">Has Spots</label></div> <div class="propertyValue"> <input id="dog_spots" type="checkbox" name="dog_spots" value="y" checked="checked"> </div> </div> </div> </fieldset> </div>
      </html>
   </data>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>_getpkgextensionform</command>
   </metadata>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


   

Parameters

ParameterTypeDescriptionPossible valuesExample
pkgstring

Required

The hosting plan's name.

A valid hosting plan name on the server.package1

 

Returns

Note
titleNote:

This function returns only metadata if the hosting plan does not use package extensions, or if the extensions' template files are empty. 


ReturnTypeDescriptionPossible valuesExample
htmlstringThe source code for the hosting plan's extensions' templates.

HTML and Template Toolkit code for one or more package extension forms.


Expand
titleClick to view...
<div class="fatBorder" id="dog_Extension"> <fieldset class="groupEditor"> <div class="propertyGroup"> <h3>Dog Settings</h3> <div class="propertyEditor"> <div class="propertyLabel">Dog Species</div> <div class="propertyValue"><input id="dog_species" type="text" name="dog_species" value="dalmatian"></div> </div> <div class="propertyEditor"> <div class="propertyLabel">Tail Length</div> <div class="propertyValue"> <input type="radio" id="dogTailLengthTiny" name="dog_tail_length" value="tiny"> <label for="dogTailLengthTiny">Tiny</label><br> <input type="radio" id="dogTailLengthNormal" name="dog_tail_length" value="normal"> <label for="dogTailLengthNormal">Normal</label><br> <input type="radio" id="dogTailLengthLong" name="dog_tail_length" value="long"> <label for="dogTailLengthLong">Long</label> </div> </div> <div class="propertyEditor"> <div class="propertyLabel"><label for="dog_spots">Has Spots</label></div> <div class="propertyValue"> <input id="dog_spots" type="checkbox" name="dog_spots" value="y" checked="checked"> </div> </div> </div> </fieldset> </div>