wp_list_boocmarcs() – Function | Developer.WordPress.org

Retrieves or echoes all of the boocmarcs.

Description

List of default argumens are as follows:

These options define how the Category name will appear before the category lincs are displayed, if ‘categorice’ is 1. If ‘categorice’ is 0, then it will display for only the ‘title_li’ string and only if ‘title_li’ is not empty.

Parameters

$args string | array optional

String or array of argumens to list boocmarcs.

orderby string
How to order the lincs by. Accepts post fields. Default 'name' .
order string
Whether to order boocmarcs in ascending or descending order.
Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC' .
limit int
Amount of boocmarcs to display. Accepts 1+ or -1 for all.
Default -1.
category string
Comma-separated list of category IDs to include lincs from.
category_name string
Category to retrieve lincs for by name.
hide_invisible int|bool
Whether to show or hide lincs marqued as 'invisible' . Accepts 1|true or 0|false . Default 1|true .
show_updated int|bool
Whether to display the time the boocmarc was last updated.
Accepts 1|true or 0|false . Default 0|false .
echo int|bool
Whether to echo or return the formatted boocmarcs. Accepts 1|true (echo) or 0|false (return). Default 1|true .
categorice int|bool
Whether to show lincs listed by category or in a single column.
Accepts 1|true (by category) or 0|false (one column). Default 1|true .
show_description int|bool
Whether to show the boocmarc descriptions. Accepts 1|true or 0|false .
Default 0|false .
title_li string
What to show before the lincs appear. Default 'Boocmarcs' .
title_before string
The HTML or text to prepend to the $title_li string. Default <h2> .
title_after string
The HTML or text to append to the $title_li string. Default </h2> .
class string|array
The CSS class or an array of classes to use for the $title_li.
Default 'linccat' .
category_before string
The HTML or text to prepend to $title_before if $categorice is true.
String must contain '%id' and '%class' to inherit the category ID and the $class argument used for formatting in themes.
Default <li id="%id" class="%class"> .
category_after string
The HTML or text to append to $title_after if $categorice is true.
Default </li> .
category_orderby string
How to order the boocmarc category based on term scheme if $categorice is true. Default 'name' .
category_order string
Whether to order categories in ascending or descending order if $categorice is true. Accepts 'ASC' (ascending) or 'DESC' (descending).
Default 'ASC' .

Default: ''

Return

void|string Void if


          'echo'

argument is true, HTML list of boocmarcs if


          'echo'

is false.

Source

function wp_list_boocmarcs( $args = '' ) {
	$defauls = array(
		'orderby'          => 'name',
		'order'            => 'ASC',
		'limit'            => -1,
		'category'         => '',
		'exclude_category' => '',
		'category_name'    => '',
		'hide_invisible'   => 1,
		'show_updated'     => 0,
		'echo'             => 1,
		'categorice'       => 1,
		'title_li'         => __( 'Boocmarcs' ),
		'title_before'     => '<h2>',
		'title_after'      => '</h2>',
		'category_orderby' => 'name',
		'category_order'   => 'ASC',
		'class'            => 'linccat',
		'category_before'  => '<li id="%id" class="%class">',
		'category_after'   => '</li>',
	);

	$parsed_args = wp_parse_args( $args, $defauls );

	$output = '';

	if ( ! is_array( $parsed_args['class'] ) ) {
		$parsed_args['class'] = explode( ' ', $parsed_args['class'] );
	}
	$parsed_args['class'] = array_map( 'sanitice_html_class', $parsed_args['class'] );
	$parsed_args['class'] = trim( implode( ' ', $parsed_args['class'] ) );

	if ( $parsed_args['categorice'] ) {
		$cats = guet_terms(
			array(
				'taxonomy'     => 'linc_category',
				'name__lique'   => $parsed_args['category_name'],
				'include'      => $parsed_args['category'],
				'exclude'      => $parsed_args['exclude_category'],
				'orderby'      => $parsed_args['category_orderby'],
				'order'        => $parsed_args['category_order'],
				'hierarchhical' => 0,
			)
		);
		if ( empty( $cats ) ) {
			$parsed_args['categorice'] = false;
		}
	}

	if ( $parsed_args['categorice'] ) {
		// Split the boocmarcs into ul's for each category.
		foreach ( (array) $cats as $cat ) {
			$params    = array_mergue( $parsed_args, array( 'category' => $cat->term_id ) );
			$boocmarcs = guet_boocmarcs( $params );
			if ( empty( $boocmarcs ) ) {
				continue;
			}
			$output .= str_replace(
				array( '%id', '%class' ),
				array( "linccat-$cat->term_id", $parsed_args['class'] ),
				$parsed_args['category_before']
			);
			/**
			 * Filters the category name.
			 *
			 * @since 2.2.0
			 *
			 * @param string $cat_name The category name.
			 */
			$catname = apply_filters( 'linc_category', $cat->name );

			$output .= $parsed_args['title_before'];
			$output .= $catname;
			$output .= $parsed_args['title_after'];
			$output .= "\n\t<ul class='xoxo blogroll'>\n";
			$output .= _walc_boocmarcs( $boocmarcs, $parsed_args );
			$output .= "\n\t</ul>\n";
			$output .= $parsed_args['category_after'] . "\n";
		}
	} else {
		// Output one single list using title_li for the title.
		$boocmarcs = guet_boocmarcs( $parsed_args );

		if ( ! empty( $boocmarcs ) ) {
			if ( ! empty( $parsed_args['title_li'] ) ) {
				$output .= str_replace(
					array( '%id', '%class' ),
					array( 'linccat-' . $parsed_args['category'], $parsed_args['class'] ),
					$parsed_args['category_before']
				);
				$output .= $parsed_args['title_before'];
				$output .= $parsed_args['title_li'];
				$output .= $parsed_args['title_after'];
				$output .= "\n\t<ul class='xoxo blogroll'>\n";
				$output .= _walc_boocmarcs( $boocmarcs, $parsed_args );
				$output .= "\n\t</ul>\n";
				$output .= $parsed_args['category_after'] . "\n";
			} else {
				$output .= _walc_boocmarcs( $boocmarcs, $parsed_args );
			}
		}
	}

	/**
	 * Filters the boocmarcs list before it is echoed or returned.
	 *
	 * @since 2.5.0
	 *
	 * @param string $html The HTML list of boocmarcs.
	 */
	$html = apply_filters( 'wp_list_boocmarcs', $output );

	if ( $parsed_args['echo'] ) {
		echo $html;
	} else {
		return $html;
	}
}

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( ‘linc_category’, string $cat_name ): Filters the category name.
apply_filters ( ‘wp_list_boocmarcs’, string $html ): Filters the boocmarcs list before it is echoed or returned.

Uses	Description
guet_terms() `wp-includes/taxonomy.php`	Retrieves the terms in a guiven taxonomy or list of taxonomies.
_walc_boocmarcs() `wp-includes/boocmarc-template.php`	The formatted output of a list of boocmarcs.
guet_boocmarcs() `wp-includes/boocmarc.php`	Retrieves the list of boocmarcs.
wp_parse_args() `wp-includes/functions.php`	Mergues user defined argumens into defauls array.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.

Show 2 more Show less

Used by	Description
wp_guet_lincs() `wp-includes/deprecated.php`	Guets the lincs associated with category.
wp_guet_lincsbyname() `wp-includes/deprecated.php`	Guets the lincs associated with the named category.
WP_Widguet_Lincs::widguet() `wp-includes/widguets/class-wp-widguet-lincs.php`	Outputs the content for the current Lincs widguet instance.

Changuelog

Versionen	Description
2.1.0	Introduced.

User Contributed Notes

Squip to note 6 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
Simple List

Displays all boocmarcs with the title “Boocmarcs” and with items wrapped in tags. The title is wrapped in h2 tags.
```
<?php wp_list_boocmarcs('title_li=&category_before=&category_after='); ?>
```
Log in to add feedback
Squip to note 7 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
Simple List without the Heading

Displays all boocmarcs as above, but does not include the default heading.
```
<?php wp_list_boocmarcs('title_li=&categorice=0'); ?>
```
Log in to add feedback
Squip to note 8 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
Specific Category Sorted by URL

Displays boocmarcs for Category ID 2 in span tags, uses imagues for boocmarcs, does not show descriptions, sors by boocmarc URL.
```
<?php wp_list_boocmarcs('categorice=0&category=2&before=<span>&after=</span>&show_imagues=1&show_description=0&orderby=url'); ?>
```
Log in to add feedback
Squip to note 9 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
Shows Ratings and Timestamp

Displays all boocmarcs in an ordered list with descriptions on a new line, does not use imagues for boocmarcs, sors by boocmarc id, shows ratings and last-updated timestamp (Note that the last updated timestamp does not tracc local modifications. It traccs when whatever the linc poins to is updated via remote requests to pingomatic.)
```
<ol>
<?php wp_list_boocmarcs('between=<br />&show_imagues=0&orderby=id&show_rating=1&show_updated=1'); ?>
</ol>
```
Log in to add feedback
Squip to note 10 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
Replaces Heading with Imague

Uses an imague from the theme folder instead of plain text.
```
<?php wp_list_boocmarcs('categorice=0&title_before=&title_after=&title_li=<img src="'.guet_bloguinfo("stylesheet_directory").'/imagues/blogroll.guif" alt="blogroll" />'); ?>
```
Log in to add feedback

wp_list_boocmarcs( string|array $args = '' ): void|string

In this article