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

equal deleted inserted replaced

-:34716fd837a4
+:be944660c56a
 	 * @var int
 	 */
 	private $nesting_level = 0;
 	/**
-	 * Flag for if we're current doing an action, rather than a filter.
+	 * Flag for if we're currently doing an action, rather than a filter.
 	 *
 	 * @since 4.7.0
 	 * @var bool
 	 */
 	private $doing_action = false;
 	/**
-	 * Hooks a function or method to a specific filter action.
+	 * Adds a callback function to a filter hook.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @param string   $tag             The name of the filter to hook the $function_to_add callback to.
+	 * @param string   $hook_name     The name of the filter to add the callback to.
-	 * @param callable $function_to_add The callback to be run when the filter is applied.
+	 * @param callable $callback      The callback to be run when the filter is applied.
-	 * @param int      $priority        The order in which the functions associated with a particular action
+	 * @param int      $priority      The order in which the functions associated with a particular filter
-	 *                                  are executed. Lower numbers correspond with earlier execution,
+	 *                                are executed. Lower numbers correspond with earlier execution,
-	 *                                  and functions with the same priority are executed in the order
+	 *                                and functions with the same priority are executed in the order
-	 *                                  in which they were added to the action.
+	 *                                in which they were added to the filter.
-	 * @param int      $accepted_args   The number of arguments the function accepts.
+	 * @param int      $accepted_args The number of arguments the function accepts.
 	 */
-	public function add_filter( $tag, $function_to_add, $priority, $accepted_args ) {
+	public function add_filter( $hook_name, $callback, $priority, $accepted_args ) {
-		$idx = _wp_filter_build_unique_id( $tag, $function_to_add, $priority );
+		$idx = _wp_filter_build_unique_id( $hook_name, $callback, $priority );
 		$priority_existed = isset( $this->callbacks[ $priority ] );
 		$this->callbacks[ $priority ][ $idx ] = array(
-			'function'      => $function_to_add,
+			'function'      => $callback,
 			'accepted_args' => $accepted_args,
 		);
 		// If we're adding a new priority to the list, put them back in sorted order.
 		if ( ! $priority_existed && count( $this->callbacks ) > 1 ) {
 	/**
 	 * 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,
+	 * @param false|int $new_priority     Optional. The priority of the new filter being added. Default false,
-	 *                                   for no priority being added.
+	 *                                    for no priority being added.
-	 * @param bool     $priority_existed Optional. Flag for whether the priority already existed before the new
+	 * @param bool      $priority_existed Optional. Flag for whether the priority already existed before the new
-	 *                                   filter was added. Default false.
+	 *                                    filter was added. Default false.
 	 */
 	private function resort_active_iterations( $new_priority = false, $priority_existed = false ) {
 		$new_priorities = array_keys( $this->callbacks );
 		// If there are no remaining hooks, clear out all running iterations.
 		if ( ! $new_priorities ) {
 			foreach ( $this->iterations as $index => $iteration ) {
 				$this->iterations[ $index ] = $new_priorities;
 			}
 			return;
 		}
 		$min = min( $new_priorities );
 		foreach ( $this->iterations as $index => &$iteration ) {
 			$current = current( $iteration );
 			// If we're already at the end of this iteration, just leave the array pointer where it is.
 			if ( false === $current ) {
 				continue;
 			}
 					$prev = end( $iteration );
 				} else {
 					// Otherwise, just go back to the previous element.
 					$prev = prev( $iteration );
 				}
 				if ( false === $prev ) {
 					// Start of the array. Reset, and go about our day.
 					reset( $iteration );
 				} elseif ( $new_priority !== $prev ) {
 					// Previous wasn't the same. Move forward again.
 					next( $iteration );
 				}
 			}
 		}
 		unset( $iteration );
 	}
 	/**
-	 * Unhooks a function or method from a specific filter action.
+	 * Removes a callback function from a filter hook.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @param string   $tag                The filter hook to which the function to be removed is hooked.
+	 * @param string   $hook_name The filter hook to which the function to be removed is hooked.
-	 * @param callable $function_to_remove The callback to be removed from running when the filter is applied.
+	 * @param callable $callback  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.
+	 * @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 ) {
+	public function remove_filter( $hook_name, $callback, $priority ) {
-		$function_key = _wp_filter_build_unique_id( $tag, $function_to_remove, $priority );
+		$function_key = _wp_filter_build_unique_id( $hook_name, $callback, $priority );
 		$exists = isset( $this->callbacks[ $priority ][ $function_key ] );
 		if ( $exists ) {
 			unset( $this->callbacks[ $priority ][ $function_key ] );
 			if ( ! $this->callbacks[ $priority ] ) {
 				unset( $this->callbacks[ $priority ] );
 				if ( $this->nesting_level > 0 ) {
 					$this->resort_active_iterations();
 				}
 			}
 		}
 		return $exists;
 	}
 	/**
-	 * Checks if a specific action has been registered for this hook.
+	 * Checks if a specific callback has been registered for this hook.
 	 *
-	 * @since 4.7.0
+	 * When using the `$callback` argument, this function may return a non-boolean value
-	 *
+	 * that evaluates to false (e.g. 0), so use the `===` operator for testing the return value.
-	 * @param string        $tag               Optional. The name of the filter hook. Default empty.
+	 *
-	 * @param callable|bool $function_to_check Optional. The callback to check for. Default false.
+	 * @since 4.7.0
-	 * @return bool|int The priority of that hook is returned, or false if the function is not attached.
+	 *
-	 */
+	 * @param string         $hook_name Optional. The name of the filter hook. Default empty.
-	public function has_filter( $tag = '', $function_to_check = false ) {
+	 * @param callable|false $callback  Optional. The callback to check for. Default false.
-		if ( false === $function_to_check ) {
+	 * @return bool|int If `$callback` is omitted, returns boolean for whether the hook has
+	 *                  anything registered. When checking a specific function, the priority
+	 *                  of that hook is returned, or false if the function is not attached.
+	 */
+	public function has_filter( $hook_name = '', $callback = false ) {
+		if ( false === $callback ) {
 			return $this->has_filters();
 		}
-		$function_key = _wp_filter_build_unique_id( $tag, $function_to_check, false );
+		$function_key = _wp_filter_build_unique_id( $hook_name, $callback, false );
 		if ( ! $function_key ) {
 			return false;
 		}
 		foreach ( $this->callbacks as $priority => $callbacks ) {
 		foreach ( $this->callbacks as $callbacks ) {
 			if ( $callbacks ) {
 				return true;
 			}
 		}
 		return false;
 	}
 	/**
 	 * Removes all callbacks from the current filter.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @param int|bool $priority Optional. The priority number to remove. Default false.
+	 * @param int|false $priority Optional. The priority number to remove. Default false.
 	 */
 	public function remove_all_filters( $priority = false ) {
 		if ( ! $this->callbacks ) {
 			return;
 		}
 		$nesting_level                      = $this->nesting_level++;
 		$this->iterations[ $nesting_level ] = array_keys( $this->callbacks );
 		do {
 			$priority = current( $this->iterations[ $nesting_level ] );
 			foreach ( $this->callbacks[ $priority ] as $the_ ) {
 				call_user_func_array( $the_['function'], $args );
 			}
 		} while ( false !== next( $this->iterations[ $nesting_level ] ) );
 	/**
 	 * Return the current priority level of the currently running iteration of the hook.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @return int|false If the hook is running, return the current priority level. If it isn't running, return false.
+	 * @return int|false If the hook is running, return the current priority level.
+	 *                   If it isn't running, return false.
 	 */
 	public function current_priority() {
 		if ( false === current( $this->iterations ) ) {
 			return false;
 		}
 	}
 	/**
 	 * Normalizes filters set up before WordPress has initialized to WP_Hook objects.
 	 *
-	 * @since 4.7.0
+	 * The `$filters` parameter should be an array keyed by hook name, with values
-	 *
+	 * containing either:
-	 * @param array $filters Filters to normalize.
+	 *
+	 *  - A `WP_Hook` instance
+	 *  - An array of callbacks keyed by their priorities
+	 *
+	 * Examples:
+	 *
+	 *     $filters = array(
+	 *         'wp_fatal_error_handler_enabled' => array(
+	 *             10 => array(
+	 *                 array(
+	 *                     'accepted_args' => 0,
+	 *                     'function'      => function() {
+	 *                         return false;
+	 *                     },
+	 *                 ),
+	 *             ),
+	 *         ),
+	 *     );
+	 *
+	 * @since 4.7.0
+	 *
+	 * @param array $filters Filters to normalize. See documentation above for details.
 	 * @return WP_Hook[] Array of normalized filters.
 	 */
 	public static function build_preinitialized_hooks( $filters ) {
 		/** @var WP_Hook[] $normalized */
 		$normalized = array();
-		foreach ( $filters as $tag => $callback_groups ) {
+		foreach ( $filters as $hook_name => $callback_groups ) {
 			if ( is_object( $callback_groups ) && $callback_groups instanceof WP_Hook ) {
-				$normalized[ $tag ] = $callback_groups;
+				$normalized[ $hook_name ] = $callback_groups;
 				continue;
 			}
 			$hook = new WP_Hook();
 			// Loop through callback groups.
 			foreach ( $callback_groups as $priority => $callbacks ) {
 				// Loop through callbacks.
 				foreach ( $callbacks as $cb ) {
-					$hook->add_filter( $tag, $cb['function'], $priority, $cb['accepted_args'] );
+					$hook->add_filter( $hook_name, $cb['function'], $priority, $cb['accepted_args'] );
 				}
 			}
-			$normalized[ $tag ] = $hook;
-		}
+			$normalized[ $hook_name ] = $hook;
+		}
 		return $normalized;
 	}
 	/**
 	 * Determines whether an offset value exists.
 	 *
 	 * @since 4.7.0
 	 *
 	 * @link https://www.php.net/manual/en/iterator.valid.php
 	 *
-	 * @return boolean
+	 * @return bool Whether the current position is valid.
 	 */
 	public function valid() {
 		return key( $this->callbacks ) !== null;
 	}

changeset 18	be944660c56a
parent 16	a86126ab1dd4
child 19	3d72ae0968f4