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

Retrieve Bookmark data

Contents

Description Description

Parameters Parameters

$bookmark

(int|stdClass) (Required)

$output

(string) (Optional) 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 value: OBJECT

$filter

(string) (Optional)

Default value: 'raw'

Top ↑

Return Return

(array|object|null) Type returned depends on $output value.

Top ↑

Source Source

File: wp-includes/bookmark.php 

function get_bookmark( $bookmark, $output = OBJECT, $filter = 'raw' ) {
	global $wpdb;

	if ( empty( $bookmark ) ) {
		if ( isset( $GLOBALS['link'] ) ) {
			$_bookmark = & $GLOBALS['link'];
		} else {
			$_bookmark = null;
		}
	} elseif ( is_object( $bookmark ) ) {
		wp_cache_add( $bookmark->link_id, $bookmark, 'bookmark' );
		$_bookmark = $bookmark;
	} else {
		if ( isset( $GLOBALS['link'] ) && ( $GLOBALS['link']->link_id == $bookmark ) ) {
			$_bookmark = & $GLOBALS['link'];
		} else {
			$_bookmark = wp_cache_get( $bookmark, 'bookmark' );
			if ( ! $_bookmark ) {
				$_bookmark = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->links WHERE link_id = %d LIMIT 1", $bookmark ) );
				if ( $_bookmark ) {
					$_bookmark->link_category = array_unique( wp_get_object_terms( $_bookmark->link_id, 'link_category', array( 'fields' => 'ids' ) ) );
					wp_cache_add( $_bookmark->link_id, $_bookmark, 'bookmark' );
				}
			}
		}
	}

	if ( ! $_bookmark ) {
		return $_bookmark;
	}

	$_bookmark = sanitize_bookmark( $_bookmark, $filter );

	if ( $output == OBJECT ) {
		return $_bookmark;
	} elseif ( $output == ARRAY_A ) {
		return get_object_vars( $_bookmark );
	} elseif ( $output == ARRAY_N ) {
		return array_values( get_object_vars( $_bookmark ) );
	} else {
		return $_bookmark;
	}
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.1.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/cache.php: wp_cache_add()

Adds data to the cache, if the cache key doesn’t already exist.
wp-includes/cache.php: wp_cache_get()

Retrieves the cache contents from the cache by key and group.
wp-includes/taxonomy.php: wp_get_object_terms()

Retrieves the terms associated with the given object(s), in the supplied taxonomies.
wp-includes/bookmark.php: sanitize_bookmark()

Sanitizes all bookmark fields
wp-includes/wp-db.php: wpdb::get_row()

Retrieve one row from the database.
wp-includes/wp-db.php: wpdb::prepare()

Prepares a SQL query for safe execution. Uses sprintf()-like syntax.
Show 1 more use Hide more uses

Top ↑

Used By Used By

Used By
Used By Description
wp-admin/includes/ajax-actions.php: wp_ajax_delete_link()

Ajax handler for deleting a link.
wp-admin/includes/bookmark.php: get_link_to_edit()

Retrieves link data based on its ID.
wp-admin/includes/bookmark.php: wp_update_link()

Updates a link in the database.
wp-includes/deprecated.php: get_link()

Retrieves bookmark data based on ID.
wp-includes/link-template.php: get_edit_bookmark_link()

Displays the edit bookmark link.
wp-includes/link-template.php: edit_bookmark_link()

Displays the edit bookmark link anchor content.
wp-includes/bookmark.php: get_bookmark_field()

Retrieve single bookmark data item or field.
Show 2 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

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