How to use pre_ping action in WordPress

pre_ping action

Fires just before pinging back links found in a post.

To use the pre_ping action, first you have to register it using add_action. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function execute_on_pre_ping_event which takes 3 parameters and we registered it using add_action. The first parameter pre_ping is the name of the hook, the second parameter execute_on_pre_ping_event is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times, and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook, so you can use remove_action to remove the pre_ping action.

Parameters

Below are the 3 parameters required to use this hook.

• $post_links: (string[]) Array of link URLs to be checked (passed by reference).
• $pung: (string[]) Array of link URLs already pinged (passed by reference).
• $post_ID: (int) The post ID.

Live Example 1

Disables pingbacks from your own site.

    /**
     * Disables pingbacks from your own site.
     */
    add_action( 'pre_ping', function ( &$post_links, &$pung, int $post_ID ) {
        foreach ( $post_links as $key => $link ) {
            if ( 0 === strpos( $link, home_url() ) ) {
                unset( $post_links[ $key ] );
            }
        }
    }, 10, 3 );
    

Live Example 2

Below is an example of how you can use this hook.

    function weplugins_execute_on_pre_ping_event($post_links, $pung, $post_ID){
       //You can write code here to be executed when this action occurs in WordPress. 
       //Use the parameters received in the function arguments & implement the required 
       //additional custom functionality according to your website requirements.
    }
    // add the action
    add_action( "pre_ping", "weplugins_execute_on_pre_ping_event" , 10, 3);
    

Live Example 3

To remove a hook callback, use the example below.

    remove_action( "pre_ping", "weplugins_execute_on_pre_ping_event", 10, 3 );
    

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Contact Us

If you need any customization, feel free to contact us.