wp_check_term_hierarchy_for_loops( int $parent, int $term_id, string $taxonomy )

Checks the given subset of the term hierarchy for hierarchy loops.

Description Description

Prevents loops from forming and breaks those that it finds.

Attached to the ‘wp_update_term_parent’ filter.

Parameters Parameters


(int) (Required) term_id of the parent for the term we're checking.


(int) (Required) The term we're checking.


(string) (Required) The taxonomy of the term we're checking.

Top ↑

Return Return

(int) The new parent for the term.

Top ↑

Source Source

File: wp-includes/taxonomy.php

function wp_check_term_hierarchy_for_loops( $parent, $term_id, $taxonomy ) {
	// Nothing fancy here - bail
	if ( !$parent )
		return 0;

	// Can't be its own parent.
	if ( $parent == $term_id )
		return 0;

	// Now look for larger loops.
	if ( !$loop = wp_find_hierarchy_loop( 'wp_get_term_taxonomy_parent_id', $term_id, $parent, array( $taxonomy ) ) )
		return $parent; // No loop

	// Setting $parent to the given value causes a loop.
	if ( isset( $loop[$term_id] ) )
		return 0;

	// There's a loop, but it doesn't contain $term_id. Break the loop.
	foreach ( array_keys( $loop ) as $loop_member )
		wp_update_term( $loop_member, $taxonomy, array( 'parent' => 0 ) );

	return $parent;

Top ↑

Changelog Changelog

Version Description
3.1.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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