How to use media_send_to_editor filter in WordPress

media_send_to_editor filter

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

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

In the example below, we have defined a function weplugins_modify_media_send_to_editor_defaults which takes 3 parameters and we registered it using add_filter. The first parameter media_send_to_editor is the name of the hook, the second parameter weplugins_modify_media_send_to_editor_defaults is the name of the function that 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_filter to remove the media_send_to_editor filter.

Parameters

Below are the 3 parameters required to use this hook:

• $html: (string) HTML markup for a media item sent to the editor.
• $send_id: (int) The first key from the $_POST[‘send’] data.
• $attachment: (array) Array of attachment metadata.

Live Example

apply_filters( 'media_send_to_editor', string $html, int $send_id, array $attachment )

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

Example 1: Modifying Media HTML

In this example, we modify the HTML markup for the media item sent to the editor.

    function weplugins_modify_media_send_to_editor_defaults($html, $send_id, $attachment) { 
        // Update the $html variable according to your website requirements and return this variable.
        // You can modify the $html variable conditionally too if you want.
        return $html; 
    }
    // add the filter
    add_filter( "media_send_to_editor", "weplugins_modify_media_send_to_editor_defaults", 10, 3 );
    

Example 2: Removing a Hook Callback

To remove a hook callback, use the example below:

    remove_filter( "media_send_to_editor", "weplugins_modify_media_send_to_editor_defaults", 10, 3 );
    

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

Example 3: Conditionally Modifying Media HTML

In this example, we conditionally modify the HTML markup based on attachment metadata:

    function weplugins_conditional_media_send_to_editor($html, $send_id, $attachment) { 
        if($attachment['type'] == 'image') {
            // Modify HTML for images
            $html = '<div class="custom-image-class">' . $html . '</div>';
        }
        return $html; 
    }
    // add the filter
    add_filter( "media_send_to_editor", "weplugins_conditional_media_send_to_editor", 10, 3 );
    

Contact Us

If you need any customization or are having trouble using this hook, please contact us.