A site for Joomla! documentation

Joomla! Programmers Documentation

Manual Index

Install

Creating a script which directly includes loads and boots the CMS framework is not recommended and only needed in rare cases. Depending on the usecase you should create a [console plugin](jdocmanual?article=docus/plugins/plugin-examples-basic-console-plugin-helloworld.md) and extend the Joomla! console application. If you need to create a simple entry point for webrequests write an [ajax plugin](jdocmanual?article=docus/plugins/plugin-examples-ajax-plugin.md).

Installing your Custom Script

If you have access to the file system of your web application then you can obviously just copy your script into the folder of your choice.

If instead you want to install your script in the usual way, then you must use "file" as your extension type in the manifest file, for example.

<?xml version="1.0" encoding="utf-8"?>
<extension type="file" version="5.1" method="upgrade">
    <name>Custom Script</name>
    <version>1.0</version>
    <description>Script to count the number of articles in the database</description>
    <fileset>
        <files target="cli">
            <filename>myscript.php</filename>
        </files>
    </fileset>
</extension>

Installing this will result in the script "myscript.php" being put into the Joomla cli directory.