get_bookmarks

Получает массив данных о ссылках блогролла (Админка -> Ссылки -> Ссылки).

Этот Тег Шаблона дает возможность получить данные о ссылках и сформировать необходимый нам вывод их на экран.

Хуки из функции:
get_bookmarks
Возвращает

массив объектов с информацией о ссылках.

Использование

<?php get_bookmarks( $args ); ?>

Шаблон использования

<?php 
$args = array(
	'orderby'        => 'name' 
	,'order'          => 'ASC'
	,'limit'          => -1
	,'category'       => null
	,'category_name'  => null
	,'hide_invisible' => 1
	,'show_updated'   => 0
	,'include'        => null
	,'exclude'        => null
	,'search'         => null 
);
$bookmarks = get_bookmarks( $args );

foreach ( $bookmarks as $bm ) { 
	   //вывод
}
?>
$args(массив)
Аргументы формирующие получение данных (см. ниже).
По умолчанию: предустановки

Аргументы параметра $args

orderby(строка)
Поле по которому будут сортироваться получаемые ссылки. Может быть:
id – по ID;
url – по УРЛу;
name – по имени. По умолчанию;
target – по цели (ссылка открывается в новом окне и т.д.);
description – по описанию;
owner – по пользователям, которые добавляли ссылки;
rating – по рейтингу;
updated – по дате обновления;
rel
notes
rss
length – сортировать по длине названия ссылки (от меньшего к большему);
rand – получит ссылки в хаотичном порядке;
По умолчанию: ‘name’
order(строка)
Направление сортировки:
ASC – по порядку;
DESC – в обратном порядке.
По умолчанию: ‘ASC’
limit(число)
Ограничение по количеству выводимых ссылок. -1 – без ограничений.
По умолчанию: -1
category(строка)
ID рубрик ссылок, ссылки из которых нужно получить. ID указывать через запятую.
По умолчанию: ”
category_name(строка)
Название рубрики ссылок, ссылки из которой нужно вывести. Переписывает параметр category.
По умолчанию: ”
hide_invisible(логический)
Показывать или нет ссылки со статусом “не скрытые” (link_visible установлено в Y).
true – будут показаны только не скрытые ссылки (Y);
false – будут показаны все ссылки, независимо от статуса.
По умолчанию: true
show_updated(логический)
true – добавит еще одно поле данных (link_category_f), которое будет содержать тоже значение что и поле link_updated, но дата будет в формате unix.
По умолчанию: false
include(строка)
ID ссылок через запятую, которые нужно вывести. Указывать нужно через запятую. Не работает если установлен хотя бы один из параметров: category, category_name или exclude.
По умолчанию: нет
exclude(строка)
ID ссылок, которые не нужно показывать. ID нужно указывать через запятую.
По умолчанию: нет
search(строка)
Поиск в полях link_url, link_name или link_description строки указанной в этом параметре. Будут получены данные ссылок попавших в результат поиска.
По умолчанию: нет

Примеры

#1. Вывод ссылок из рубрики блогролла

Предположим что у нас есть рубрика блогролла “Похожие сайты” и в ней существует несколько ссылок, тогда этот код можно использовать чтобы вывести эти ссылки:

<?php
$bookmarks = get_bookmarks( array(
				'orderby'        => 'name',
				'order'          => 'ASC',
				'category_name'  => 'Похожие сайты'
						  ));

// Цикл ссылок, который обработает данные каждой ссылки и выведет их на экран
foreach ( $bookmarks as $bm ) { 
	echo '<a href="'. $bm->link_url .'">'. $bm->link_name .'</a><br />';
}
?>

Код из


wp-includes/bookmark.php

WP 4.7.2

<?php
function get_bookmarks( $args = '' ) {
	global $wpdb;

	$defaults = array(
		'orderby' => 'name', 'order' => 'ASC',
		'limit' => -1, 'category' => '',
		'category_name' => '', 'hide_invisible' => 1,
		'show_updated' => 0, 'include' => '',
		'exclude' => '', 'search' => ''
	);

	$r = wp_parse_args( $args, $defaults );

	$key = md5( serialize( $r ) );
	$cache = false;
	if ( 'rand' !== $r['orderby'] && $cache = wp_cache_get( 'get_bookmarks', 'bookmark' ) ) {
		if ( is_array( $cache ) && isset( $cache[ $key ] ) ) {
			$bookmarks = $cache[ $key ];
			/**
			 * Filters the returned list of bookmarks.
			 *
			 * The first time the hook is evaluated in this file, it returns the cached
			 * bookmarks list. The second evaluation returns a cached bookmarks list if the
			 * link category is passed but does not exist. The third evaluation returns
			 * the full cached results.
			 *
			 * @since 2.1.0
			 *
			 * @see get_bookmarks()
			 *
			 * @param array $bookmarks List of the cached bookmarks.
			 * @param array $r         An array of bookmark query arguments.
			 */
			return apply_filters( 'get_bookmarks', $bookmarks, $r );
		}
	}

	if ( ! is_array( $cache ) ) {
		$cache = array();
	}

	$inclusions = '';
	if ( ! empty( $r['include'] ) ) {
		$r['exclude'] = '';  //ignore exclude, category, and category_name params if using include
		$r['category'] = '';
		$r['category_name'] = '';
		$inclinks = preg_split( '/[s,]+/', $r['include'] );
		if ( count( $inclinks ) ) {
			foreach ( $inclinks as $inclink ) {
				if ( empty( $inclusions ) ) {
					$inclusions = ' AND ( link_id = ' . intval( $inclink ) . ' ';
				} else {
					$inclusions .= ' OR link_id = ' . intval( $inclink ) . ' ';
				}
			}
		}
	}
	if (! empty( $inclusions ) ) {
		$inclusions .= ')';
	}

	$exclusions = '';
	if ( ! empty( $r['exclude'] ) ) {
		$exlinks = preg_split( '/[s,]+/', $r['exclude'] );
		if ( count( $exlinks ) ) {
			foreach ( $exlinks as $exlink ) {
				if ( empty( $exclusions ) ) {
					$exclusions = ' AND ( link_id <> ' . intval( $exlink ) . ' ';
				} else {
					$exclusions .= ' AND link_id <> ' . intval( $exlink ) . ' ';
				}
			}
		}
	}
	if ( ! empty( $exclusions ) ) {
		$exclusions .= ')';
	}

	if ( ! empty( $r['category_name'] ) ) {
		if ( $r['category'] = get_term_by('name', $r['category_name'], 'link_category') ) {
			$r['category'] = $r['category']->term_id;
		} else {
			$cache[ $key ] = array();
			wp_cache_set( 'get_bookmarks', $cache, 'bookmark' );
			/** This filter is documented in wp-includes/bookmark.php */
			return apply_filters( 'get_bookmarks', array(), $r );
		}
	}

	$search = '';
	if ( ! empty( $r['search'] ) ) {
		$like = '%' . $wpdb->esc_like( $r['search'] ) . '%';
		$search = $wpdb->prepare(" AND ( (link_url LIKE %s) OR (link_name LIKE %s) OR (link_description LIKE %s) ) ", $like, $like, $like );
	}

	$category_query = '';
	$join = '';
	if ( ! empty( $r['category'] ) ) {
		$incategories = preg_split( '/[s,]+/', $r['category'] );
		if ( count($incategories) ) {
			foreach ( $incategories as $incat ) {
				if ( empty( $category_query ) ) {
					$category_query = ' AND ( tt.term_id = ' . intval( $incat ) . ' ';
				} else {
					$category_query .= ' OR tt.term_id = ' . intval( $incat ) . ' ';
				}
			}
		}
	}
	if ( ! empty( $category_query ) ) {
		$category_query .= ") AND taxonomy = 'link_category'";
		$join = " INNER JOIN $wpdb->term_relationships AS tr ON ($wpdb->links.link_id = tr.object_id) INNER JOIN $wpdb->term_taxonomy as tt ON tt.term_taxonomy_id = tr.term_taxonomy_id";
	}

	if ( $r['show_updated'] ) {
		$recently_updated_test = ", IF (DATE_ADD(link_updated, INTERVAL 120 MINUTE) >= NOW(), 1,0) as recently_updated ";
	} else {
		$recently_updated_test = '';
	}

	$get_updated = ( $r['show_updated'] ) ? ', UNIX_TIMESTAMP(link_updated) AS link_updated_f ' : '';

	$orderby = strtolower( $r['orderby'] );
	$length = '';
	switch ( $orderby ) {
		case 'length':
			$length = ", CHAR_LENGTH(link_name) AS length";
			break;
		case 'rand':
			$orderby = 'rand()';
			break;
		case 'link_id':
			$orderby = "$wpdb->links.link_id";
			break;
		default:
			$orderparams = array();
			$keys = array( 'link_id', 'link_name', 'link_url', 'link_visible', 'link_rating', 'link_owner', 'link_updated', 'link_notes', 'link_description' );
			foreach ( explode( ',', $orderby ) as $ordparam ) {
				$ordparam = trim( $ordparam );

				if ( in_array( 'link_' . $ordparam, $keys ) ) {
					$orderparams[] = 'link_' . $ordparam;
				} elseif ( in_array( $ordparam, $keys ) ) {
					$orderparams[] = $ordparam;
				}
			}
			$orderby = implode( ',', $orderparams );
	}

	if ( empty( $orderby ) ) {
		$orderby = 'link_name';
	}

	$order = strtoupper( $r['order'] );
	if ( '' !== $order && ! in_array( $order, array( 'ASC', 'DESC' ) ) ) {
		$order = 'ASC';
	}

	$visible = '';
	if ( $r['hide_invisible'] ) {
		$visible = "AND link_visible = 'Y'";
	}

	$query = "SELECT * $length $recently_updated_test $get_updated FROM $wpdb->links $join WHERE 1=1 $visible $category_query";
	$query .= " $exclusions $inclusions $search";
	$query .= " ORDER BY $orderby $order";
	if ( $r['limit'] != -1 ) {
		$query .= ' LIMIT ' . $r['limit'];
	}

	$results = $wpdb->get_results( $query );

	if ( 'rand()' !== $orderby ) {
		$cache[ $key ] = $results;
		wp_cache_set( 'get_bookmarks', $cache, 'bookmark' );
	}

	/** This filter is documented in wp-includes/bookmark.php */
	return apply_filters( 'get_bookmarks', $results, $r );
}

Комментарии:


Оставить комментарий

Your email address will not be published. Required fields are marked *