Hacklog Package: A Guide to Modular WordPress Function Management

Hacklog Package: A Guide to Modular WordPress Function Management

Hacklog Package is a "semi-plugin" designed to centrally manage commonly used WordPress function code. It does not provide a backend configuration interface. Instead, it acts as a code container, allowing you to modularly integrate frequently needed functional code (such as comment reply email notifications, Chinese excerpt truncation, commenter website URL redirection, etc.).

Core Advantages

Compared to directly adding code to your current theme's functions.php file, the main advantages of using this plugin are:

• Theme Independence: When you change your WordPress theme, you do not need to copy and paste these functional codes into the new theme's functions.php again, achieving true "add once, use forever."
• Modular Management: All functional code is stored as independent files within the plugin directory, making it easy to enable, disable, and maintain.

You can manage the plugin files via FTP or the WordPress admin file editor.

How to Add a New Function Module

To add a new function to Hacklog Package, follow these steps:

1. Create the Function File: Write the PHP code that implements the function into a new file, e.g., demo.php, and place this file inside the plugin's includes/ folder.
2. Register the Module: Edit the packages.php file in the plugin's root directory. Add a new registration line following the format of existing entries. For example:

   'demo.php' => array('name' => 'Demo: How to add code', 'enable' => 1),

Parameter Explanation:

• demo.php: The filename (case-sensitive on Linux/BSD hosts).
• name: A descriptive name for the function.
• enable: Whether to enable this function. Set to 1 for enabled, 0 for disabled.

Code Writing Standards

To ensure compatibility and avoid naming conflicts, adhere to the following standards:

• Namespace Prefix: All global variables, function names, and class names within files placed in the includes/ directory must be prefixed with ihacklog_pkg_. Example: function ihacklog_pkg_my_function() {}.
• Resource File Storage: JavaScript files should be placed in the public js/ directory, and CSS files in the public css/ directory.
• Configuration Support: If a function module requires configuration items, you can define them at the beginning of its PHP file in the following format:

  //========= START CONFIGURE ========
  $GLOBALS['ihacklog_pkg_foo'] = array(
      'key' => 'value',
  );
  //========= END CONFIGURE ========

  Subsequently, within your functions, declare global $ihacklog_pkg_foo; to reference these configurations.

Manually Referencing CSS or JS Files in Your Theme

If your function module includes CSS or JavaScript files that need to be loaded on the front end, you can manually reference them in your theme templates using the following method (using a CSS file as an example):

<link rel='stylesheet' type='text/css' media='screen' href='<?php echo plugins_url('hacklog-package'); ?>/css/foo.css' />

Replace foo.css with your actual filename, and ensure the file is stored in the css/ directory as per the standard.