Home
Welcome to our custom plugin built exclusively for the RCN website (https://realitycapturenetwork.com). Our goal with this plugin is to enhance the visual appeal and functionality of the RCN website by incorporating advanced features while minimizing the need for additional plugins.
The primary motivation behind creating this plugin is to streamline the RCN website by reducing the reliance on multiple plugins and implementing bespoke functionalities that cannot be achieved with off-the-shelf solutions.
Customization and Limitations
It's important to note that this plugin is tailored specifically for the RCN website and cannot be used with other websites. All the code within the plugin is designed to integrate seamlessly with the RCN website's architecture.
Please be aware that our plugin is not plug-and-play. It requires configuration to function properly. The configuration process necessitates a deep understanding of WordPress theme and plugin development, as it involves manual code adjustments. Most configurations do not have a graphical interface and must be handled directly in the code.
The RCN Plugin Documentation serves as the central hub for understanding our plugin's functionality, codebase, and development philosophy.
General Documentation Pages
-
Home Page: Offers a detailed overview of the entire project, including explanations of code, folder structure, functionality, and the underlying logic behind our approach.
-
Utility Functions Documentation: Provides detailed documentation for each method, aiding in understanding their usage, underlying logic and implementation.
Feature-Specific Documentation
For each feature, we've organized separate documentation folders. Additionally, we've tailored documentation for the technologies used in developing these features.
Example: Vendor Package Checkout Enhancement Feature
In the "Vendor Package Improvement" folder, you'll find documentation for our enhancement feature. Here's what you can expect:
- PHP Class Document: Detailed documentation for the PHP class utilized in the feature.
- JavaScript (jQuery) File Document: Explanation of the jQuery codes embedded in the JS file.
- CSS File Document: Overview of the CSS stylesheets employed to enhance the feature's presentation.
We strive to provide clarity and thoroughness in our documentation. Should you have any questions or need further assistance, please don't hesitate to contact Becca.
This plugin was initially built using the WPPB boilerplate code. Refer to the blog post "Intro to WPPB Boilerplate for WordPress plugins" for insights into the WPPB folder structure.
We adhere to the WPPB folder structure. Additionally, for public-facing features, we create new files within public -> partialcs for PHP, public -> js for JavaScript/jQuery codes, and public -> css for CSS codes. The approach is the same for admin as well.
To enhance loading performance, we prefer to load the CSS and JS files only on the pages where the corresponding feature functions.