wpseek.com
A WordPress-centric search engine for devs and theme authors



get_boundary_post › WordPress Function

Since2.8.0
Deprecatedn/a
› get_boundary_post ( $in_same_term = false, $excluded_terms = '', $start = true, $taxonomy = 'category' )
Parameters: (4)
  • (bool) $in_same_term Optional. Whether returned post should be in the same taxonomy term. Default false.
    Required: No
    Default: false
  • (int[]|string) $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
    Required: No
    Default: (empty)
  • (bool) $start Optional. Whether to retrieve first or last post. Default true.
    Required: No
    Default: true
  • (string) $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
    Required: No
    Default: 'category'
Returns:
  • (array|null) Array containing the boundary post object if successful, null otherwise.
Defined at:
Codex:

Retrieves the boundary post.

Boundary being either the first or last post by publish date within the constraints specified by $in_same_term or $excluded_terms.


Related Functions: get_boundary_post_rel_link, get_blog_post, get_next_post, get_previous_post, get_body_class

Source 

function get_boundary_post( $in_same_term = false, $excluded_terms = '', $start = true, $taxonomy = 'category' ) {
	$post = get_post();

	if ( ! $post || ! is_single() || is_attachment() || ! taxonomy_exists( $taxonomy ) ) {
		return null;
	}

	$query_args = array(
		'posts_per_page'         => 1,
		'order'                  => $start ? 'ASC' : 'DESC',
		'update_post_term_cache' => false,
		'update_post_meta_cache' => false,
	);

	$term_array = array();

	if ( ! is_array( $excluded_terms ) ) {
		if ( ! empty( $excluded_terms ) ) {
			$excluded_terms = explode( ',', $excluded_terms );
		} else {
			$excluded_terms = array();
		}
	}

	if ( $in_same_term || ! empty( $excluded_terms ) ) {
		if ( $in_same_term ) {
			$term_array = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'ids' ) );
		}

		if ( ! empty( $excluded_terms ) ) {
			$excluded_terms = array_map( 'intval', $excluded_terms );
			$excluded_terms = array_diff( $excluded_terms, $term_array );

			$inverse_terms = array();
			foreach ( $excluded_terms as $excluded_term ) {
				$inverse_terms[] = $excluded_term * -1;
			}
			$excluded_terms = $inverse_terms;
		}

		$query_args['tax_query'] = array(
			array(
				'taxonomy' => $taxonomy,
				'terms'    => array_merge( $term_array, $excluded_terms ),
			),
		);
	}

	return get_posts( $query_args );
}