WordPress plugin development - plugin-name.php file and plugin files/folders structure











up vote
1
down vote

favorite












I am creating my first WP/WooCommerce plugin. I was following instructions from WordPress Codex during development, but I wanted to review it here, to make sure I am on the right path. First things I would like to get reviewed are plugin-name.php file and plugin file/folders structure.



Questions/doubts:




  • I was using singleton classes. Is that ok?

  • Did I miss something in plugin-name.php file? Is everything needed there?

  • Is order of code OK in plugin-name.php file? Are if statements OK?

  • About project folder and files structure, is it ok to put my global.css and functions.php in the root of the plugin, along with plugin-name.php file, or should I move them into folder(s)? If yes, how should I name those folders?

  • If there is something that should be different beside these things I mentioned above, please let me know.


plugin-name.php file:



<?php
/**
* Plugin Name: {Plugin name}
* Plugin URI: https://github.com/tahireu/{plugin_name}
* Description: {Description}
* Version: 1.0.0
* Author: Tahireu
* Author URI: https://github.com/tahireu/
* License: GPL
* License URI: http://www.opensource.org/licenses/gpl-license.php
*/


/*
* Prevent intruders from sneaking around
* */
defined( 'ABSPATH' ) or die( 'No script kiddies please!' );


/*
* Variables
* */
const {PLUGIN_NAME}_TEXT_DOMAIN = "wc-{plugin-name}";


/*
* Load {PLUGIN_NAME}_Activator class before WooCommerce check
* */
require plugin_dir_path( __FILE__ ) . 'includes/class-{plugin_name}-activator.php';



/*
* Check if WooCommerce is installed and active
* */
include_once( ABSPATH . 'wp-admin/includes/plugin.php' );
if ( is_plugin_active( 'woocommerce/woocommerce.php' ) ) {


/*
* Current plugin version - https://semver.org
* This should be updated as new versions are released
* */
define( 'WC_{PLUGIN_NAME}_VERSION', '1.0.0' );



/*
* Load functions and classes
* */
require plugin_dir_path( __FILE__ ) . 'functions.php';
require plugin_dir_path( __FILE__ ) . 'admin/class-{plugin-name}-admin.php';
require plugin_dir_path( __FILE__ ) . 'public/class-{plugin-name}-public.php';



/*
* Create database table on plugin activation
* */
function create_table(){
{PLUGIN_NAME}_activator::create_{plugin-name}_table();
}

register_activation_hook( __FILE__, 'create_table' );



/*
* Do the work
* */
{PLUGIN_NAME}_admin::on_load();
{PLUGIN_NAME}_public::on_load();


} else {

/*
* Abort and display info message
* */
{PLUGIN_NAME}_activator::abort();

}


Plugin files/folders structure:



enter image description here










share|improve this question









New contributor




Tahi Reu is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
























    up vote
    1
    down vote

    favorite












    I am creating my first WP/WooCommerce plugin. I was following instructions from WordPress Codex during development, but I wanted to review it here, to make sure I am on the right path. First things I would like to get reviewed are plugin-name.php file and plugin file/folders structure.



    Questions/doubts:




    • I was using singleton classes. Is that ok?

    • Did I miss something in plugin-name.php file? Is everything needed there?

    • Is order of code OK in plugin-name.php file? Are if statements OK?

    • About project folder and files structure, is it ok to put my global.css and functions.php in the root of the plugin, along with plugin-name.php file, or should I move them into folder(s)? If yes, how should I name those folders?

    • If there is something that should be different beside these things I mentioned above, please let me know.


    plugin-name.php file:



    <?php
    /**
    * Plugin Name: {Plugin name}
    * Plugin URI: https://github.com/tahireu/{plugin_name}
    * Description: {Description}
    * Version: 1.0.0
    * Author: Tahireu
    * Author URI: https://github.com/tahireu/
    * License: GPL
    * License URI: http://www.opensource.org/licenses/gpl-license.php
    */


    /*
    * Prevent intruders from sneaking around
    * */
    defined( 'ABSPATH' ) or die( 'No script kiddies please!' );


    /*
    * Variables
    * */
    const {PLUGIN_NAME}_TEXT_DOMAIN = "wc-{plugin-name}";


    /*
    * Load {PLUGIN_NAME}_Activator class before WooCommerce check
    * */
    require plugin_dir_path( __FILE__ ) . 'includes/class-{plugin_name}-activator.php';



    /*
    * Check if WooCommerce is installed and active
    * */
    include_once( ABSPATH . 'wp-admin/includes/plugin.php' );
    if ( is_plugin_active( 'woocommerce/woocommerce.php' ) ) {


    /*
    * Current plugin version - https://semver.org
    * This should be updated as new versions are released
    * */
    define( 'WC_{PLUGIN_NAME}_VERSION', '1.0.0' );



    /*
    * Load functions and classes
    * */
    require plugin_dir_path( __FILE__ ) . 'functions.php';
    require plugin_dir_path( __FILE__ ) . 'admin/class-{plugin-name}-admin.php';
    require plugin_dir_path( __FILE__ ) . 'public/class-{plugin-name}-public.php';



    /*
    * Create database table on plugin activation
    * */
    function create_table(){
    {PLUGIN_NAME}_activator::create_{plugin-name}_table();
    }

    register_activation_hook( __FILE__, 'create_table' );



    /*
    * Do the work
    * */
    {PLUGIN_NAME}_admin::on_load();
    {PLUGIN_NAME}_public::on_load();


    } else {

    /*
    * Abort and display info message
    * */
    {PLUGIN_NAME}_activator::abort();

    }


    Plugin files/folders structure:



    enter image description here










    share|improve this question









    New contributor




    Tahi Reu is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
    Check out our Code of Conduct.






















      up vote
      1
      down vote

      favorite









      up vote
      1
      down vote

      favorite











      I am creating my first WP/WooCommerce plugin. I was following instructions from WordPress Codex during development, but I wanted to review it here, to make sure I am on the right path. First things I would like to get reviewed are plugin-name.php file and plugin file/folders structure.



      Questions/doubts:




      • I was using singleton classes. Is that ok?

      • Did I miss something in plugin-name.php file? Is everything needed there?

      • Is order of code OK in plugin-name.php file? Are if statements OK?

      • About project folder and files structure, is it ok to put my global.css and functions.php in the root of the plugin, along with plugin-name.php file, or should I move them into folder(s)? If yes, how should I name those folders?

      • If there is something that should be different beside these things I mentioned above, please let me know.


      plugin-name.php file:



      <?php
      /**
      * Plugin Name: {Plugin name}
      * Plugin URI: https://github.com/tahireu/{plugin_name}
      * Description: {Description}
      * Version: 1.0.0
      * Author: Tahireu
      * Author URI: https://github.com/tahireu/
      * License: GPL
      * License URI: http://www.opensource.org/licenses/gpl-license.php
      */


      /*
      * Prevent intruders from sneaking around
      * */
      defined( 'ABSPATH' ) or die( 'No script kiddies please!' );


      /*
      * Variables
      * */
      const {PLUGIN_NAME}_TEXT_DOMAIN = "wc-{plugin-name}";


      /*
      * Load {PLUGIN_NAME}_Activator class before WooCommerce check
      * */
      require plugin_dir_path( __FILE__ ) . 'includes/class-{plugin_name}-activator.php';



      /*
      * Check if WooCommerce is installed and active
      * */
      include_once( ABSPATH . 'wp-admin/includes/plugin.php' );
      if ( is_plugin_active( 'woocommerce/woocommerce.php' ) ) {


      /*
      * Current plugin version - https://semver.org
      * This should be updated as new versions are released
      * */
      define( 'WC_{PLUGIN_NAME}_VERSION', '1.0.0' );



      /*
      * Load functions and classes
      * */
      require plugin_dir_path( __FILE__ ) . 'functions.php';
      require plugin_dir_path( __FILE__ ) . 'admin/class-{plugin-name}-admin.php';
      require plugin_dir_path( __FILE__ ) . 'public/class-{plugin-name}-public.php';



      /*
      * Create database table on plugin activation
      * */
      function create_table(){
      {PLUGIN_NAME}_activator::create_{plugin-name}_table();
      }

      register_activation_hook( __FILE__, 'create_table' );



      /*
      * Do the work
      * */
      {PLUGIN_NAME}_admin::on_load();
      {PLUGIN_NAME}_public::on_load();


      } else {

      /*
      * Abort and display info message
      * */
      {PLUGIN_NAME}_activator::abort();

      }


      Plugin files/folders structure:



      enter image description here










      share|improve this question









      New contributor




      Tahi Reu is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.











      I am creating my first WP/WooCommerce plugin. I was following instructions from WordPress Codex during development, but I wanted to review it here, to make sure I am on the right path. First things I would like to get reviewed are plugin-name.php file and plugin file/folders structure.



      Questions/doubts:




      • I was using singleton classes. Is that ok?

      • Did I miss something in plugin-name.php file? Is everything needed there?

      • Is order of code OK in plugin-name.php file? Are if statements OK?

      • About project folder and files structure, is it ok to put my global.css and functions.php in the root of the plugin, along with plugin-name.php file, or should I move them into folder(s)? If yes, how should I name those folders?

      • If there is something that should be different beside these things I mentioned above, please let me know.


      plugin-name.php file:



      <?php
      /**
      * Plugin Name: {Plugin name}
      * Plugin URI: https://github.com/tahireu/{plugin_name}
      * Description: {Description}
      * Version: 1.0.0
      * Author: Tahireu
      * Author URI: https://github.com/tahireu/
      * License: GPL
      * License URI: http://www.opensource.org/licenses/gpl-license.php
      */


      /*
      * Prevent intruders from sneaking around
      * */
      defined( 'ABSPATH' ) or die( 'No script kiddies please!' );


      /*
      * Variables
      * */
      const {PLUGIN_NAME}_TEXT_DOMAIN = "wc-{plugin-name}";


      /*
      * Load {PLUGIN_NAME}_Activator class before WooCommerce check
      * */
      require plugin_dir_path( __FILE__ ) . 'includes/class-{plugin_name}-activator.php';



      /*
      * Check if WooCommerce is installed and active
      * */
      include_once( ABSPATH . 'wp-admin/includes/plugin.php' );
      if ( is_plugin_active( 'woocommerce/woocommerce.php' ) ) {


      /*
      * Current plugin version - https://semver.org
      * This should be updated as new versions are released
      * */
      define( 'WC_{PLUGIN_NAME}_VERSION', '1.0.0' );



      /*
      * Load functions and classes
      * */
      require plugin_dir_path( __FILE__ ) . 'functions.php';
      require plugin_dir_path( __FILE__ ) . 'admin/class-{plugin-name}-admin.php';
      require plugin_dir_path( __FILE__ ) . 'public/class-{plugin-name}-public.php';



      /*
      * Create database table on plugin activation
      * */
      function create_table(){
      {PLUGIN_NAME}_activator::create_{plugin-name}_table();
      }

      register_activation_hook( __FILE__, 'create_table' );



      /*
      * Do the work
      * */
      {PLUGIN_NAME}_admin::on_load();
      {PLUGIN_NAME}_public::on_load();


      } else {

      /*
      * Abort and display info message
      * */
      {PLUGIN_NAME}_activator::abort();

      }


      Plugin files/folders structure:



      enter image description here







      php plugin wordpress






      share|improve this question









      New contributor




      Tahi Reu is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.











      share|improve this question









      New contributor




      Tahi Reu is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.









      share|improve this question




      share|improve this question








      edited 2 days ago









      Jamal

      30.2k11115226




      30.2k11115226






      New contributor




      Tahi Reu is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.









      asked 2 days ago









      Tahi Reu

      63




      63




      New contributor




      Tahi Reu is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.





      New contributor





      Tahi Reu is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.






      Tahi Reu is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.



























          active

          oldest

          votes











          Your Answer





          StackExchange.ifUsing("editor", function () {
          return StackExchange.using("mathjaxEditing", function () {
          StackExchange.MarkdownEditor.creationCallbacks.add(function (editor, postfix) {
          StackExchange.mathjaxEditing.prepareWmdForMathJax(editor, postfix, [["\$", "\$"]]);
          });
          });
          }, "mathjax-editing");

          StackExchange.ifUsing("editor", function () {
          StackExchange.using("externalEditor", function () {
          StackExchange.using("snippets", function () {
          StackExchange.snippets.init();
          });
          });
          }, "code-snippets");

          StackExchange.ready(function() {
          var channelOptions = {
          tags: "".split(" "),
          id: "196"
          };
          initTagRenderer("".split(" "), "".split(" "), channelOptions);

          StackExchange.using("externalEditor", function() {
          // Have to fire editor after snippets, if snippets enabled
          if (StackExchange.settings.snippets.snippetsEnabled) {
          StackExchange.using("snippets", function() {
          createEditor();
          });
          }
          else {
          createEditor();
          }
          });

          function createEditor() {
          StackExchange.prepareEditor({
          heartbeatType: 'answer',
          convertImagesToLinks: false,
          noModals: true,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: null,
          bindNavPrevention: true,
          postfix: "",
          imageUploader: {
          brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
          contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
          allowUrls: true
          },
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          });


          }
          });






          Tahi Reu is a new contributor. Be nice, and check out our Code of Conduct.










           

          draft saved


          draft discarded


















          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f208452%2fwordpress-plugin-development-plugin-name-php-file-and-plugin-files-folders-str%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown






























          active

          oldest

          votes













          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes








          Tahi Reu is a new contributor. Be nice, and check out our Code of Conduct.










           

          draft saved


          draft discarded


















          Tahi Reu is a new contributor. Be nice, and check out our Code of Conduct.













          Tahi Reu is a new contributor. Be nice, and check out our Code of Conduct.












          Tahi Reu is a new contributor. Be nice, and check out our Code of Conduct.















           


          draft saved


          draft discarded














          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f208452%2fwordpress-plugin-development-plugin-name-php-file-and-plugin-files-folders-str%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown





















































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown

































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown







          Popular posts from this blog

          Morgemoulin

          Scott Moir

          Souastre