How can I determine from within a module or theme if the current page is an Apache solr search results page?
asked Mar 2, 2011 at 21:00
-
2Which way are you trying to identify it? From within code?– John FialaCommented Mar 2, 2011 at 21:01
-
Are you referring to a Google search result (from an external site)? Or are you referring to a Drupal search result (from an internal search)? And what is the context (block, module, template, etc) ?– Jason SmithCommented Mar 2, 2011 at 21:09
Add a comment
|
5 Answers
If you're trying to determine from a module then you can check if the page is the search results page via the path arguments using the arg() function.
if (arg(0) == 'search') {
TRUE
}
else {
FALSE
}
-
This is what I have used before. It worked pretty well. Commented Mar 3, 2011 at 0:08
-
1You might have to test for an arg(1) as well to ensure it is actually a 'results' page and not the search landing page– wiifmCommented Mar 3, 2011 at 7:02
-
-
What Jeremy said, for starters... but you should be able to check for whatever paths you're using :-) Now, you might also want to check to see if there's a third arg (arg(2)) present, which means you're on a search result page... Commented Mar 3, 2011 at 18:12
From a theming point of view you could simply use
<?php if ($search_results) : ?>
<!-- Do this on search results pages -->
<?php endif; ?>
$search_results should only return true if you are on a search results page.
If you're looking into styling the results themselves you might want to look into search-result.tpl.php
If you are looking to find if solr has been searched you can use the apachesolr_has_searched() function.
This won't indicate if you are on a search results page, as once you start using solr views the definition of a search results page is fuzzy, but it can tell you if a solr search has been performed.
Just for reference apachesolr_static_response_cache() will give you solrs' response, and apachesolr_current_query() will give you information on the query.
To verify if a page is a search page, you should verify the first path element of the current URL is search, and the second path element is the name of a module that implements hook_search(). (I used a temporary variable, and added extra parentheses just to be make the code more readable.)
$bool = ((arg(0) == 'search') &&
($module == arg(1)) && module_invoke($module, 'search', 'name')
);
if ($bool) {
// The page is a search page returned from apachesolr.module.
}
In the specific case, considering that you want to verify if a page is a result page returned from apachesolr.module, the code can be simplified as follows:
if ((arg(0) == 'search') && (arg(1) == 'apachesolr')) {
// The page is a search page returned from apachesolr.module.
}
The reason the generic code can be simplified is that you know the name of the module, and that module surely implements hook_search().
The generic code verify the value returned by hook_search() when the last parameter is equal to "name" because there are modules that implement hook_search() only partially. At least that what I discovered when I was debugging the code of OpenSearch Feed.
answered Mar 12, 2011 at 23:09
In case you are talking about a theme or module you could check the current URL/path if it begins with "search".
-
Funny how my answer is downvoted without an explaining comment, while other answers with the same solution are upvoted... Commented Mar 3, 2011 at 10:13
-
4I didn't downvote, but it's probably because of the lack of a code sample or something more substantive :-/ Commented Mar 3, 2011 at 18:13