WP_Query::is_search(): bool

Is the query for a search?

Contents

Return
Source
Related
- Used By
Changelog
User Contributed Notes
- Feedback

Return

bool Whether the query is for a search.

Source

File: wp-includes/class-wp-query.php. View all references

public function is_search() {
	return (bool) $this->is_search;
}

View on Trac View on GitHub

Used By

Used By
Used By	Description
is_search() wp-includes/query.php	Determines whether the query is for a search.

Changelog

Changelog
Version	Description
3.1.0	Introduced.

User Contributed Notes

Skip to note 1 content

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

Contributed by lazhar007 — 2 years ago
```
/**
 * INCLUDE CUSTOM POST TYPES IN SEARCH RESULTS
 */
function wpdocs_cpt_in_search( $query ) {
    if ( ! is_admin() && $query->is_main_query() ) {
        if ( $query->is_search ) {
            $query->set( 'post_type', array( 'convention' ) );
        }
    }
}

add_action( 'pre_get_posts', 'wpdocs_cpt_in_search' );
```
Top ↑
Feedback
- This is not ideal, as it will override existing post types being searched. Better option is to adjust the exclude_from_search parameter when registering the post type or via the register_post_type_args filter. — By crstauf — 2 years ago
Log in to add feedback

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