freelinking.api.php in Freelinking 7.3

API documentation for Freelinking.

File

freelinking.api.php

<?php

/**
 * @file
 *  API documentation for Freelinking.
 */

/**
 * Used to define plugins or add new values to plugins.
 *
 * For more on creating or modifying plugins, see help file
 * "creating-plugins.html".
 */
function hook_freelinking() {
  $plugins['myplugin'] = array(
    'indicator' => '/myplugin/',
    'translate' => array(
      ' ' => '_',
    ),
    'replacement' => 'http://example.com/node/%1',
  );
  return $plugins;
}

/**
 * Used to modify the array of link values that are eventually passed
 * on to the theme functions to become links.
 *
 * Error messages and strings returned from plugins are not processed by
 * this hook. Errors are directly themed and returned, and strings are
 * simply passed back to the text. (In the latter "mode", freelinking
 * could be used to generate something other than a link.)
 *
 * @param $link
 *  Array suitable for passing to l().
 *
 * @param $context
 *  Array of information from parsed linking syntax.
 *
 */
function hook_freelink_alter(&$link, $context) {
  $plugin_name = $context['plugin_name'];
  if ($plugin_name == 'stark_link') {
    unset($link[2]['attributes']['class']);
    unset($link[2]['attributes']['title']);
  }
  elseif ($plugin_name == 'green_link') {
    $link[2]['attributes']['class'][] = 'green';
  }
}

/*
 * Hook to alter plugins.
 *
 * In this example, the callback for the nid plugin is altered to a
 * something that is part of your module.
 *
 * @param $plugins
 *  Array of plugin definitions.
 *
 * @param $context
 *  Array of information from parsed linking syntax.
 *
 */
function hook_freelinking_alter(&$plugins, $context) {
  if ('freelinking_get_plugins' == $context) {
    $plugins['nid']['callback'] = 'mymodule_nid_callback';
  }
}

/**
 * Individual modules may implement a theme_freelink_pluginname().
 * Doing so will override the standard theme_freelink().
 * Modules must still implement hook_theme to declare their theme function.
 *
 * In this example, the "pluginname" plugin is themed to become an image
 * to the targeted URL, instead of a link.
 */
function theme_freelink_pluginname($variables) {
  $link = $variables['link'];

  // TODO: Should this theme freelink_pluginname be declared in hook_theme()?
  return theme('image', array(
    'path' => $link[1],
    'width' => $link[0],
    'height' => $link[2]['attributes']['title'],
  ));
}

Functions

Name	Description
hook_freelinking	Used to define plugins or add new values to plugins.
hook_freelinking_alter
hook_freelink_alter	Used to modify the array of link values that are eventually passed on to the theme functions to become links.
theme_freelink_pluginname	Individual modules may implement a theme_freelink_pluginname(). Doing so will override the standard theme_freelink(). Modules must still implement hook_theme to declare their theme function.