Skip to content

hooks.md

Latest commit

 

History

History
546 lines (345 loc) · 15.4 KB

hooks.md

File metadata and controls

546 lines (345 loc) · 15.4 KB

Hooks

Actions

good_doc_static_action

This is a well documented action.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$option string Name of the option to update.
$old_value mixed The old option value.
$value mixed The new option value.

Changelog

Version Description
2.9.0

Source: tests/source/actions.php, line 11

good_doc_dynamic_action_{$option}

This is a well documented dynamic action.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$old_value mixed The old option value.
$value mixed The new option value.

Changelog

Version Description
2.9.0

Source: tests/source/actions.php, line 25

good_doc_double_quotes_dynamic_action_{$option}

This is a well documented dynamic action.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$old_value mixed The old option value.
$value mixed The new option value.

Changelog

Version Description
2.9.0

Source: tests/source/actions.php, line 39

missing_since_static_action

This is an action missing the "since" line.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$option string Name of the option to update.
$old_value mixed The old option value.
$value mixed The new option value.

Source: tests/source/actions.php, line 53

missing_since_dynamic_action_{$option}

This is a dynamic action missing the "since" line.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$old_value mixed The old option value.
$value mixed The new option value.

Source: tests/source/actions.php, line 65

missing_since_double_quotes_dynamic_action_{$option}

This is a dynamic action missing the "since" line.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$old_value mixed The old option value.
$value mixed The new option value.

Source: tests/source/actions.php, line 77

missing_param_static_action

This is an action missing a "param" line.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$option string Name of the option to update.
$old_value
$value mixed The new option value.

Changelog

Version Description
2.9.0

Source: tests/source/actions.php, line 89

missing_param_dynamic_action_{$option}

This is a well documented dynamic action.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$old_value
$value mixed The new option value.

Changelog

Version Description
2.9.0

Source: tests/source/actions.php, line 102

missing_param_double_quotes_dynamic_action_{$option}

This is a well documented dynamic action.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$old_value
$value mixed The new option value.

Changelog

Version Description
2.9.0

Source: tests/source/actions.php, line 115

no_doc_static_action

Arguments

Argument Type Description
$option
$old_value
$value

Source: tests/source/actions.php, line 128

no_doc_dynamic_action_{$option}

Arguments

Argument Type Description
$old_value
$value

Source: tests/source/actions.php, line 129

no_doc_double_quotes_dymanic_action_{$option}

Arguments

Argument Type Description
$old_value
$value

Source: tests/source/actions.php, line 130

test

Test action.

Arguments

Argument Type Description
$test \Pronamic\WordPress\Documentor\TestClass Test object.

Source: tests/source/tests.php, line 34

test_{$dummy}

Test tag with method call.

Arguments

Argument Type Description
$test \Pronamic\WordPress\Documentor\TestClass Test object.

Source: tests/source/tests.php, line 57

test_{$from}_to_{$to}

Test tag with var and underscores in markdown.

Arguments

Argument Type Description
$test \Pronamic\WordPress\Documentor\TestClass Test object.

Source: tests/source/tests.php, line 72

test_{$this->dummy}

Test tag with property fetch.

Arguments

Argument Type Description
$test \Pronamic\WordPress\Documentor\TestClass Test object.

Source: tests/source/tests.php, line 84

test_since

Test tag with property fetch.

Arguments

Argument Type Description
$test \Pronamic\WordPress\Documentor\TestClass Test object.

Changelog

Version Description
1.0.1 Improved documentation.
1.0.0 Introduced.

Source: tests/source/tests.php, line 98

test_union_types

Test union types.

Arguments

Argument Type Description
$value int|string Union type value, integer or string.

Changelog

Version Description
2.9.0

Source: tests/source/union-types.php, line 11

Filters

good_static_filter

This is a well documented filter.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$mce_translation array Key/value pairs of strings.
$mce_locale string Locale.

Changelog

Version Description
3.9.0

Source: tests/source/filters.php, line 11

good_dynamic_filter_{$option}

This is a well documented dynamic filter.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$value mixed The new, unserialized option value.
$old_value mixed The old option value.

Changelog

Version Description
2.6.0

Source: tests/source/filters.php, line 24

good_double_quotes_dynamic_filter_{$option}

This is a well documented dynamic filter.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$value mixed The new, unserialized option value.
$old_value mixed The old option value.

Changelog

Version Description
2.6.0

Source: tests/source/filters.php, line 37

missing_since_static_filter

This is a filter missing the "since" line.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$mce_translation
$mce_locale string Locale.

Source: tests/source/filters.php, line 50

missing_since_dynamic_filter_{$option}

This is a dynamic filter missing the "since" line.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$value mixed The new, unserialized option value.
$old_value mixed The old option value.

Source: tests/source/filters.php, line 61

missing_since_double_quotes_dynamic_filter_{$option}

This is a dynamic filter missing the "since" line.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$value mixed The new, unserialized option value.
$old_value mixed The old option value.

Source: tests/source/filters.php, line 72

missing_param_static_filter

This is a filter missing one "param" line.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$mce_translation
$mce_locale string Locale.

Changelog

Version Description
2.6.0

Source: tests/source/filters.php, line 83

missing_param_dynamic_filter_{$option}

This is a dynamic filter missing one "param" line.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$value
$old_value

Changelog

Version Description
2.6.0

Source: tests/source/filters.php, line 95

missing_param_double_quotes_dynamic_filter_{$option}

This is a dynamic filter missing one "param" line.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$value
$old_value

Changelog

Version Description
2.6.0

Source: tests/source/filters.php, line 107

multiple_since_tags

This is a filter with multiple since tags

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Arguments

Argument Type Description
$first_parameter string
$second_parameter string

Changelog

Version Description
1.9 Added a new parameter to the filter
1.0

Source: tests/source/filters.php, line 119

no_doc_static_filter

Arguments

Argument Type Description
$mce_translation
$mce_locale

Source: tests/source/filters.php, line 133

no_doc_dynamic_filter_{$option}

Arguments

Argument Type Description
$value
$old_value

Source: tests/source/filters.php, line 135

no_doc_double_quotes_dynamic_filter_{$option}

Arguments

Argument Type Description
$value
$old_value

Source: tests/source/filters.php, line 137