get_bookmark( int|stdClass $bookmark, string $output = OBJECT, string $filter = 'raw' ): array|object|null

Compatibility

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

Parameters

$bookmarkint|stdClass

$outputstringoptional

The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to an stdClass object, an associative array, or a numeric array, respectively. Default OBJECT.Default: OBJECT

$filterstringoptional

How to sanitize bookmark fields. Default 'raw'.Default: 'raw'

Return value

array|object|null

Type returned depends on $output value.

Performance profile

How much work a call to get_bookmark() 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 ->get_row().

Scaling

Constant

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

Instructions

12–74

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

7

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

What it touches

• cacheobject cachewp_cache_add()called directly
• querycontent querywp_get_object_terms()called directly
• sqldatabase query->get_row()called directly
• hookthird-party callbacksapply_filters()one call below get_bookmark()

Further down the call graph this can also reach option, serialize 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 · 16 distinct outcomes

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

Uses · 4

• wp_cache_add()Adds data to the cache, if the cache key doesn't already exist.
• wp_cache_get()Retrieves the cache contents from the cache by key and group.
• wp_get_object_terms()Retrieves the terms associated with the given object(s), in the supplied taxonomies.
• sanitize_bookmark()Sanitizes all bookmark fields.

Used by · 7

• edit_bookmark_link()Displays the edit bookmark link anchor content.
• get_bookmark_field()Retrieves single bookmark data item or field.
• get_edit_bookmark_link()Displays the edit bookmark link.
• get_link()Retrieves bookmark data based on ID.
• get_link_to_edit()Retrieves link data based on its ID.
• wp_ajax_delete_link()Handles deleting a link via AJAX.
• wp_update_link()Updates a link in the database.

Source code

View on Trac ↗View on GitHub ↗

24function get_bookmark( $bookmark, $output = OBJECT, $filter = 'raw' ) {25	global $wpdb;26 27	if ( empty( $bookmark ) ) {28		if ( isset( $GLOBALS['link'] ) ) {29			$_bookmark = & $GLOBALS['link'];30		} else {31			$_bookmark = null;32		}33	} elseif ( is_object( $bookmark ) ) {34		wp_cache_add( $bookmark->link_id, $bookmark, 'bookmark' );35		$_bookmark = $bookmark;36	} else {37		if ( isset( $GLOBALS['link'] ) && ( $GLOBALS['link']->link_id === $bookmark ) ) {38			$_bookmark = & $GLOBALS['link'];39		} else {40			$_bookmark = wp_cache_get( $bookmark, 'bookmark' );41			if ( ! $_bookmark ) {42				$_bookmark = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->links WHERE link_id = %d LIMIT 1", $bookmark ) );43				if ( $_bookmark ) {44					$_bookmark->link_category = array_unique( wp_get_object_terms( $_bookmark->link_id, 'link_category', array( 'fields' => 'ids' ) ) );45					wp_cache_add( $_bookmark->link_id, $_bookmark, 'bookmark' );46				}47			}48		}49	}50 51	if ( ! $_bookmark ) {52		return $_bookmark;53	}54 55	$_bookmark = sanitize_bookmark( $_bookmark, $filter );56 57	if ( OBJECT === $output ) {58		return $_bookmark;59	} elseif ( ARRAY_A === $output ) {60		return get_object_vars( $_bookmark );61	} elseif ( ARRAY_N === $output ) {62		return array_values( get_object_vars( $_bookmark ) );63	} else {64		return $_bookmark;65	}66}

Changelog

Introduced in 2.1.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.9.7 tag, from src/wp-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.