_walk_bookmarks( array $bookmarks, string|array $args = '' ): string

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

$bookmarksarray

List of bookmarks to traverse.

$argsstring|arrayoptional

Bookmarks arguments.Default: ''

• $show_updatedint|booldefault: 0|false

  Whether to show the time the bookmark was last updated. Accepts 1|true or 0|false.

• $show_descriptionint|booldefault: 0|false

  Whether to show the bookmark description. Accepts 1|true, Accepts 1|true or 0|false.

• $show_imagesint|booldefault: 1|true

  Whether to show the link image if available. Accepts 1|true or 0|false.

• $show_nameint|booldefault: 0|false

  Whether to show link name if available. Accepts 1|true or 0|false.

• $beforestringdefault: <li>

  The HTML or text to prepend to each bookmark.

• $afterstringdefault: </li>

  The HTML or text to append to each bookmark.

• $link_beforestringdefault: empty

  The HTML or text to prepend to each bookmark inside the anchor tags.

• $link_afterstringdefault: empty

  The HTML or text to append to each bookmark inside the anchor tags.

• $betweenstringdefault: "\n"

  The string for use in between the link, description, and image.

• $show_ratingint|booldefault: 0|false

  Whether to show the link rating. Accepts 1|true or 0|false.

Return value

string

Formatted output in HTML

Performance profile

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

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

13–14

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place 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 callbacksapply_filters()one call below _walk_bookmarks()
• cacheobject cachewp_cache_get()one call below _walk_bookmarks()
• serializeserialisationmaybe_unserialize()one call below _walk_bookmarks()

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 · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost _walk_bookmarks() 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.

Uses · 7

• wp_parse_args()Merges user defined arguments into defaults array.
• esc_url()Checks and cleans a URL.
• esc_attr()Escaping for HTML attributes.
• sanitize_bookmark_field()Sanitizes a bookmark field.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• __()Retrieves the translation of $text.
• get_option()Retrieves an option value based on an option name.

Used by · 1

• wp_list_bookmarks()Retrieves or echoes all of the bookmarks.

Source code

View on Trac ↗View on GitHub ↗

51function _walk_bookmarks( $bookmarks, $args = '' ) {52	$defaults = array(53		'show_updated'     => 0,54		'show_description' => 0,55		'show_images'      => 1,56		'show_name'        => 0,57		'before'           => '<li>',58		'after'            => '</li>',59		'between'          => "\n",60		'show_rating'      => 0,61		'link_before'      => '',62		'link_after'       => '',63	);64 65	$parsed_args = wp_parse_args( $args, $defaults );66 67	$output = ''; // Blank string to start with.68 69	foreach ( (array) $bookmarks as $bookmark ) {70		if ( ! isset( $bookmark->recently_updated ) ) {71			$bookmark->recently_updated = false;72		}73		$output .= $parsed_args['before'];74		if ( $parsed_args['show_updated'] && $bookmark->recently_updated ) {75			$output .= '<em>';76		}77		$the_link = '#';78		if ( ! empty( $bookmark->link_url ) ) {79			$the_link = esc_url( $bookmark->link_url );80		}81		$desc  = esc_attr( sanitize_bookmark_field( 'link_description', $bookmark->link_description, $bookmark->link_id, 'display' ) );82		$name  = esc_attr( sanitize_bookmark_field( 'link_name', $bookmark->link_name, $bookmark->link_id, 'display' ) );83		$title = $desc;84 85		if ( $parsed_args['show_updated'] ) {86			if ( ! str_starts_with( $bookmark->link_updated_f, '00' ) ) {87				$title .= ' (';88				$title .= sprintf(89					/* translators: %s: Date and time of last update. */90					__( 'Last updated: %s' ),91					gmdate(92						get_option( 'links_updated_date_format' ),93						$bookmark->link_updated_f + (int) ( (float) get_option( 'gmt_offset' ) * HOUR_IN_SECONDS )94					)95				);96				$title .= ')';97			}98		}99		$alt = ' alt="' . $name . ( $parsed_args['show_description'] ? ' ' . $title : '' ) . '"';100 101		if ( '' !== $title ) {102			$title = ' title="' . $title . '"';103		}104		$rel = $bookmark->link_rel;105 106		$target = $bookmark->link_target;107		if ( '' !== $target ) {108			$target = ' target="' . $target . '"';109		}110 111		if ( '' !== $rel ) {112			$rel = ' rel="' . esc_attr( $rel ) . '"';113		}114 115		$output .= '<a href="' . $the_link . '"' . $rel . $title . $target . '>';116 117		$output .= $parsed_args['link_before'];118 119		if ( '' !== $bookmark->link_image && $parsed_args['show_images'] ) {120			if ( str_starts_with( $bookmark->link_image, 'http' ) ) {121				$output .= '<img src="' . $bookmark->link_image . '"' . $alt . $title . ' />';122			} else { // If it's a relative path.123				$output .= '<img src="' . get_option( 'siteurl' ) . $bookmark->link_image . '"' . $alt . $title . ' />';124			}125			if ( $parsed_args['show_name'] ) {126				$output .= " $name";127			}128		} else {129			$output .= $name;130		}

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 7.1.0 tag, from src/wp-includes/bookmark-template.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.