Docs: Remove @access notations from method DocBlocks in wp-includes/* classes.

Prior to about 2013, many class methods lacked even access modifiers which made the `@access` notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.

See #41452.


git-svn-id: https://develop.svn.wordpress.org/trunk@41162 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes
2017-07-27 00:40:27 +00:00
parent 829139ba1a
commit b4d81bd654
135 changed files with 2 additions and 1906 deletions

View File

@@ -21,7 +21,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Hook callbacks.
*
* @since 4.7.0
* @access public
* @var array
*/
public $callbacks = array();
@@ -30,7 +29,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* The priority keys of actively running iterations of a hook.
*
* @since 4.7.0
* @access private
* @var array
*/
private $iterations = array();
@@ -39,7 +37,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* The current priority of actively running iterations of a hook.
*
* @since 4.7.0
* @access private
* @var array
*/
private $current_priority = array();
@@ -48,7 +45,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Number of levels this hook can be recursively called.
*
* @since 4.7.0
* @access private
* @var int
*/
private $nesting_level = 0;
@@ -57,7 +53,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Flag for if we're current doing an action, rather than a filter.
*
* @since 4.7.0
* @access private
* @var bool
*/
private $doing_action = false;
@@ -66,7 +61,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Hooks a function or method to a specific filter action.
*
* @since 4.7.0
* @access public
*
* @param string $tag The name of the filter to hook the $function_to_add callback to.
* @param callable $function_to_add The callback to be run when the filter is applied.
@@ -99,7 +93,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Handles reseting callback priority keys mid-iteration.
*
* @since 4.7.0
* @access private
*
* @param bool|int $new_priority Optional. The priority of the new filter being added. Default false,
* for no priority being added.
@@ -168,7 +161,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Unhooks a function or method from a specific filter action.
*
* @since 4.7.0
* @access public
*
* @param string $tag The filter hook to which the function to be removed is hooked. Used
* for building the callback ID when SPL is not available.
@@ -196,7 +188,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Checks if a specific action has been registered for this hook.
*
* @since 4.7.0
* @access public
*
* @param callable|bool $function_to_check Optional. The callback to check for. Default false.
* @param string $tag Optional. The name of the filter hook. Used for building
@@ -226,7 +217,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Checks if any callbacks have been registered for this hook.
*
* @since 4.7.0
* @access public
*
* @return bool True if callbacks have been registered for the current hook, otherwise false.
*/
@@ -243,7 +233,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Removes all callbacks from the current filter.
*
* @since 4.7.0
* @access public
*
* @param int|bool $priority Optional. The priority number to remove. Default false.
*/
@@ -267,7 +256,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Calls the callback functions added to a filter hook.
*
* @since 4.7.0
* @access public
*
* @param mixed $value The value to filter.
* @param array $args Arguments to pass to callbacks.
@@ -314,7 +302,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Executes the callback functions hooked on a specific action hook.
*
* @since 4.7.0
* @access public
*
* @param mixed $args Arguments to pass to the hook callbacks.
*/
@@ -332,7 +319,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Processes the functions hooked into the 'all' hook.
*
* @since 4.7.0
* @access public
*
* @param array $args Arguments to pass to the hook callbacks. Passed by reference.
*/
@@ -355,7 +341,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Return the current priority level of the currently running iteration of the hook.
*
* @since 4.7.0
* @access public
*
* @return int|false If the hook is running, return the current priority level. If it isn't running, return false.
*/
@@ -371,7 +356,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Normalizes filters set up before WordPress has initialized to WP_Hook objects.
*
* @since 4.7.0
* @access public
* @static
*
* @param array $filters Filters to normalize.
@@ -405,7 +389,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Determines whether an offset value exists.
*
* @since 4.7.0
* @access public
*
* @link https://secure.php.net/manual/en/arrayaccess.offsetexists.php
*
@@ -420,7 +403,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Retrieves a value at a specified offset.
*
* @since 4.7.0
* @access public
*
* @link https://secure.php.net/manual/en/arrayaccess.offsetget.php
*
@@ -435,7 +417,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Sets a value at a specified offset.
*
* @since 4.7.0
* @access public
*
* @link https://secure.php.net/manual/en/arrayaccess.offsetset.php
*
@@ -454,7 +435,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Unsets a specified offset.
*
* @since 4.7.0
* @access public
*
* @link https://secure.php.net/manual/en/arrayaccess.offsetunset.php
*
@@ -468,7 +448,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Returns the current element.
*
* @since 4.7.0
* @access public
*
* @link https://secure.php.net/manual/en/iterator.current.php
*
@@ -482,7 +461,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Moves forward to the next element.
*
* @since 4.7.0
* @access public
*
* @link https://secure.php.net/manual/en/iterator.next.php
*
@@ -496,7 +474,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Returns the key of the current element.
*
* @since 4.7.0
* @access public
*
* @link https://secure.php.net/manual/en/iterator.key.php
*
@@ -510,7 +487,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Checks if current position is valid.
*
* @since 4.7.0
* @access public
*
* @link https://secure.php.net/manual/en/iterator.valid.php
*
@@ -524,7 +500,6 @@ final class WP_Hook implements Iterator, ArrayAccess {
* Rewinds the Iterator to the first element.
*
* @since 4.7.0
* @access public
*
* @link https://secure.php.net/manual/en/iterator.rewind.php
*/