├── plugin.php
├── uninstall.php
├── LICENSE
└── README.md


/plugin.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 | Plugin Name: Your Plugin Name
 4 | Plugin URI: https://github.com/your_name/your_plugin
 5 | Description: One line description of your plugin
 6 | Version: 1.0
 7 | Author: Your Name
 8 | Author URI: https://your-site-if-any/
 9 | */
10 | 
11 | // No direct call
12 | if( !defined( 'YOURLS_ABSPATH' ) ) die();
13 | 
14 | /*
15 | 
16 |  Your code goes here.
17 |  
18 |  Suggested read:
19 |  https://docs.yourls.org/guide/extend/plugins.html
20 |  https://docs.yourls.org/development/plugins.html
21 |  https://docs.yourls.org/development/coding-standards.html
22 |  and in general the whole "Development" section on https://docs.yourls.org/
23 |  
24 |  Have fun!
25 |  
26 | */
27 | 


--------------------------------------------------------------------------------
/uninstall.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | // No direct call.
 3 | if( !defined( 'YOURLS_UNINSTALL_PLUGIN' ) ) die();
 4 | 
 5 | /**
 6 |  * This is an optional file that will be executed when a user deactivates your plugin.
 7 |  *
 8 |  * Example of an uninstall procedure :
 9 |  *
10 |  * - delete custom option :
11 |  *      yourls_delete_option('joe_plugin');
12 |  *
13 |  * - delete custom table :
14 |  *      $table  = 'JOE_CUSTOM_TABLE';
15 |  *      $sql    = "DROP TABLE IF EXISTS :table";
16 |  *      $binds  = array('table' => $table);
17 |  *      $update = yourls_get_db()->fetchAffected($sql, $binds);
18 |  *
19 |  * - delete specific files,
20 |  * - ping plugin's mothership to tell about uninstalling,
21 |  * - etc.
22 |  *
23 |  */
24 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2013-present, The YOURLS Contributors
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # [Plugin Name] [![Listed in Awesome YOURLS!](https://img.shields.io/badge/Awesome-YOURLS-C5A3BE)](https://github.com/YOURLS/awesome-yourls/)
 2 | 
 3 | <!-- Once you have committed code, get your plugin listed in Awesome YOURLS ! See https://github.com/YOURLS/awesome-yourls -->
 4 | 
 5 | :bulb: Plugin short description: what it does
 6 | 
 7 | Requires [YOURLS](https://yourls.org) `<here: min-version if applicable>` and above.
 8 | 
 9 | ## Usage
10 | 
11 | :bulb: This is a great place for showing a few usage examples!
12 | 
13 | :camera: If applicable, a screenshot of the admin interface or anything relevant is super helpful
14 | 
15 | ## Installation
16 | 
17 | :bulb: This is a great place for showing how to install the package. The common way is as below:
18 | 
19 | 1. In `/user/plugins`, create a new folder named `<here: your plugin folder name>`.
20 | 2. Drop these files in that directory.
21 | 3. Go to the Plugins administration page (eg. `http://sho.rt/admin/plugins.php`) and activate the plugin.
22 | 4. Have fun!
23 | 
24 | ## License
25 | 
26 | :bulb: The license might be updated with your terms.
27 | 
28 | This package is licensed under the [MIT License](LICENSE).
29 | 


--------------------------------------------------------------------------------