coffee2code

Extended Description

Installation

Filters

The plugin exposes four filters for hooking. Typically, the code to utilize these hooks would go inside your active theme’s functions.php file.

c2c_linkify_text_filters (filter)

The ‘c2c_linkify_text_filters’ hook allows you to customize what hooks get text linkification applied to them.

Arguments:

• $hooks (array): Array of hooks that will be text linkified.

Example:

// Enable text linkification for custom fields
add_filter( 'c2c_linkify_text_filters', 'more_text_replacements' );
function more_text_replacements( $filters ) {
    $filters[] = 'the_meta'; // Here you could put in the name of any filter you want
    return $filters;
}

c2c_linkify_text_comments (filter)

The ‘c2c_linkify_text_comments’ hook allows you to customize or override the setting indicating if text linkification should be enabled in comments.

Arguments:

• $state (bool): Either true or false indicating if text linkification is enabled for comments. The default value will be the value set via the plugin’s settings page.

Example:

// Prevent text linkification from ever being enabled in comments.
add_filter( 'c2c_linkify_text_comments', '__return_false' );

c2c_linkify_text (filter)

The ‘c2c_linkify_text’ hook allows you to customize or override the setting defining all of the text phrases and their associated links.

Arguments:

• $linkify_text_array (array): Array of text and their associated links. The default value will be the value set via the plugin’s settings page.

Example:

// Add more text to be linked
add_filter( 'c2c_linkify_text', 'my_text_linkifications' );
function my_text_linkifications( $replacements ) {
    // Add text link
    $replacements['Matt Mullenweg'] => 'http://ma.tt';
    // Unset a text link that we never want defined
    if ( isset( $replacements['WordPress'] ) )
        unset( $replacements['WordPress'] );
    // Important!
    return $replacements;
}

c2c_linkify_text_case_sensitive (filter)

The ‘c2c_linkify_text_case_sensitive’ hook allows you to customize or override the setting indicating if text matching for potential text linkification should be case sensitive or not.

Arguments:

• $state (bool): Either true or false indicating if text matching is case sensitive. The default value will be the value set via the plugin’s settings page.

Example:

// Prevent text matching from ever being case sensitive.
add_filter( 'c2c_linkify_text_case_sensitive', '__return_false' );

Frequently Asked Questions

Q. Does this plugin modify the post content in the database?
A. No. The plugin filters post content on-the-fly.

Q. Will this work for posts I wrote prior to installing this plugin?
A. Yes, if they include strings that you’ve now defined with links.

Q. What post fields get handled by this plugin?
A. By default, the plugin filters the post content, post excerpt fields, widget text, and optionally comments and comment excerpts. You can use the ‘c2c_linkify_text_filters’ filter to modify that behavior (see Filters section).

Q. How can I get text linkification to apply for custom fields (or something not linkified by default)?
A. You can add to the list of filters that get text linkified using something like this (added to your theme’s functions.php file, for instance):

// Enable text linkification for custom fields
add_filter( 'c2c_linkify_text_filters', 'more_text_replacements' );
function more_text_replacements( $filters ) {
    $filters[] = 'the_meta'; // Here you could put in the name of any filter you want
    return $filters;
}

Q. Is the plugin case sensitive?
A. By default, yes. There is a setting you can change to make it case insensitive. Or you can use the ‘c2c_linkify_text_case_sensitive’ filter (see Filters section).

Q. What if the word or phrase is already linked in a post?
A. Already linked text will not get linked again by this plugin (regardless of what the link may be).

Release Log

1.0

• Initial release

Copyright & Disclaimer