Skip to main content

Regex for Word footnotes to Simple Footnotes

3 min read

Summary: Regular Expression to automatically parse Microsoft Word’s footnote format into a more web-friendly format for WordPress’s Simple Footnotes plugin

Heads up! This post is archived and here for historical purposes. It may no longer be accurate or reflect my views. Proceed at your own risk.

I needed a quick-and-easy way to parse Microsoft Word’s footnote format into a more web-friendly format for a recent project. After a bit of regular expression hacking, I was able to build a WordPress plugin to automatically convert content pasted from Word into a format readable by Andrew Nacin’s popular Simple Footnotes plugin.

The process is simple, thanks to WordPress’s extensive filter API. First, to grab the footnotes from Word’s ftnref format:

<?php
//grab all the Word-style footnotes into an array
$pattern = '#<a href\="\#_ftnref([0-9-]+)">\[([0-9-]+)\]</a> (.*)#';
preg_match_all( $pattern, $content, $footnotes, PREG_SET_ORDER);
?>

This creates an array ($footnotes) with the both the footnote number and the text of the footnote. We then need a way to replace the in-text reference with the parsed footnotes so that Simple Footnotes can understand them. I did this by creating two arrays, a find array and a replace array with each Word-style footnote reference and its Simple Footnote formatted counterpart:

<?php
//build find and replace arrays
foreach ($footnotes as $footnote) {
$find[] = '#<a href\="\#_ftn'.$footnote[1].'">\['.$footnote[1].'\]</a>#';
$replace[] = '[ref]' . str_replace( array("\r\n", "\r", "\n"), "", $footnote[3]). '[/ref]';
}
?>

Finally, so that the entire replacement can be done in a single pass, push a final find/replace pair into the end of the array, to remove the original footnotes:

<?php
//remove all the original footnotes when done
$find[] = '#<div>\s*<a href\="\#_ftnref([0-9]+)">\[([0-9]+)\]</a> (.*)\s*</div>\s+#';
$replace[] = '';
?>

Because PHP’s preg_replace function can handle arrays, all we have to do is run a single function:

<?php
$content = preg_replace( $find, $replace, $content );
?>

You can find the full plugin code in the GitHub repository.

To use, you can download the plugin file1 and activate (be sure you already have Simple Footnotes installed). Copy the content from Word, and Paste into the “Paste from Word” box (may need to toggle the “Kitchen Sink”.2

Thoughts? Improvements? The above code solved a rather stubborn workflow problem in a project I was working on, and I hope it can do the same for you. Feel free to use/improve the above code.

Footnotes

Footnotes 2
  1. Licensed under GPLv2 ↩︎

  2. You can even Fork the plugin over on GitHub ↩︎

Keep reading

Ben Balter

I'm Ben Balter, and I write here about developer platforms, product and engineering leadership, open source, and showing your work. I spent over a decade building developer platforms at GitHub. For five years I was a product manager for trust and safety, shipping 500+ features and the API endpoints behind them to 50M+ developers. I also led a bottom-up rewrite of GitHub Pages and wrote the open source library behind GitHub's license detection, and my open source projects have hundreds of millions of downloads. I wrote Open and Async, the playbook for remote and distributed teams, and shipped a Model Context Protocol (MCP) server alongside it so agents can query it directly. More about the author

Follow along: Bluesky LinkedIn

Originally published March 20, 2011 View revision history

This page is open source Help improve this article on GitHub

Keyboard shortcuts

Search

  • / or ⌘ K Open search
  • ↓ or j ↑ or k Move through results
  • Enter Open the selected result
  • Esc Close search

Go to

  • g then h Home
  • g then p All posts

This page

  • y Copy link to this page
  • ? Show this list

Turn off if you use voice control or keep triggering them by accident. ⌘ K still opens search, and this list stays under "Keyboard shortcuts" in the footer.