Accurate documentation of hook_follow_networks_alter: patch included [#1247952]

The current follow.api.php file is incorrect and can lead anyone trying to add his/her own networks down the path of frustration and resentment :)

It should read:

/**
 * Alter the available networks to the Follow module.
 *
 * @param $networks
 *   Associative array of networks that are available.
 * @param $uid
 *   The User ID of the networks to be displayed. If 0 is provided, will be the
 *   networks for the website rather then an individual user.
 */
function hook_follow_networks_alter(&$networks, $uid = 0) {
  // Add a network.
  $networks[$uid]['mailinglist'] = array(
    'title' => t('Mailing List'),
    'domain' => 'mailinglist.domain.com',
  );

  // Replace Twitter with Identi.ca
  unset($networks[$uid]['twitter']);
  $networks[$uid]['identica'] = array(
    'title' => t('Identi.ca'),
    'domain' => 'identi.ca',
  );
}

Patch below.

Comment	File	Size	Author
	follow_api_updated.patch	652 bytes	perusio

Comments

Comment #1

stefanx commented 9 September 2011 at 00:28

Please excuse my ignorance I still don't understand what to do. How can I, a Drupal newbie, enable Identi.ca and a Mailinglist in Follow module?

Comment #3

stefanx commented 10 September 2011 at 18:16

I intent to add Identi.ca in addition to Twitter, not replacing it. In this case, I assume I have to remove the line "unset($networks[$uid]['twitter']);". Correct?

Ahhh, create an own module! :-) I did so, installed and enabled the module successfully. But no mailinglist and identi.ca links are displayed. :-( Any idea?

Here is the content of my .info file:

name = MyFollow
description = Follow mailing list and Identi.ca
core = 7.x
dependencies[] = follow

Comment #4

perusio commented 11 September 2011 at 13:17

This should work (myfollow.module):

/**
 * Alter the available networks to the Follow module.
 *
 * @param $networks
 *   Associative array of networks that are available.
 * @param $uid
 *   The User ID of the networks to be displayed. If 0 is provided, will be the
 *   networks for the website rather then an individual user.
 */
function myfollow_follow_networks_alter(&$networks, $uid = 0) {
  // Add a network.
  $networks[$uid]['mailinglist'] = array(
    'title' => t('Mailing List'),
    'domain' => 'mailinglist.domain.com',
  );

  // Add Identi.ca to the list of networks.
  $networks[$uid]['identica'] = array(
    'title' => t('Identi.ca'),
    'domain' => 'identi.ca',
  );
}

And the info file (myfollow.info):

name = MyFollow
description = Follow mailing list and Identi.ca
core = 7.x
dependencies[] = follow
files[] = myfollow.module

Comment #5

stefanx commented 13 September 2011 at 01:35

Thanks a lot for your support. This works. :-)

In order to display icons, I will add the following code to follow.css and add the icons into the folders.

a.follow-link-identica {
background-image: url(icons/small/icon-identica.png);
}
a.follow-link-mailinglist {
background-image: url(icons/small/icon-mailinglist.png);
}

Hope it is sufficient.

What I don't understand is why identi.ca and mailinglist support are not included in the module by default. Since you already wrote the code, why not integrate it into the module by default and make user's life easier. :-)