Changeset 10411 for trunk/wp-includes/general-template.php

Timestamp:

01/22/2009 09:17:52 PM (16 years ago)

Author:

westi

Message:

PHPdoc updates. See €8805 props jacobsantos.

File:

• trunk/wp-includes/general-template.php (modified) (1 diff)

trunk/wp-includes/general-template.php

@@ -99 +99 @@
  * 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.
+ * will be displayed. The default search form is HTML, which will be displayed.
+ * There is a filter applied to the search form HTML in order to edit or replace
+ * it. The filter is 'get_search_form'.
+ *
+ * This function is primarily used by themes which want to hardcode the search
+ * form into the sidebar and also by the search widget in WordPress.
+ *
+ * There is also an action that is called whenever the function is run called,
+ * 'get_search_form'. This can be useful for outputting JavaScript that the
+ * search relies on or various formatting that applies to the beginning of the
+ * search. To give a few examples of what it can be used for.
  *
  * @since 2.7.0