Public Member Functions

Pingback Class Reference

Inheritance diagram for Pingback:
Collaboration diagram for Pingback:

List of all members.

Public Member Functions

 action_plugin_activation ($file)
 action_plugin_deactivation ($file)
 action_post_insert_after ($post)
 action_post_update_after ($post)
 action_add_template_vars ()
 xmlrpc_pingback__ping ($params)
 send_pingback ($source_uri, $target_uri, $post=NULL)
 pingback_all_links ($content, $source_uri, $post=NULL, $force=false)
 filter_admin_option_items ($items)
 theme_pingback_count ($theme, $post, $zero= '', $one= '', $many= '')

Detailed Description

Definition at line 13 of file pingback.plugin.php.


Member Function Documentation

Pingback::action_add_template_vars (  ) 

Add the Pingback header on single post/page requests Not to the entire site. Clever.

Definition at line 73 of file pingback.plugin.php.

Pingback::action_plugin_activation ( file  ) 

Register the Pingback event type with the event log

Definition at line 19 of file pingback.plugin.php.

Pingback::action_plugin_deactivation ( file  ) 

Unregister the Pingback event type on deactivation

Todo:
Should we be doing this?

Definition at line 30 of file pingback.plugin.php.

Pingback::action_post_insert_after ( post  ) 

Pingback links from the post content when a post is inserted into the database.

Parameters:
post The post from which to send pingbacks

Definition at line 41 of file pingback.plugin.php.

Pingback::action_post_update_after ( post  ) 

Pingback mentioned links when a post is updated.

Parameters:
Post $post The post is updated We invoke this function regardless of what might have been updated in the post because:

  • this will only execute if the post is published
  • the pingback_all_links function keeps track of links its already pinged, so if the content hasnt changed no pings will be sent`

Definition at line 60 of file pingback.plugin.php.

Pingback::filter_admin_option_items ( items  ) 

Add the pingback options to the options page

Parameters:
array $items The array of option on the options page
Returns:
array The array of options including new options for pingback

Definition at line 404 of file pingback.plugin.php.

Pingback::pingback_all_links ( content,
source_uri,
post = NULL,
force = false 
)

Scan all links in the content and send them a Pingback.

Parameters:
string $content The post content to search
string $source_uri The source of the content
Post $post The post object of the source of the ping
boolean $force If true, force the system to ping all links even if that had been pinged before

Definition at line 350 of file pingback.plugin.php.

Referenced by action_post_insert_after(), and action_post_update_after().

Pingback::send_pingback ( source_uri,
target_uri,
post = NULL 
)

Send a single Pingback

Parameters:
string $source_uri The URI source of the ping (here)
string $target_uri The URI destination of the ping (there, the site linked to in the content)
Post $post The post object that is initiating the ping, used to track the pings that were sent
Todo:
If receive error code of already pinged, add to the successful.

Definition at line 266 of file pingback.plugin.php.

Referenced by pingback_all_links().

Pingback::theme_pingback_count ( theme,
post,
zero = '',
one = '',
many = '' 
)

Returns a full qualified URL of the specified post based on the comments count.

Passed strings are localized prior to parsing therefore to localize "%d Comments" in french, it would be "%d Commentaires".

Since we use sprintf() in the final concatenation, you must format passed strings accordingly.

Parameters:
Theme $theme The current theme object
Post $post Post object used to build the pingback link
string $zero String to return when there are no pingbacks
string $one String to return when there is one pingback
string $many String to return when there are more than one pingback
Returns:
string String to display for pingback count

Definition at line 429 of file pingback.plugin.php.

Pingback::xmlrpc_pingback__ping ( params  ) 

Receive a Pingback via XMLRPC

Parameters:
array $params An array of XMLRPC parameters from the remote call
Returns:
string The success state of the pingback

Sanitize Data

Definition at line 91 of file pingback.plugin.php.


The documentation for this class was generated from the following file: