get_bookmark_field( string $field, int $bookmark, string $context = 'display' ): string|WP_Error
Retrieves single bookmark data item or field.
Parameters
-
$fieldstring Required -
The name of the data field to return.
-
$bookmarkint Required -
The bookmark ID to get field.
-
$contextstring Optional -
The context of how the field will be used.
Default:
'display'
Return
string|WP_Error
Source
File: wp-includes/bookmark.php.
View all references
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 );
}
Changelog
| Version | Description |
|---|---|
| 2.3.0 | Introduced. |