[wp-trac] Re: [WordPress Trac] #8799: get_search_form() is inadequately documented

[WordPress Trac]

#8799: get_search_form() is inadequately documented
----------------------------------------------+-----------------------------
 Reporter:  sampablokuper                     |        Owner:  jacobsantos
     Type:  enhancement                       |       Status:  new        
 Priority:  normal                            |    Milestone:             
Component:  WordPress.org                     |      Version:  2.7        
 Severity:  normal                            |   Resolution:             
 Keywords:  search theme documentation codex  |  
----------------------------------------------+-----------------------------
Changes (by jacobsantos):

  * owner:  matt => jacobsantos
  * status:  reopened => new
  * milestone:  2.7.1 =>

Comment:

 Whoever said searchform.php was deprecated was wrong. It is not deprecated
 in 2.7. There was some complaint about deprecating searchform.php, so even
 if the word on the street was that it was being deprecated, it ended up
 not being deprecated. The Trac people and the Codex people do not often
 talk to each other.

 Also, if you are using the search widget, then it will use the
 searchform.php template file as well, so to say that something that is
 used in both places is deprecated, well that is either misinformation or
 wrong information.

 As for examples, I would have to give an sarcastic reply, "Do you want us
 to wipe your ass as well?" Yes, examples would be an nice addition.
 Luckily, there is a group of people that might make your wishes come true
 on the Codex.

 As well, the hook will only be used if and only if the searchform.php file
 is not found. Therefore, if you rely on the hook, then you'll be SOL when
 the theme includes the searchform.php file.

 The whole issue is that, there are two ways for a '''theme''' to change
 the search form on the widget and if the user hard codes it. You don't
 need to create a plugin and in this case, it is better if you don't.

 I think the wording is arbitrarily, in that it doesn't mean the
 searchform.php is deprecated, it is just clarifying why there are two ways
 to skin the cat (so to speak, although I have no idea why you would skin a
 cat).

 So in summary:

 Examples: In progress, look for it in about one to three months at the
 least.
 Wording: A little vague, but the summary works. The Inline documentation
 can also be updated to clarify the situation.

-- 
Ticket URL: <http://trac.wordpress.org/ticket/8799#comment:6>
WordPress Trac <http://trac.wordpress.org/>
WordPress blogging software