Home » Functions » wp_insert_link

Function Name: wp_insert_link

Explanation: The wp_insert_link function is a powerful WordPress function that is used to insert a new link into the WordPress database. This function allows you to programmatically add a new link to your website’s link manager without manually adding it through the WordPress admin interface. This can be especially useful if you have a large number of links to add or if you want to automate the process of adding links.

Usage: To use the wp_insert_link function, you need to provide an associative array of parameters that define the details of the link you want to insert. The available parameters include ‘link_url’, ‘link_name’, ‘link_image’, ‘link_target’, ‘link_description’, ‘link_visible’, ‘link_owner’, and ‘link_rating’.

Here’s an example usage code that demonstrates how to use the wp_insert_link function to insert a new link to a website:

$link_data = array(
    'link_url' => 'http://example.com',
    'link_name' => 'Example Link',
    'link_target' => '_blank',
    'link_description' => 'This is an example link',
    'link_visible' => 'Y',
    'link_owner' => 1,
    'link_rating' => 5,

$link_id = wp_insert_link($link_data);

if (!is_wp_error($link_id)) {
    echo 'Link inserted successfully with ID: ' . $link_id;
} else {
    echo 'Error inserting link: ' . $link_id->get_error_message();

In this example, we’re using the wp_insert_link function to insert a new link with details such as the URL, name, target, description, visibility, owner, and rating. The function will return the ID of the newly inserted link if successful, or a WP_Error object if there was an error. We then use conditional statements to display the appropriate message based on the outcome of the function call.

Overall, the wp_insert_link function is a useful tool for automating the process of adding links to your WordPress website, saving you time and effort in managing your link collection.

Learn More on WordPress.org

Register an account to save your snippets or go Pro to get more features.