get_bookmark_field() – Function | Developer.WordPress.org

get_bookmark_field( string $field, int $bookmark, string $context = 'display' ): string|WP_Error

Retrieves single bookmark data item or field.

Parameters

$fieldstringrequired: The name of the data field to return.
$bookmarkintrequired: The bookmark ID to get field.
$contextstringoptional: The context of how the field will be used. Default 'display'.
Default:'display'

Return

Source

function get_bookmark_field( $field, $bookmark, $context = 'display' ) {
	$bookmark = (int) $bookmark;
	$bookmark = get_bookmark( $bookmark );

	if ( is_wp_error( $bookmark ) ) {
		return $bookmark;
	}

	if ( ! is_object( $bookmark ) ) {
		return '';
	}

	if ( ! isset( $bookmark->$field ) ) {
		return '';
	}

	return sanitize_bookmark_field( $field, $bookmark->$field, $bookmark->link_id, $context );
}

View all references View on Trac View on GitHub

Uses	Description
sanitize_bookmark_field()`wp-includes/bookmark.php`	Sanitizes a bookmark field.
get_bookmark()`wp-includes/bookmark.php`	Retrieves bookmark data.
is_wp_error()`wp-includes/load.php`	Checks whether the given variable is a WordPress Error.

Show 1 more Show less

Changelog

Version	Description
2.3.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.