From 897fa95e238c327974e7a68a46ec37f9a95cf262 Mon Sep 17 00:00:00 2001 From: Josh Pollock Date: Fri, 2 Oct 2015 15:35:30 -0400 Subject: [PATCH] Add inline docs in the loader class #338 --- .../includes/class-plugin-name-loader.php | 34 +++++++++---------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/plugin-name/includes/class-plugin-name-loader.php b/plugin-name/includes/class-plugin-name-loader.php index 3d2febc..6f96a74 100644 --- a/plugin-name/includes/class-plugin-name-loader.php +++ b/plugin-name/includes/class-plugin-name-loader.php @@ -57,11 +57,11 @@ class Plugin_Name_Loader { * Add a new action to the collection to be registered with WordPress. * * @since 1.0.0 - * @param string $hook The name of the WordPress action that is being registered. - * @param object $component A reference to the instance of the object on which the action is defined. - * @param string $callback The name of the function definition on the $component. - * @param int Optional $priority The priority at which the function should be fired. - * @param int Optional $accepted_args The number of arguments that should be passed to the $callback. + * @param string $hook The name of the WordPress action that is being registered. + * @param object $component A reference to the instance of the object on which the action is defined. + * @param string $callback The name of the function definition on the $component. + * @param int $priority Optional. he priority at which the function should be fired. Default is 10. + * @param int $accepted_args Optional. The number of arguments that should be passed to the $callback. Default is 1. */ public function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) { $this->actions = $this->add( $this->actions, $hook, $component, $callback, $priority, $accepted_args ); @@ -71,11 +71,11 @@ class Plugin_Name_Loader { * Add a new filter to the collection to be registered with WordPress. * * @since 1.0.0 - * @param string $hook The name of the WordPress filter that is being registered. - * @param object $component A reference to the instance of the object on which the filter is defined. - * @param string $callback The name of the function definition on the $component. - * @param int Optional $priority The priority at which the function should be fired. - * @param int Optional $accepted_args The number of arguments that should be passed to the $callback. + * @param string $hook The name of the WordPress filter that is being registered. + * @param object $component A reference to the instance of the object on which the filter is defined. + * @param string $callback The name of the function definition on the $component. + * @param int $priority Optional. he priority at which the function should be fired. Default is 10. + * @param int $accepted_args Optional. The number of arguments that should be passed to the $callback. Default is 1 */ public function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) { $this->filters = $this->add( $this->filters, $hook, $component, $callback, $priority, $accepted_args ); @@ -87,13 +87,13 @@ class Plugin_Name_Loader { * * @since 1.0.0 * @access private - * @param array $hooks The collection of hooks that is being registered (that is, actions or filters). - * @param string $hook The name of the WordPress filter that is being registered. - * @param object $component A reference to the instance of the object on which the filter is defined. - * @param string $callback The name of the function definition on the $component. - * @param int Optional $priority The priority at which the function should be fired. - * @param int Optional $accepted_args The number of arguments that should be passed to the $callback. - * @return type The collection of actions and filters registered with WordPress. + * @param array $hooks The collection of hooks that is being registered (that is, actions or filters). + * @param string $hook The name of the WordPress filter that is being registered. + * @param object $component A reference to the instance of the object on which the filter is defined. + * @param string $callback The name of the function definition on the $component. + * @param int $priority The priority at which the function should be fired. + * @param int $accepted_args The number of arguments that should be passed to the $callback. + * @return array The collection of actions and filters registered with WordPress. */ private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) {