get_boundary_post( bool $in_same_term = false, int[]|string $excluded_terms = '', bool $start = true, string $taxonomy = 'category' ): array|null

Description

Parameters

$in_same_termbooloptional

Whether returned post should be in the same taxonomy term. Default false.Default: false

$excluded_termsint[]|stringoptional

Array or comma-separated list of excluded term IDs. Default empty.Default: ''

$startbooloptional

Whether to retrieve first or last post. Default true.Default: true

$taxonomystringoptional

Taxonomy, if $in_same_term is true. Default 'category'.Default: 'category'

Return

array|null

Array containing the boundary post object if successful, null otherwise.

Uses · 6

• get_post()Retrieves post data given a post ID or post object.
• is_single()Determines whether the query is for an existing single post.
• is_attachment()Determines whether the query is for an existing attachment page.
• taxonomy_exists()Determines whether the taxonomy name exists.
• wp_get_object_terms()Retrieves the terms associated with the given object(s), in the supplied taxonomies.
• get_posts()Retrieves an array of the latest posts, or posts matching the given criteria.

Used by · 1

• get_boundary_post_rel_link()Get boundary post relational link.

Source

View on Trac ↗View on GitHub ↗

2193function get_boundary_post( $in_same_term = false, $excluded_terms = '', $start = true, $taxonomy = 'category' ) {2194	$post = get_post();2195 2196	if ( ! $post || ! is_single() || is_attachment() || ! taxonomy_exists( $taxonomy ) ) {2197		return null;2198	}2199 2200	$query_args = array(2201		'posts_per_page'         => 1,2202		'order'                  => $start ? 'ASC' : 'DESC',2203		'update_post_term_cache' => false,2204		'update_post_meta_cache' => false,2205	);2206 2207	$term_array = array();2208 2209	if ( ! is_array( $excluded_terms ) ) {2210		if ( ! empty( $excluded_terms ) ) {2211			$excluded_terms = explode( ',', $excluded_terms );2212		} else {2213			$excluded_terms = array();2214		}2215	}2216 2217	if ( $in_same_term || ! empty( $excluded_terms ) ) {2218		if ( $in_same_term ) {2219			$term_array = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'ids' ) );2220		}2221 2222		if ( ! empty( $excluded_terms ) ) {2223			$excluded_terms = array_map( 'intval', $excluded_terms );2224			$excluded_terms = array_diff( $excluded_terms, $term_array );2225 2226			$inverse_terms = array();2227			foreach ( $excluded_terms as $excluded_term ) {2228				$inverse_terms[] = $excluded_term * -1;2229			}2230			$excluded_terms = $inverse_terms;2231		}2232 2233		$query_args['tax_query'] = array(2234			array(2235				'taxonomy' => $taxonomy,2236				'terms'    => array_merge( $term_array, $excluded_terms ),2237			),2238		);2239	}2240 2241	return get_posts( $query_args );2242}

History

Introduced in 2.8.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 6.8.8 tag, from src/wp-includes/link-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.