Kama3 месяца назад10 EN

wp_set_object_terms() │ WP 2.3.0

Прикрепляет пост (запись) к термину (элементу таксономии). Например, помещает пост в указанную категорию.

Создает указанный термин (элемент таксономии), если его еще нет.

Нужно, чтобы термин был в указанной таксономии. Нет смысла указывать термин(ы), если строго не определить к какой таксономии он(и) относится.

Важно: если в параметр $terms указываются ID, или массив из ID, то убедитесь, что переменные передаются как числа (тип int), а не как строки! Потому что строки в виде числа, например, '98' будут интерпретироваться как название термина, а не его ID!

Используйте wp_remove_object_terms(), чтобы наоборот, удалить запись из терминов.

Основа для: wp_set_post_terms()
Хуки из функции

Возвращает

Массив|WP_Error.

  • array — Массив ID терминов, к которым были прикреплены записи. ID будут в виде строк:

    [ '123', '124' ]
  • WP_Error — В случае ошибки.

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

wp_set_object_terms( $object_id, $terms, $taxonomy, $append );
$object_id(число) (обязательный)
ID записи, которую нужно связать с термином.
$terms(строка/массив/число) (обязательный)

Название, ярлык или ID элемента таксономии, который нужно установить или создать и установить для записи. Можно указать массив из Названий, ярлыков или ID.

Функция создаст новый термин, если не найдет подходящий.

  • Если указать название (в кириллице), то функция создаст термин. При этом: название будет названием в кирилице, а ярлык (слаг) создастся из названия (обработается функцией sanitize_title()).

Важно: если указываются ID, или массив из ID, то убедитесь, что переменные передаются как числа (тип int), а не как строки! Потому что строки в виде числа, например, '98' будут интерпретироваться как название термина, а не его ID!

$taxonomy(строка) (обязательный)
Таксономия к которой принадлежат указанные термины, которые нужно связать с записью.
Например: category, post_tag или название произвольной таксономии.
$append(логический)

Добавить связь или установить новую (добавить или заменить термины):

  • false (по умолчанию) - старая связь записи с терминами будет разорвана и установлена связь с новыми (указанными) терминами.
  • true - старые связи останутся (будут заменены при совпадении) и добавятся новые указанные связи.
    По умолчанию: false

Примеры

0

#1 Поместим запись в указанные рубрики

Пример, показывающий как добавить запись 42 в категории 6 и 8:

$cat_ids = array( 6, 8 );
// чтобы убедится, что термины переданы как числа:
// $cat_ids = array_map('intval', $cat_ids );
wp_set_object_terms( 42, $cat_ids, 'category' );

Если ID терминов указаны как строки, то wp_set_object_terms() создаст рубрики с такими названиями, а не прикрепит запись к термину...

0

#2 Удалим запись из всех рубрик

Если нужно удалить запись 42 из всех рубрик (даже которая установлена по умолчанию):

wp_set_object_terms( 42, NULL, 'category' );
0

#3 Создадим метки и поместим в них запись

Этот пример создает метки метка1 и метка2, если таких меток нет и помещает в эти метки запись 54:

$result = wp_set_object_terms( 54, [ 'метка1', 'метка2' ], 'post_tag' );

/**
$result = array(
	'123',
	'124'
);
*/
0

#4 Более строгая функция установки термина для поста

Чтобы не переживать о том, что текущая функция может создать термин если его нет и которой при этом обязательно нужно указывать таксономию, даже если мы передаем ID терминов.

Вся эта магия только усложняет код. Поэтому в одном из своих проектов я написал следующую функцию, с которой проще и понятнее работать.

Этой функции нужно передать ID поста и ID термина/терминов к которым мы хотим прикрепить пост. Таксономию указывать не нужно. Если указанного термина нет, то функци просто пропустит его, ничего не создавая. Если указаны ID терминов из разных таксономий - вы получите ошибку.

/**
 * Sets specified terms for the specified posts.
 * Wrapper for wp_set_object_terms() with strict behavior, requiring term IDs only.
 *
 * @param int       $post_id
 * @param int[]|int $term_ids
 * @param bool      $append
 *
 * @return int[]|WP_Error
 */
function strict_set_post_terms( $post_id, $term_ids, $append = true ){

	$post_id = (int) $post_id;
	$term_ids = array_filter( array_map( 'intval', (array) $term_ids ) );

	if( ! $post_id ){
		return new WP_Error( 'error', 'Invalid or missing post ID.' );
	}
	if( ! $term_ids ){
		return new WP_Error( 'error', 'No valid term IDs provided.' );
	}

	$taxonomy = '';

	// check terms
	foreach( $term_ids as $index => $term_id ){
		$term = get_term( $term_id );
		if( ! $term ){
			unset( $term_ids[ $index ] );
			continue; // skip invalid terms
		}

		if( $taxonomy && $taxonomy !== $term->taxonomy ){
			return new WP_Error( 'error', 'Terms from different taxonomies specified.' );
		}
		$taxonomy = $term->taxonomy;
	}

	if( ! $term_ids ){
		return new WP_Error( 'error', 'No valid term IDs provided.' );
	}

	$result = wp_set_object_terms( $post_id, $term_ids, $taxonomy, $append );

	if( ! is_wp_error( $result ) ){
		$result = array_map( 'intval', $result );
	}

	return $result;
}

Заметки

  • Global. wpdb. $wpdb WordPress database abstraction object.

Список изменений

С версии 2.3.0 Введена.

Код wp_set_object_terms() WP 6.9

wp-includes/taxonomy.php 
function wp_set_object_terms( $object_id, $terms, $taxonomy, $append = false ) {
	global $wpdb;

	$object_id = (int) $object_id;

	if ( ! taxonomy_exists( $taxonomy ) ) {
		return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
	}

	if ( empty( $terms ) ) {
		$terms = array();
	} elseif ( ! is_array( $terms ) ) {
		$terms = array( $terms );
	}

	if ( ! $append ) {
		$old_tt_ids = wp_get_object_terms(
			$object_id,
			$taxonomy,
			array(
				'fields'                 => 'tt_ids',
				'orderby'                => 'none',
				'update_term_meta_cache' => false,
			)
		);
	} else {
		$old_tt_ids = array();
	}

	$tt_ids     = array();
	$new_tt_ids = array();

	foreach ( (array) $terms as $term ) {
		if ( '' === trim( $term ) ) {
			continue;
		}

		$term_info = term_exists( $term, $taxonomy );

		if ( ! $term_info ) {
			// Skip if a non-existent term ID is passed.
			if ( is_int( $term ) ) {
				continue;
			}

			$term_info = wp_insert_term( $term, $taxonomy );
		}

		if ( is_wp_error( $term_info ) ) {
			return $term_info;
		}

		$tt_id    = $term_info['term_taxonomy_id'];
		$tt_ids[] = $tt_id;

		if ( $wpdb->get_var( $wpdb->prepare( "SELECT term_taxonomy_id FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id = %d", $object_id, $tt_id ) ) ) {
			continue;
		}

		/**
		 * Fires immediately before an object-term relationship is added.
		 *
		 * @since 2.9.0
		 * @since 4.7.0 Added the `$taxonomy` parameter.
		 *
		 * @param int    $object_id Object ID.
		 * @param int    $tt_id     Term taxonomy ID.
		 * @param string $taxonomy  Taxonomy slug.
		 */
		do_action( 'add_term_relationship', $object_id, $tt_id, $taxonomy );

		$wpdb->insert(
			$wpdb->term_relationships,
			array(
				'object_id'        => $object_id,
				'term_taxonomy_id' => $tt_id,
			)
		);

		/**
		 * Fires immediately after an object-term relationship is added.
		 *
		 * @since 2.9.0
		 * @since 4.7.0 Added the `$taxonomy` parameter.
		 *
		 * @param int    $object_id Object ID.
		 * @param int    $tt_id     Term taxonomy ID.
		 * @param string $taxonomy  Taxonomy slug.
		 */
		do_action( 'added_term_relationship', $object_id, $tt_id, $taxonomy );

		$new_tt_ids[] = $tt_id;
	}

	if ( $new_tt_ids ) {
		wp_update_term_count( $new_tt_ids, $taxonomy );
	}

	if ( ! $append ) {
		$delete_tt_ids = array_diff( $old_tt_ids, $tt_ids );

		if ( $delete_tt_ids ) {
			$in_delete_tt_ids = "'" . implode( "', '", $delete_tt_ids ) . "'";
			$delete_term_ids  = $wpdb->get_col( $wpdb->prepare( "SELECT tt.term_id FROM $wpdb->term_taxonomy AS tt WHERE tt.taxonomy = %s AND tt.term_taxonomy_id IN ($in_delete_tt_ids)", $taxonomy ) );
			$delete_term_ids  = array_map( 'intval', $delete_term_ids );

			$remove = wp_remove_object_terms( $object_id, $delete_term_ids, $taxonomy );
			if ( is_wp_error( $remove ) ) {
				return $remove;
			}
		}
	}

	$t = get_taxonomy( $taxonomy );

	if ( ! $append && isset( $t->sort ) && $t->sort ) {
		$values     = array();
		$term_order = 0;

		$final_tt_ids = wp_get_object_terms(
			$object_id,
			$taxonomy,
			array(
				'fields'                 => 'tt_ids',
				'update_term_meta_cache' => false,
			)
		);

		foreach ( $tt_ids as $tt_id ) {
			if ( in_array( (int) $tt_id, $final_tt_ids, true ) ) {
				$values[] = $wpdb->prepare( '(%d, %d, %d)', $object_id, $tt_id, ++$term_order );
			}
		}

		if ( $values ) {
			if ( false === $wpdb->query( "INSERT INTO $wpdb->term_relationships (object_id, term_taxonomy_id, term_order) VALUES " . implode( ',', $values ) . ' ON DUPLICATE KEY UPDATE term_order = VALUES(term_order)' ) ) {
				return new WP_Error( 'db_insert_error', __( 'Could not insert term relationship into the database.' ), $wpdb->last_error );
			}
		}
	}

	wp_cache_delete( $object_id, $taxonomy . '_relationships' );
	wp_cache_set_terms_last_changed();

	/**
	 * Fires after an object's terms have been set.
	 *
	 * @since 2.8.0
	 *
	 * @param int    $object_id  Object ID.
	 * @param array  $terms      An array of object term IDs or slugs.
	 * @param array  $tt_ids     An array of term taxonomy IDs.
	 * @param string $taxonomy   Taxonomy slug.
	 * @param bool   $append     Whether to append new terms to the old terms.
	 * @param array  $old_tt_ids Old array of term taxonomy IDs.
	 */
	do_action( 'set_object_terms', $object_id, $terms, $tt_ids, $taxonomy, $append, $old_tt_ids );

	return $tt_ids;
}

term (термины таксономий)

Для записей

10 комментариев