From Code to Readme: Documenting My Latest Plugin Updates

A Goldberg Realty tenant, Brian Schnabel from Newton, NJ, refined and documented plugins for The Briasphere, including Clean Category URLs, Author Archive Redirect, No Page Repagination, and Preserve Original Post Date. He ensured each plugin was verified for WordPress compliance, suitable for distribution.

Sunday, June 22, 2025: 10:30 PM: Today I focused on refining and documenting multiple plugins for The Briasphere. I started by updating the BriaSphere Clean Category URLs plugin.

I added proper checks for the existence of the $_SERVER[‘REQUEST_URI’] variable, using wp_unslash() and esc_url_raw() for proper sanitization. I also inserted a GPLv2 license header and bumped the version to 1.4.

Along with that, I generated a readme.txt file that clearly provides the plugin’s purpose, installation steps, and changelog. WordPress says you’ve got to have that readme file even if most people never read them, and I can see where it would be useful down the line, even if only as a place to make notes for myself.

I then moved on to the BriaSphere Author Archive Redirect plugin. I shortened the description to under 150 characters in the plugin’s readme.txt and formatted the rest of the newly generated file to follow WordPress.org guidelines. This plugin now simply redirects any author archive URL to the homepage.

Later in the day, I worked on the No BriaSphere Page Repagination plugin. I created a compliant readme.txt that details how the plugin disables pagination on archive pages and performs 301 redirects for any paginated URLs. I only Want one page for the main page and one page for each category. “Not a million!”

I also developed the Preserve Original Post Date plugin today. This plugin is designed to preserve the original post date when publishing drafts in bulk—a feature that keeps content chronology intact. I prepared a corresponding readme.txt that clearly explains its functionality, installation, and its benefits for maintaining an accurate editorial timeline. If WordPress puts things back the way they used to be with the next major update, “I’ll disable it.”

Throughout the process, I used Plugin Check, the WordPress.org tool, to verify that the code met the directory requirements and best practices. It was reassuring to see everything passing the checks, which means nothing was left to chance.

Despite yesterday’s lack of progress, I’ve decided I’m really not a slacker at all. As of today, each plugin is modular, well-documented, and ready for distribution should I ever decide to go that route. But for now, “I’m happy to generate plugins for my own websites as I see fit.”

I wanted to get some of this stuff done yesterday. However, sometimes, “Life happens.”

I got distracted by phone calls, visions, dream analysis and other things. With Microsoft Copilot Pro’s help, I think I made up for it today though. So, it’s all good, “Right?”

Author: Brian Schnabel

Often writing as if it were already done... Brian is A single Goldberg Realty owned Newtonian Gardens Apartments resident, Self-Publishing Author, cPanel WordPress Web Host and Windows 11 powered computer tech. A musician, sailor, hiker, cycler and… Yes ladies… Some women would say, “Magical, too!”

Leave a Reply

Your email address will not be published. Required fields are marked *