Preserve Code Formatting

Beschreibung

This plugin preserves formatting of code for display by preventing its modification by WordPress and other plugins while also retaining whitespace.

NOTE: Use of the visual text editor will pose problems as it can mangle your intent in terms of code tags. I strongly suggest you not use the visual editor in conjunction with this plugin as I have taken no effort to make the two compatible.

Notes:

Basically, you can just paste code into code, pre, and/or other tags you additionally specify and this plugin will:

  • Prevent WordPress from HTML-encoding text (i.e. single- and double-quotes will not become curly; „–“ and „—“ will not become en dash and em dash, respectively; „…“ will not become a horizontal ellipsis, etc)
  • Prevent most other plugins from modifying preserved code
  • Prevent shortcodes from being processed
  • Optionally preserve whitespace (in a variety of methods)
  • Optionally preserve code added in comments

Keep these things in mind:

  • ALL embedded HTML tags and HTML entities will be rendered as text to browsers, appearing exactly as you wrote them (including any br tags).
  • By default this plugin filters ‚the_content‘ (post content), ‚the_excerpt‘ (post excerpt), and ‚get_comment_text (comment content)‘.

Example:

A post containing this within code tags:

$wpdb->query("
        INSERT INTO $tablepostmeta
        (post_id,meta_key,meta_value)
        VALUES ('$post_id','link','$extended')
");

Would, with this plugin enabled, look in a browser pretty much how it does above, instead of like:

$wpdb->query(—
INSERT INTO $tablepostmeta
(post_id,meta_key,meta_value)
VALUES ('$post_id','link','$extended')
―);

Links: Plugin Homepage | Plugin Directory Page | GitHub | Author Homepage

Screenshots

  • A screenshot of the plugin's admin options page.

Installation

  1. Whether installing or updating, whether this plugin or any other, it is always advisable to back-up your data before starting
  2. Install via the built-in WordPress plugin installer. Or download and unzip preserve-code-formatting.zip inside the plugins directory for your site (typically wp-content/plugins/)
  3. Activate the plugin through the ‚Plugins‘ admin menu in WordPress
  4. Go to the Settings -> Code Formatting admin settings page (which you can also get to via the Settings link next to the plugin on the Manage Plugins page) and customize the settings.
  5. Write a post with code contained within opening and closing code tags (using the HTML editor, not the Visual editor).

FAQ

Why does my code still display all funky? (by the way, I’m using the visual editor)

The visual editor has a tendency to screw up some of your intent, especially when you are attempting to include raw code. This plugin does not make any claims about working when you create posts with the visual editor enabled.

Can I put shortcode examples within code tags and not have them be evaluated by WordPress?

Yes, shortcodes within code tags (or any tag processed by this plugin) will be output as pure text and not be processed as shortcodes by WordPress.

Does this plugin include unit tests?

Yes.

Rezensionen

3. September 2016
Brilliant. I don't know what it did in the background, but this plugin works like a charm. Wish it had more options to change the font and things like that for the .
3. September 2016
This plugin help me, works fine, thanks for it. Plase keep updated when need it. Regards
Lies alle 3 Rezensionen

Mitwirkende & Entwickler

„Preserve Code Formatting“ ist Open-Source-Software. Folgende Menschen haben an diesem Plugin mitgewirkt:

Mitwirkende

Änderungsprotokoll

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).

Full changelog is available in CHANGELOG.md.