inretio/WordPress-Plugin-Boilerplate
1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2024-12-22 11:53:53 +02:00
Code Issues Releases Wiki Activity

Add inline docs in the loader class #338

Browse source
This commit is contained in:
Josh Pollock 2015-10-02 15:35:30 -04:00
parent 55f28eeb9f
commit 897fa95e23
1 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
plugin-name/includes/class-plugin-name-loader.php
View file

@ -57,11 +57,11 @@ class Plugin_Name_Loader {
* Add a new action to the collection to be registered with WordPress. * Add a new action to the collection to be registered with WordPress.
* *
* @since 1.0.0 * @since 1.0.0
* @param string $hook The name of the WordPress action that is being registered. * @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 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 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 $priority Optional. he priority at which the function should be fired. Default is 10.
* @param int Optional $accepted_args The number of arguments that should be passed to the $callback. * @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 ) { public function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
$this->actions = $this->add( $this->actions, $hook, $component, $callback, $priority, $accepted_args ); $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. * Add a new filter to the collection to be registered with WordPress.
* *
* @since 1.0.0 * @since 1.0.0
* @param string $hook The name of the WordPress filter that is being registered. * @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 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 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 $priority Optional. he priority at which the function should be fired. Default is 10.
* @param int Optional $accepted_args The number of arguments that should be passed to the $callback. * @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 ) { public function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
$this->filters = $this->add( $this->filters, $hook, $component, $callback, $priority, $accepted_args ); $this->filters = $this->add( $this->filters, $hook, $component, $callback, $priority, $accepted_args );
@ -87,13 +87,13 @@ class Plugin_Name_Loader {
* *
* @since 1.0.0 * @since 1.0.0
* @access private * @access private
* @param array $hooks The collection of hooks that is being registered (that is, actions or filters). * @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 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 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 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 $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 int $accepted_args The number of arguments that should be passed to the $callback.
* @return type The collection of actions and filters registered with WordPress. * @return array The collection of actions and filters registered with WordPress.
*/ */
private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) { private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) {