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

[WordPress Trac]

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

  * status:  closed => reopened
  * resolution:  worksforme =>
  * milestone:  => 2.7.1

Comment:

 jacobsantos wrote:
 >From inline documentation of get_search_form():
 >>"Will first attempt to locate the searchform.php file in either the
 child or the parent, then load it. If it doesn't exist, then the default
 search form will be displayed."

 Yes, I read that part before I opened this ticket. It's the "default
 search form" that I want to modify (and which other users also clearly
 want to be able to modify. None of the Codex documentation explains how to
 do that. All it says (beyond what you've quoted above) is:
   "The tag can also be filtered with the get_search_form filter, allowing
 plugin authors or theme designers to alter the structure of the search
 form entirely."

 Telling users/developers that something ''can'' be done without telling
 them ''how'' to do it is not very helpful. The docs need to be improved to
 explain ''how'' to do it.

 Also, presumably get_search_form ought to be documented at
 [http://codex.wordpress.org/Plugin_API/Filter_Reference].

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