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 ↗

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

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 7.1.0 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.