# Changelog

## 5.0 _(2025-08-10)_

### Highlights:

This major release significantly improves security, performance, and compatibility. The plugin framework updates to version 070 for enhanced security and features. Block editor content is now properly excluded (the plugin was designed for text view), and compatibility extends through WordPress 6.8+ while dropping support for versions older than 5.5. Additional improvements include better error handling, enhanced documentation, and the addition of CSS classes for styling processed code blocks.

### Details:

* Security and hardening:
    * Hardening: Prevent regex pattern injection vulnerability
    * Hardening: Prevent object injection vulnerability. Props Patchstack.
    * Hardening: Prevent bypassing preprocessor by removing any explicit pseudo-tags from content
    * Hardening: Prevent processing of excessively large content
    * Hardening: Prevent unintended markup in translated strings before display
    * Hardening: Prevent content-native usage of token string used internally to chunk data
* Performance:
    * Change: Improve performance of processing tags to be preserved
    * Change: Bail early if there are no tags configured to be preserved
    * Change: Skip tags that have no content
    * Change: Centralize regex patterns in new `get_preprocess_regex_pattern()` and `get_postprocess_regex_pattern()`
    * Change: Use more efficient `preg_replace_callback()` for tag extractions
* Block editor and content handling:
    * New: Prevent processing of all block editor content (plugin was designed for text view, not block editor)
    * Fix: Prevent unintended greediness when multiple instances of a tag are present
* UI and styling:
    * New: Output class of "preserve-code-formatting" for all tags that were processed
    * Change: Output example 'code' and 'pre' tags within 'code' tags within setting page description
* Framework and compatibility:
    * Change: Update plugin framework to 070
        * A significant update from the previous version 061.
        * 070:
        * New: Allow options to define a boolean or callback via 'disabled' to determine if input should be disabled
        * New: Add `is_option_required()` to determine if an option is required
        * New: Add `is_option_disabled()` to determine if an option is disabled
        * Change: In `display_option()`, add dynamically assigned classes locally
        * Change: Add 'regular-text' class to password input field
        * Change: Hide password toggle by default and require plugin to implement functionality
        * Change: Bump plugin CSS version to 010
        * 069:
        * New: Wrap a password input field in markup to facilitate a password toggle
        * New: Add `get_c2c_strings()` to return all translatable strings (mostly for unit testing)
        * Change: Move PHPCS-related comments onto the same line as their associated phpcs:ignore comments
        * Unit tests:
            * Ensure that `get_c2c_string()` knows about all translatable strings
        * 068:
        * Change: Discontinue unnecessary explicit loading of textdomain
        * Change: Ignore a PHPCS warning that doesn't apply
        * Change: Minor code reformatting
        * Change: Note compatibility through WP 6.8+
        * Change: Update copyright date (2025)
        * Unit tests:
            * Change: Generify unit tests to centralize per-plugin configuration to the top of the test class
            * Change: Define method return types for PHP 8+ compatibility
            * New: Add some header documentation
        * 067:
        * Breaking: Require config attribute 'input_attributes' to be an array
        * Hardening: Treat input attributes as array and escape each element before output
        * Change: Ensure config attribute values are of the same datatype as their defaults
        * Change: Simplify `form_action_url()` to avoid using a server global
        * Change: Use `form_action_url()` in `plugin_action_links()` rather than duplicating its functionality
        * Change: Escape output of all translated strings
        * Change: Make `get_hook()` public rather than protected
        * Change: Explicitly declare object variables rather than doing so dynamically
        * Change: Convert `register_filters()` to an abstract declaration
        * Change: Use double quotes for attribute of paragraph for setting description
        * Change: Prevent unwarranted PHPCS complaints about nonces
        * Change: Improve function documentation
        * Change: Adjust function documentation formatting to align with WP core
        * Change: Note compatibility through WP 6.5+
        * Change: Drop compatibility with version of WP older than 5.5
        * Change: Update copyright date (2024)
        * 066:
        * New: Add customization of capability needed to manage plugin settings (via new filter {plugin_prefix}_manage_options_capability)
        * Change: Add styles for nested lists within settings descriptions
        * Change: Note compatibility through WP 6.3+
        * 065:
        * New: Add support for 'inline_help' setting configuration option
        * New: Add support for 'raw_help' setting configuration option
        * New: Add support for use of lists within settings descriptions
        * Change: Add an 'id' attribute to settings form
        * Change: Add styles for disabled input text fields and inline setting help notices
        * Change: Support 'number' input by assigning 'small-text' class
        * Change: Tweak styling for settings page footer
        * Change: Note compatibility through WP 6.2+
        * Change: Update copyright date (2023)
        * 064:
        * New: For checkbox settings, support a 'more_help' config option for defining help text to appear below checkbox and its label
        * Fix: Fix URL for plugin listing donate link
        * Change: Store donation URL as object variable
        * Change: Update strings used for settings page donation link
        * 063:
        * Fix: Simplify settings initialization to prevent conflicts with other plugins
        * Change: Remove ability to detect plugin settings page before current screen is set, as it is no longer needed
        * Change: Enqueue thickbox during `'admin_enqueue_scripts'` action instead of during `'init'`
        * Change: Use `is_plugin_admin_page()` in `help_tabs()` instead of reproducing its functionality
        * Change: Trigger a debugging warning if `is_plugin_admin_page()` is used before `'admin_init'` action is fired
        * 062:
        * Change: Update `is_plugin_admin_page()` to use `get_current_screen()` when available
        * Change: Actually prevent object cloning and unserialization by throwing an error
        * Change: Check that there is a current screen before attempting to access its property
        * Change: Remove 'type' attribute from `style` tag
        * Change: Incorporate commonly defined styling for inline_textarea
    * Change: Note compatibility through WP 6.8+
    * Change: Drop compatibility with versions of WP older than 5.5
    * Change: Note compatibility through PHP 8.3+
    * Change: Update copyright date (2025)
* Code quality and documentation:
    * New: Add FAQ entry explaining nested tag deficiency
    * Change: Update `get_c2c_string()` to add new strings
    * Change: Improve some docblock documentation
    * Change: Tweak some `README.md` formatting
    * Change: Tweak installation instructions
    * Change: Reduce number of tags defined in readme.txt
    * Change: Note removal of development and testing related files from release packaging
    * Change: Add missing release dates for earlier releases, as well as add an omitted release
* Development and testing:
    * New: Add `.gitignore` file
    * Fix: Allow tests to run against current versions of WordPress
    * New: Add a bunch of new tests
    * New: Add test object property for skipping known failing tests (enabled by default)
    * New: Add `composer.json` for PHPUnit Polyfill dependency
    * Change: Restructure unit test file structure
        * New: Create new subdirectory `tests/phpunit/` to house all files related to unit testing PHP
        * Change: Move `bin/` to `tests/bin/`
        * Change: Move `tests/test-*.php` to `tests/phpunit/tests/`
        * Change: Rename `phpunit.xml` to `phpunit.xml.dist` per best practices
    * Hardening: Prevent direct web access to `bootstrap.php`
    * Change: Explicitly define return types for overridden method
    * Fix: Merge `setUpBeforeClass()` into `setUp()` to fix initialization timing
    * Change: In bootstrap, store path to plugin directory and file into constants for use within that file and in test files

## 4.0.1 _(2021-04-14)_
* Fix: Update plugin framework to 061 to fix a bug preventing settings from getting saved

## 4.0 _(2021-04-03)_

### Highlights:

This recommended release prevents potential conflicts with other plugins (such as SyntaxHighlighter), updates the plugin framework, and notes compatibility through WP 5.7+.

### Details:

* Change: Use `{!{` and `}!}` instead of `[[` and `]]` to prevent interpretation as shortcodes, fixing conflict with SyntaxHighlighter. Props azito122.
* Change: Update plugin framework to 060
    * 060:
    * Rename class from `c2c_{PluginName}_Plugin_051` to `c2c_Plugin_060`
    * Move string translation handling into inheriting class making the plugin framework code plugin-agnostic
        * Add abstract function `get_c2c_string()` as a getter for translated strings
        * Replace all existing string usage with calls to `get_c2c_string()`
    * Handle WordPress's deprecation of the use of the term "whitelist"
        * Change: Rename `whitelist_options()` to `allowed_options()`
        * Change: Use `add_allowed_options()` instead of deprecated `add_option_whitelist()` for WP 5.5+
        * Change: Hook `allowed_options` filter instead of deprecated `whitelist_options` for WP 5.5+
    * New: Add initial unit tests (currently just covering `is_wp_version_cmp()` and `get_c2c_string()`)
    * Add `is_wp_version_cmp()` as a utility to compare current WP version against a given WP version
    * Refactor `contextual_help()` to be easier to read, and correct function docblocks
    * Don't translate urlencoded donation email body text
    * Add inline comments for translators to clarify purpose of placeholders
    * Change PHP package name (make it singular)
    * Tweak inline function description
    * Note compatibility through WP 5.7+
    * Update copyright date (2021)
    * 051:
    * Allow setting integer input value to include commas
    * Use `number_format_i18n()` to format integer value within input field
    * Update link to coffee2code.com to be HTTPS
    * Update `readme_url()` to refer to plugin's readme.txt on plugins.svn.wordpress.org
    * Remove defunct line of code
* Change: Move translation of all parent class strings into main plugin file
* Change: Note compatibility through WP 5.7+
* Change: Update copyright date (2021)

## 3.9.2 _(2020-07-01)_

### Highlights:

This minor release updates its plugin framework, adds a TODO.md file, updates a few URLs to be HTTPS, expands unit testing, updates compatibility to be WP 4.9 through 5.4+, and minor documentation tweaks.

### Details:

* Change: Update plugin framework to 050
    * Allow a hash entry to literally have '0' as a value without being entirely omitted when saved
    * Output donation markup using `printf()` rather than using string concatenation
    * Update copyright date (2020)
    * Note compatibility through WP 5.4+
    * Drop compatibility with version of WP older than 4.9
* New: Add TODO.md and move existing TODO list from top of main plugin file into it (and add more items to the list)
* Change: Note compatibility through WP 5.4+
* Change: Drop compatibility for version of WP older than 4.9
* Change: Tweak FAQ verbiage and add an entry addressing code block compatibility
* Change: Update installation instruction to clarify its use within the two types of editors and the two classic editor modes
* Change: Update links to coffee2code.com to be HTTPS
* Unit tests:
    * New: Add test for `options_page_description()`
    * New: Add tests for default hooks
    * New: Add test for setting name
    * New: Add test to verify shortcodes within preserved tags don't get replaced
    * Change: Store plugin instance in class variable to simplify referencing it
    * Change: Use HTTPS for link to WP SVN repository in bin script for configuring unit tests (and delete commented-out code)

## 3.9.1 _(2020-01-04)_
* Fix: Don't attempt to handle posts containing a code block
* Change: Note compatibility through WP 5.3+
* Change: Update copyright date (2020)

## 3.9 _(2019-04-26)_

### Highlights:

This release is a minor update that verifies compatibility through WordPress 5.1+ and makes minor behind-the-scenes improvements.

### Details:

* Change: Initialize plugin on `plugins_loaded` action instead of on load
* Change: Update plugin framework to 049
    * 049:
    * Correct last arg in call to `add_settings_field()` to be an array
    * Wrap help text for settings in `label` instead of `p`
    * Only use `label` for help text for checkboxes, otherwise use `p`
    * Ensure a `textarea` displays as a block to prevent orphaning of subsequent help text
    * Note compatibility through WP 5.1+
    * Update copyright date (2019)
    * 048:
    * When resetting options, delete the option rather than setting it with default values
    * Prevent double "Settings reset" admin notice upon settings reset
    * 047:
    * Don't save default setting values to database on install
    * Change "Cheatin', huh?" error messages to "Something went wrong.", consistent with WP core
    * Note compatibility through WP 4.9+
    * Drop compatibility with version of WP older than 4.7
* Unit tests:
    * New: Add unit test for settings defaults
    * Change: Update unit test install script and bootstrap to use latest WP unit test repo
    * Change: Use actual setting name in a unit test
* Change: Cast settings values as either array or bool before use, as/if appropriate
* New: Add CHANGELOG.md file and move all but most recent changelog entries into it
* New: Add README.md link to plugin's page in Plugin Directory
* Change: Note compatibility through WP 5.1+
* Change: Wrap function docblocks at roughly 80 characters
* Change: Update copyright date (2019)
* Change: Update License URI to be HTTPS
* Change: Split paragraph in README.md's "Support" section into two

## 3.8 _(2018-01-04)_

### Highlights:

This release consists of minor behind-the-scenes changes.

### Details:

* Change: Update plugin framework to 046
    * 046:
    * Fix `reset_options()` to reference instance variable `$options`
    * Note compatibility through WP 4.7+
    * Update copyright date (2017)
    * 045:
    * Ensure `reset_options()` resets values saved in the database
    * 044:
    * Add `reset_caches()` to clear caches and memoized data. Use it in `reset_options()` and `verify_config()`
    * Add `verify_options()` with logic extracted from `verify_config()` for initializing default option attributes
    * Add  `add_option()` to add a new option to the plugin's configuration
    * Add filter 'sanitized_option_names' to allow modifying the list of whitelisted option names
    * Change: Refactor `get_option_names()`
    * 043:
    * Disregard invalid lines supplied as part of hash option value
    * 042:
    * Update `disable_update_check()` to check for HTTP and HTTPS for plugin update check API URL
    * Translate "Donate" in footer message
* New: Add README.md
* Change: Store setting name in constant
* Change: Unit tests:
    * Add and update unit tests
    * Prevent direct invocation
    * Default `WP_TESTS_DIR` to `/tmp/wordpress-tests-lib` rather than erroring out if not defined via environment variable
    * Enable more error output for unit tests
* Change: Add GitHub link to readme
* Change: Note compatibility through WP 4.9+
* Change: Drop compatibility with versions of WP older than 4.7
* Change: Update copyright date (2018)

## 3.7 _(2016-03-29)_

### Highlights:

This release largely consists of minor behind-the-scenes changes.

### Details:

* Change: Update plugin framework to 041
    * Change class name to `c2c_PreserveCodeFormatting_Plugin_041` to be plugin-specific
    * Set textdomain using a string instead of a variable
    * Don't load textdomain from file
    * Change admin page header from 'h2' to 'h1' tag
    * Add `c2c_plugin_version()`
    * Formatting improvements to inline docs
* Change: Add support for language packs:
    * Set textdomain using a string instead of a variable
    * Don't load textdomain from file
    * Remove .pot file and /lang subdirectory
    * Remove 'Domain Path' from plugin header.
* New: Add LICENSE file.
* New: Add empty index.php to prevent files from being listed if web server has enabled directory listings.
* Change: Declare class as final.
* Change: Explicitly declare methods in unit tests as public or protected.
* Change: Minor tweak to description.
* Change: Minor code reformatting (spacing).
* Change: Minor improvements to inline docs and test docs.
* Change: Note compatibility through WP 4.5+.
* Change: Remove support for WordPress older than 4.1.
* Change: Update copyright date (2016).

## 3.6 _(2015-02-24)_
* Cast some variable as array to avoid potential PHP warnings
* Add more unit tests
* Update plugin framework to 039
* Explicitly declare `activation()` and `uninstall()` static
* Reformat plugin header
* Minor code reformatting (spacing, bracing)
* Change documentation links to wp.org to be https
* Minor documentation spacing changes throughout
* Note compatibility through WP 4.1+
* Update copyright date (2015)
* Add plugin icon
* Regenerate .pot

## 3.5 _(2014-01-11)_
* Add setting to control if code should be preserved in posts (default is true)
* Don't wrap 'pre' tags in 'pre' despite settings values
* Update plugin framework to 037
* Better singleton implementation:
    * Add `get_instance()` static method for returning/creating singleton instance
    * Make static variable 'instance' private
    * Make constructor protected
    * Make class final
    * Additional related changes in plugin framework (protected constructor, erroring `__clone()` and `__wakeup()`)
* Add unit tests
* Add checks to prevent execution of code if file is directly accessed
* Re-license as GPLv2 or later (from X11)
* Add 'License' and 'License URI' header tags to readme.txt and plugin file
* Use explicit path for require_once()
* Discontinue use of PHP4-style constructor
* Discontinue use of explicit pass-by-reference for objects
* Remove ending PHP close tag
* Minor documentation improvements
* Minor code reformatting (spacing, bracing)
* Note compatibility through WP 3.8+
* Drop compatibility with version of WP older than 3.6
* Add comments explaining use of base64_encode and base64_decode
* Update copyright date (2014)
* Regenerate .pot
* Change plugin description (to make it shorter)
* Change donate link
* Omit final closing PHP tag
* Add assets directory to plugin repository checkout
* Update screenshot
* Move screenshot into repo's assets directory
* Add banner

## 3.2 _(2011-12-14)_
* Fix bug with settings form not appearing in MS
* Update plugin framework to 032
* Remove support for `c2c_preserve_code_formatting` global
* Note compatibility through WP 3.3+
* Drop support for versions of WP older than 3.1
* Change parent constructor invocation
* Create 'lang' subdirectory and move .pot file into it
* Regenerate .pot
* Add 'Domain Path' directive to top of main plugin file
* Add link to plugin directory page to readme.txt
* Add text and FAQ question regarding how shortcodes are prevented from being evaluated
* Tweak installation instructions in readme.txt
* Update screenshot for WP 3.3
* Update copyright date (2012)

## 3.1 _(2011-07-12)_
* Fix to properly register activation and uninstall hooks
* Update plugin framework to version v023
* Save a static version of itself in class variable $instance
* Deprecate use of global variable `$c2c_preserve_code_formatting` to store instance
* Add `__construct()`, `activation()`, and `uninstall()`
* Explicitly declare functions public and variable private
* Remove declarations of instance variable which have since become part of the plugin framework
* Note compatibility through WP 3.2+
* Drop compatibility with version of WP older than 3.0
* Minor code formatting changes (spacing)
* Update copyright date (2011)
* Add plugin homepage and author links in description in readme.txt

## 3.0 _(2010-09-28)_
* Re-implementation by extending `C2C_Plugin_016`, which among other things adds support for:
    * Reset of options to default values
    * Better sanitization of input values
    * Offload of core/basic functionality to generic plugin framework
    * Additional hooks for various stages/places of plugin operation
    * Easier localization support
* Full localization support
* Change storing plugin instance in global variable to `$c2c_preserve_code_formatting` (instead of `$preserve_code_formatting`), to allow for external manipulation
* Rename class from `PreserveCodeFormatting` to `c2c_PreserveCodeFormatting`
* Remove docs from top of plugin file (all that and more are in readme.txt)
* Note compatibility with WP 2.9+, 3.0+
* Drop compatibility with versions of WP older than 2.8
* Add PHPDoc documentation
* Minor tweaks to code formatting (spacing)
* Add package info to top of plugin file
* Add Upgrade Notice section to readme.txt
* Update copyright date
* Remove trailing whitespace
* Add .pot file

## 2.5.4 _(2009-08-31)_
* Fix some borked code preservation by restoring some processing removed in previous release

## 2.5.3 _(2009-08-20)_
* Fix recently introduced bug affecting occasional code preservation by using a more robust alternative approach
* Fix "Settings" link for plugin in plugin listing, which lead to blank settings page
* Change help text for preservable tags settings input to be more explicit

## 2.5.2 _(2009-08-07)_
* Fix to retain any attributes defined for tags being preserved
* Fix recently introduced bug affecting occasional code preservation

## 2.5.1 _(2009-08-02)_
* Fix newly introduced bug that added unnecessary slashes to preserved code
* Fix long-running bug where intended slashes in code got stripped on display (last remaining known bug)

## 2.5 _(2009-07-30)_
* Fix long-running bug that caused some preserved code to appear garbled
* Update a lot of internal plugin management code
* Add 'Settings' link to plugin's plugin listing entry
* Use `plugins_url()` instead of hardcoded path
* Bring admin markup in line with modern conventions
* Minor reformatting (spacing)
* Note compatibility through WP2.8+
* Dropp support for pre-WP2.6
* Update copyright date
* Update screenshot

## 2.1 _(2008-04-13)_
* Change filter priority from 1 to 2
* Remove newline after tag
* Add Plugin URI
* Remove www from coffee2code.com links
* Change installation instructions
* Add compatibility note for WP2.5
* Update readme.txt

## 2.0 _(2008-01-28)_
* Complete rewrite
* Now properly handles code embedded in comments
* Create its own class to encapsulate plugin functionality
* Add admin options page under Options -> Code Formatting (or in WP 2.5: Settings -> Code Formatting). Options are now saved to database, negating need to customize code within the plugin source file.
* Remove function anti_wptexturize() as the new handling approach negates its need
* Change description; updated installation instructions
* Add compatibility note
* Update copyright date
* Move into its own subdirectory; added readme.txt and screenshot
* Verify compatibility with WP 2.3.3 and 2.5

## 0.9 _(2008-01-27)_
* Initial release