Skip to content

Instantly share code, notes, and snippets.

@earth3300
Last active September 12, 2018 20:40
Show Gist options
  • Select an option

  • Save earth3300/3c9ec7b28ee1f2f6e355cb67d336c04d to your computer and use it in GitHub Desktop.

Select an option

Save earth3300/3c9ec7b28ee1f2f6e355cb67d336c04d to your computer and use it in GitHub Desktop.
File header for a WordPress plugin conforming to the PHPDoc DocBlock Standard. Use this.
<?php
/**
* Plugin Name
*
* @package PluginPackage
* @author Your Name
* @copyright Copyright (c) 2018 Your Name or Company Name
* @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0+
*
* @wordpress-plugin
* Plugin Name: Plugin Name
* Plugin URI: https://example.com/plugin-name
* Description: Description of the plugin.
* Version: 1.0.0
* Author: Your Name
* Author URI: https://example.com
* Text Domain: plugin-name
* License: GPL-3.0+
* License URI: https://www.gnu.org/licenses/gpl-3.0.en.html
@earth3300
Copy link
Author

earth3300 commented Sep 12, 2018

Source: https://codex.wordpress.org/File_Header (Retrieved September 12, 2018).

Other notes: The whole header block must be placed inside the first 8 192 bytes of the file.
See the above link for more detailed specifications.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment