wp_insert_link( array $linkdata, bool $wp_error = false ): int|WP_Error

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$linkdataarray

Elements that make up the link to insert.

• $link_idint

  Optional. The ID of the existing link if updating.

• $link_urlstring

  The URL the link points to.

• $link_namestring

  The title of the link.

• $link_imagestring

  Optional. A URL of an image.

• $link_targetstring

  Optional. The target element for the anchor tag.

• $link_descriptionstring

  Optional. A short description of the link.

• $link_visiblestring

  Optional. 'Y' means visible, anything else means not.

• $link_ownerint

  Optional. A user ID.

• $link_ratingint

  Optional. A rating for the link.

• $link_relstring

  Optional. A relationship of the link to you.

• $link_notesstring

  Optional. An extended description of or notes on the link.

• $link_rssstring

  Optional. A URL of an associated RSS feed.

• $link_categoryint

  Optional. The term ID of the link category. If empty, uses default link category.

$wp_errorbooloptional

Whether to return a WP_Error object on failure. Default false.Default: false

Return value

int|WP_Error

Value 0 or WP_Error on failure. The link ID on success.

Performance profile

How much work a call to wp_insert_link() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via ->insert().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

112–140

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 217.

Plugin surface

2 hooks

Third-party callbacks on 'edit_link', 'add_link' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksdo_action()called directly
• sqldatabase query->insert()called directly
• cacheobject cachewp_cache_get()one call below wp_insert_link()
• serializeserialisationmaybe_unserialize()one call below wp_insert_link()

Further down the call graph this can also reach query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 24 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_insert_link() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 2

2 hooks fire while wp_insert_link() runs, in this order:

1. 1
   do_action( edit_link )actionline 254 (+80 into the body)

   Fires after a link was updated in the database.

2. 2
   do_action( add_link )actionline 263 (+89 into the body)

   Fires after a link was added to the database.

Uses · 11

• wp_parse_args()Merges user defined arguments into defaults array.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• sanitize_bookmark()Sanitizes all bookmark fields.
• get_current_user_id()Gets the current user's ID.
• current_time()Retrieves the current time based on specified type.
• get_option()Retrieves an option value based on an option name.
• __()Retrieves the translation of $text.
• wp_set_link_cats()Updates link with the specified link categories.
• do_action()Calls the callback functions that have been added to an action hook.
• clean_bookmark_cache()Deletes the bookmark cache.
• WP_Error::__construct()Initializes the error.

Used by · 2

• edit_link()Updates or inserts a link using values provided in $_POST.
• wp_update_link()Updates a link in the database.

Source code

View on Trac ↗View on GitHub ↗

174function wp_insert_link( $linkdata, $wp_error = false ) {175	global $wpdb;176 177	$defaults = array(178		'link_id'     => 0,179		'link_name'   => '',180		'link_url'    => '',181		'link_rating' => 0,182	);183 184	$parsed_args = wp_parse_args( $linkdata, $defaults );185	$parsed_args = wp_unslash( sanitize_bookmark( $parsed_args, 'db' ) );186 187	$link_id   = $parsed_args['link_id'];188	$link_name = $parsed_args['link_name'];189	$link_url  = $parsed_args['link_url'];190 191	$update = false;192	if ( ! empty( $link_id ) ) {193		$update = true;194	}195 196	if ( '' === trim( $link_name ) ) {197		if ( '' !== trim( $link_url ) ) {198			$link_name = $link_url;199		} else {200			return 0;201		}202	}203 204	if ( '' === trim( $link_url ) ) {205		return 0;206	}207 208	$link_rating      = ( ! empty( $parsed_args['link_rating'] ) ) ? $parsed_args['link_rating'] : 0;209	$link_image       = ( ! empty( $parsed_args['link_image'] ) ) ? $parsed_args['link_image'] : '';210	$link_target      = ( ! empty( $parsed_args['link_target'] ) ) ? $parsed_args['link_target'] : '';211	$link_visible     = ( ! empty( $parsed_args['link_visible'] ) ) ? $parsed_args['link_visible'] : 'Y';212	$link_owner       = ( ! empty( $parsed_args['link_owner'] ) ) ? $parsed_args['link_owner'] : get_current_user_id();213	$link_notes       = ( ! empty( $parsed_args['link_notes'] ) ) ? $parsed_args['link_notes'] : '';214	$link_description = ( ! empty( $parsed_args['link_description'] ) ) ? $parsed_args['link_description'] : '';215	$link_rss         = ( ! empty( $parsed_args['link_rss'] ) ) ? $parsed_args['link_rss'] : '';216	$link_rel         = ( ! empty( $parsed_args['link_rel'] ) ) ? $parsed_args['link_rel'] : '';217	$link_category    = ( ! empty( $parsed_args['link_category'] ) ) ? $parsed_args['link_category'] : array();218	$link_updated     = gmdate( 'Y-m-d H:i:s', current_time( 'timestamp', 0 ) );219 220	// Make sure we set a valid category.221	if ( ! is_array( $link_category ) || 0 === count( $link_category ) ) {222		$link_category = array( get_option( 'default_link_category' ) );223	}224 225	if ( $update ) {226		if ( false === $wpdb->update( $wpdb->links, compact( 'link_url', 'link_name', 'link_image', 'link_target', 'link_description', 'link_visible', 'link_owner', 'link_rating', 'link_rel', 'link_notes', 'link_rss', 'link_updated' ), compact( 'link_id' ) ) ) {227			if ( $wp_error ) {228				return new WP_Error( 'db_update_error', __( 'Could not update link in the database.' ), $wpdb->last_error );229			} else {230				return 0;231			}232		}233	} else {234		if ( false === $wpdb->insert( $wpdb->links, compact( 'link_url', 'link_name', 'link_image', 'link_target', 'link_description', 'link_visible', 'link_owner', 'link_rating', 'link_rel', 'link_notes', 'link_rss', 'link_updated' ) ) ) {235			if ( $wp_error ) {236				return new WP_Error( 'db_insert_error', __( 'Could not insert link into the database.' ), $wpdb->last_error );237			} else {238				return 0;239			}240		}241		$link_id = (int) $wpdb->insert_id;242	}243 244	wp_set_link_cats( $link_id, $link_category );245 246	if ( $update ) {247		/**248		 * Fires after a link was updated in the database.249		 *250		 * @since 2.0.0251		 *252		 * @param int $link_id ID of the link that was updated.253		 */

Changelog

Introduced in 2.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-admin/includes/bookmark.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.