Ticket #19203: plugin.diff

wp-includes/plugin.php

@@ -22 +22 @@
 /**
  * Hooks a function or method to a specific filter action.
  *
- * Filters are the hooks that WordPress launches to modify text of various types
+ * Filters are the hooks that WordPress launches to modify data of various types
  * before adding it to the database or sending it to the browser screen. Plugins
- * can specify that one or more of its PHP functions is executed to
- * modify specific types of text at these times, using the Filter API.
+ * can specify that one or more of it's PHP functions are to be executed to
+ * modify the data at these times, using the Filter API.
  *
  * To use the API, the following code should be used to bind a callback to the
  * filter.
  *
  * <code>
- * function example_hook($example) { echo $example; }
+ * function example_hook($example) { var_dump($example); }
  * add_filter('example_filter', 'example_hook');
  * </code>
  *
@@ -111 +111 @@
  *
  * The function allows for additional arguments to be added and passed to hooks.
  * <code>
+ * // Our filter function
  * function example_hook($string, $arg1, $arg2)
  * {
  *              //Do stuff
  *              return $string;
  * }
+ * add_filter('example_filter', 'example_hook', 10, 3);
+ *
+ * // Apply the filters, which will call our 'example_hook' function since we
+ * // hooked the 'example_filter' hook in the add_filter() function.
  * $value = apply_filters('example_filter', 'filter me', 'arg1', 'arg2');
  * </code>
  *
@@ -704 +709 @@
  * @uses $wp_filter Used to process all of the functions in the 'all' hook
  *
  * @param array $args The collected parameters from the hook that was called.
- * @param string $hook Optional. The hook name that was used to call the 'all' hook.
  */
 function _wp_call_all_hook($args) {
         global $wp_filter;