enmi-conf.org: comparison wp/wp-includes/class-wp-hook.php

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 	 *
 	 * @since 4.7.0
 	 *
 	 * @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.
-	 * @param int      $priority        The order in which the functions associated with a
+	 * @param int      $priority        The order in which the functions associated with a particular action
-	 *                                  particular action are executed. Lower numbers correspond with
+	 *                                  are executed. Lower numbers correspond with earlier execution,
-	 *                                  earlier execution, and functions with the same priority are executed
+	 *                                  and functions with the same priority are executed in the order
-	 *                                  in the order in which they were added to the action.
+	 *                                  in which they were added to the action.
 	 * @param int      $accepted_args   The number of arguments the function accepts.
 	 */
 	public function add_filter( $tag, $function_to_add, $priority, $accepted_args ) {
-		$idx              = _wp_filter_build_unique_id( $tag, $function_to_add, $priority );
+		$idx = _wp_filter_build_unique_id( $tag, $function_to_add, $priority );
 		$priority_existed = isset( $this->callbacks[ $priority ] );
 		$this->callbacks[ $priority ][ $idx ] = array(
 			'function'      => $function_to_add,
 			'accepted_args' => $accepted_args,
 		);
-		// if we're adding a new priority to the list, put them back in sorted order
+		// If we're adding a new priority to the list, put them back in sorted order.
 		if ( ! $priority_existed && count( $this->callbacks ) > 1 ) {
 			ksort( $this->callbacks, SORT_NUMERIC );
 		}
 		if ( $this->nesting_level > 0 ) {
 			$this->resort_active_iterations( $priority, $priority_existed );
 		}
 	}
 	/**
-	 * Handles reseting callback priority keys mid-iteration.
+	 * Handles resetting callback priority keys mid-iteration.
 	 *
 	 * @since 4.7.0
 	 *
 	 * @param bool|int $new_priority     Optional. The priority of the new filter being added. Default false,
 	 *                                   for no priority being added.
 			}
 			// If we have a new priority that didn't exist, but ::apply_filters() or ::do_action() thinks it's the current priority...
 			if ( $new_priority === $this->current_priority[ $index ] && ! $priority_existed ) {
 				/*
-				 * ... and the new priority is the same as what $this->iterations thinks is the previous
+				 * ...and the new priority is the same as what $this->iterations thinks is the previous
 				 * priority, we need to move back to it.
 				 */
 				if ( false === current( $iteration ) ) {
 					// If we've already moved off the end of the array, go back to the last element.
 	/**
 	 * Unhooks a function or method from a specific filter action.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @param string   $tag                The filter hook to which the function to be removed is hooked. Used
+	 * @param string   $tag                The filter hook to which the function to be removed is hooked.
-	 *                                     for building the callback ID when SPL is not available.
 	 * @param callable $function_to_remove The callback to be removed from running when the filter is applied.
 	 * @param int      $priority           The exact priority used when adding the original filter callback.
 	 * @return bool Whether the callback existed before it was removed.
 	 */
 	public function remove_filter( $tag, $function_to_remove, $priority ) {
 	/**
 	 * Checks if a specific action has been registered for this hook.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @param string        $tag               Optional. The name of the filter hook. Used for building
+	 * @param string        $tag               Optional. The name of the filter hook. Default empty.
-	 *                                         the callback ID when SPL is not available. Default empty.
 	 * @param callable|bool $function_to_check Optional. The callback to check for. Default false.
 	 * @return bool|int The priority of that hook is returned, or false if the function is not attached.
 	 */
 	public function has_filter( $tag = '', $function_to_check = false ) {
 		if ( false === $function_to_check ) {
 			$this->resort_active_iterations();
 		}
 	}
 	/**
-	 * Calls the callback functions added to a filter hook.
+	 * Calls the callback functions that have been added to a filter hook.
 	 *
 	 * @since 4.7.0
 	 *
 	 * @param mixed $value The value to filter.
-	 * @param array $args  Arguments to pass to callbacks.
+	 * @param array $args  Additional parameters to pass to the callback functions.
+	 *                     This array is expected to include $value at index 0.
 	 * @return mixed The filtered value after all hooked functions are applied to it.
 	 */
 	public function apply_filters( $value, $args ) {
 		if ( ! $this->callbacks ) {
 			return $value;
 		$this->iterations[ $nesting_level ] = array_keys( $this->callbacks );
 		$num_args                           = count( $args );
 		do {
-			$this->current_priority[ $nesting_level ] = $priority = current( $this->iterations[ $nesting_level ] );
+			$this->current_priority[ $nesting_level ] = current( $this->iterations[ $nesting_level ] );
+			$priority                                 = $this->current_priority[ $nesting_level ];
 			foreach ( $this->callbacks[ $priority ] as $the_ ) {
 				if ( ! $this->doing_action ) {
 					$args[0] = $value;
 				}
-				// Avoid the array_slice if possible.
+				// Avoid the array_slice() if possible.
-				if ( $the_['accepted_args'] == 0 ) {
+				if ( 0 == $the_['accepted_args'] ) {
-					$value = call_user_func_array( $the_['function'], array() );
+					$value = call_user_func( $the_['function'] );
 				} elseif ( $the_['accepted_args'] >= $num_args ) {
 					$value = call_user_func_array( $the_['function'], $args );
 				} else {
 					$value = call_user_func_array( $the_['function'], array_slice( $args, 0, (int) $the_['accepted_args'] ) );
 				}
 		return $value;
 	}
 	/**
-	 * Executes the callback functions hooked on a specific action hook.
+	 * Calls the callback functions that have been added to an action hook.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @param mixed $args Arguments to pass to the hook callbacks.
+	 * @param array $args Parameters to pass to the callback functions.
 	 */
 	public function do_action( $args ) {
 		$this->doing_action = true;
 		$this->apply_filters( '', $args );
 	/**
 	 * Determines whether an offset value exists.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @link https://secure.php.net/manual/en/arrayaccess.offsetexists.php
+	 * @link https://www.php.net/manual/en/arrayaccess.offsetexists.php
 	 *
 	 * @param mixed $offset An offset to check for.
 	 * @return bool True if the offset exists, false otherwise.
 	 */
 	public function offsetExists( $offset ) {
 	/**
 	 * Retrieves a value at a specified offset.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @link https://secure.php.net/manual/en/arrayaccess.offsetget.php
+	 * @link https://www.php.net/manual/en/arrayaccess.offsetget.php
 	 *
 	 * @param mixed $offset The offset to retrieve.
 	 * @return mixed If set, the value at the specified offset, null otherwise.
 	 */
 	public function offsetGet( $offset ) {
 	/**
 	 * Sets a value at a specified offset.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @link https://secure.php.net/manual/en/arrayaccess.offsetset.php
+	 * @link https://www.php.net/manual/en/arrayaccess.offsetset.php
 	 *
 	 * @param mixed $offset The offset to assign the value to.
 	 * @param mixed $value The value to set.
 	 */
 	public function offsetSet( $offset, $value ) {
 	/**
 	 * Unsets a specified offset.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @link https://secure.php.net/manual/en/arrayaccess.offsetunset.php
+	 * @link https://www.php.net/manual/en/arrayaccess.offsetunset.php
 	 *
 	 * @param mixed $offset The offset to unset.
 	 */
 	public function offsetUnset( $offset ) {
 		unset( $this->callbacks[ $offset ] );
 	/**
 	 * Returns the current element.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @link https://secure.php.net/manual/en/iterator.current.php
+	 * @link https://www.php.net/manual/en/iterator.current.php
 	 *
 	 * @return array Of callbacks at current priority.
 	 */
 	public function current() {
 		return current( $this->callbacks );
 	/**
 	 * Moves forward to the next element.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @link https://secure.php.net/manual/en/iterator.next.php
+	 * @link https://www.php.net/manual/en/iterator.next.php
 	 *
 	 * @return array Of callbacks at next priority.
 	 */
 	public function next() {
 		return next( $this->callbacks );
 	/**
 	 * Returns the key of the current element.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @link https://secure.php.net/manual/en/iterator.key.php
+	 * @link https://www.php.net/manual/en/iterator.key.php
 	 *
 	 * @return mixed Returns current priority on success, or NULL on failure
 	 */
 	public function key() {
 		return key( $this->callbacks );
 	/**
 	 * Checks if current position is valid.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @link https://secure.php.net/manual/en/iterator.valid.php
+	 * @link https://www.php.net/manual/en/iterator.valid.php
 	 *
 	 * @return boolean
 	 */
 	public function valid() {
 		return key( $this->callbacks ) !== null;
 	/**
 	 * Rewinds the Iterator to the first element.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @link https://secure.php.net/manual/en/iterator.rewind.php
+	 * @link https://www.php.net/manual/en/iterator.rewind.php
 	 */
 	public function rewind() {
 		reset( $this->callbacks );
 	}

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a