]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/plugin.php
Wordpress 3.1.1
[autoinstalls/wordpress.git] / wp-includes / plugin.php
index b00ed08a1c321248a1ed525c8cc291807ef5c84d..0c10e242f52a97aef1ec8d6e5101a06280f8b409 100644 (file)
@@ -53,7 +53,7 @@
  * @subpackage Plugin
  * @since 0.71
  * @global array $wp_filter Stores all of the filters added in the form of
- *     wp_filter['tag']['array of priorities']['array of functions serialized']['array of ['array (functions, accepted_args)]']
+ *     wp_filter['tag']['array of priorities']['array of functions serialized']['array of ['array (functions, accepted_args)']']
  * @global array $merged_filters Tracks the tags that need to be merged for later. If the hook is added, it doesn't need to run through that process.
  *
  * @param string $tag The name of the filter to hook the $function_to_add to.
@@ -173,6 +173,59 @@ function apply_filters($tag, $value) {
        return $value;
 }
 
+/**
+ * Execute functions hooked on a specific filter hook, specifying arguments in an array.
+ *
+ * @see apply_filters() This function is identical, but the arguments passed to the
+ * functions hooked to <tt>$tag</tt> are supplied using an array.
+ *
+ * @package WordPress
+ * @subpackage Plugin
+ * @since 3.0.0
+ * @global array $wp_filter Stores all of the filters
+ * @global array $merged_filters Merges the filter hooks using this function.
+ * @global array $wp_current_filter stores the list of current filters with the current one last
+ *
+ * @param string $tag The name of the filter hook.
+ * @param array $args The arguments supplied to the functions hooked to <tt>$tag</tt>
+ * @return mixed The filtered value after all hooked functions are applied to it.
+ */
+function apply_filters_ref_array($tag, $args) {
+       global $wp_filter, $merged_filters, $wp_current_filter;
+
+       $wp_current_filter[] = $tag;
+
+       // Do 'all' actions first
+       if ( isset($wp_filter['all']) ) {
+               $all_args = func_get_args();
+               _wp_call_all_hook($all_args);
+       }
+
+       if ( !isset($wp_filter[$tag]) ) {
+               array_pop($wp_current_filter);
+               return $args[0];
+       }
+
+       // Sort
+       if ( !isset( $merged_filters[ $tag ] ) ) {
+               ksort($wp_filter[$tag]);
+               $merged_filters[ $tag ] = true;
+       }
+
+       reset( $wp_filter[ $tag ] );
+
+       do {
+               foreach( (array) current($wp_filter[$tag]) as $the_ )
+                       if ( !is_null($the_['function']) )
+                               $args[0] = call_user_func_array($the_['function'], array_slice($args, 0, (int) $the_['accepted_args']));
+
+       } while ( next($wp_filter[$tag]) !== false );
+
+       array_pop( $wp_current_filter );
+
+       return $args[0];
+}
+
 /**
  * Removes a function from a specified filter hook.
  *
@@ -222,7 +275,7 @@ function remove_all_filters($tag, $priority = false) {
        global $wp_filter, $merged_filters;
 
        if( isset($wp_filter[$tag]) ) {
-               if( false !== $priority && isset($$wp_filter[$tag][$priority]) )
+               if( false !== $priority && isset($wp_filter[$tag][$priority]) )
                        unset($wp_filter[$tag][$priority]);
                else
                        unset($wp_filter[$tag]);
@@ -299,10 +352,13 @@ function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1)
 function do_action($tag, $arg = '') {
        global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
 
-       if ( is_array($wp_actions) )
-               $wp_actions[] = $tag;
+       if ( ! isset($wp_actions) )
+               $wp_actions = array();
+
+       if ( ! isset($wp_actions[$tag]) )
+               $wp_actions[$tag] = 1;
        else
-               $wp_actions = array($tag);
+               ++$wp_actions[$tag];
 
        $wp_current_filter[] = $tag;
 
@@ -318,7 +374,7 @@ function do_action($tag, $arg = '') {
        }
 
        $args = array();
-       if ( is_array($arg) && 1 == count($arg) && is_object($arg[0]) ) // array(&$this)
+       if ( is_array($arg) && 1 == count($arg) && isset($arg[0]) && is_object($arg[0]) ) // array(&$this)
                $args[] =& $arg[0];
        else
                $args[] = $arg;
@@ -357,10 +413,10 @@ function do_action($tag, $arg = '') {
 function did_action($tag) {
        global $wp_actions;
 
-       if ( empty($wp_actions) )
+       if ( ! isset( $wp_actions ) || ! isset( $wp_actions[$tag] ) )
                return 0;
 
-       return count(array_keys($wp_actions, $tag));
+       return $wp_actions[$tag];
 }
 
 /**
@@ -382,10 +438,13 @@ function did_action($tag) {
 function do_action_ref_array($tag, $args) {
        global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
 
-       if ( !is_array($wp_actions) )
-               $wp_actions = array($tag);
+       if ( ! isset($wp_actions) )
+               $wp_actions = array();
+
+       if ( ! isset($wp_actions[$tag]) )
+               $wp_actions[$tag] = 1;
        else
-               $wp_actions[] = $tag;
+               ++$wp_actions[$tag];
 
        $wp_current_filter[] = $tag;
 
@@ -492,10 +551,39 @@ function plugin_basename($file) {
        $file = preg_replace('|/+|','/', $file); // remove any duplicate slash
        $plugin_dir = str_replace('\\','/',WP_PLUGIN_DIR); // sanitize for Win32 installs
        $plugin_dir = preg_replace('|/+|','/', $plugin_dir); // remove any duplicate slash
-       $file = preg_replace('|^' . preg_quote($plugin_dir, '|') . '/|','',$file); // get relative path from plugins dir
+       $mu_plugin_dir = str_replace('\\','/',WPMU_PLUGIN_DIR); // sanitize for Win32 installs
+       $mu_plugin_dir = preg_replace('|/+|','/', $mu_plugin_dir); // remove any duplicate slash
+       $file = preg_replace('#^' . preg_quote($plugin_dir, '#') . '/|^' . preg_quote($mu_plugin_dir, '#') . '/#','',$file); // get relative path from plugins dir
+       $file = trim($file, '/');
        return $file;
 }
 
+/**
+ * Gets the filesystem directory path (with trailing slash) for the plugin __FILE__ passed in
+ * @package WordPress
+ * @subpackage Plugin
+ * @since 2.8
+ *
+ * @param string $file The filename of the plugin (__FILE__)
+ * @return string the filesystem path of the directory that contains the plugin
+ */
+function plugin_dir_path( $file ) {
+       return trailingslashit( dirname( $file ) );
+}
+
+/**
+ * Gets the URL directory path (with trailing slash) for the plugin __FILE__ passed in
+ * @package WordPress
+ * @subpackage Plugin
+ * @since 2.8
+ *
+ * @param string $file The filename of the plugin (__FILE__)
+ * @return string the URL path of the directory that contains the plugin
+ */
+function plugin_dir_url( $file ) {
+       return trailingslashit( plugins_url( '', $file ) );
+}
+
 /**
  * Set the activation hook for a plugin.
  *
@@ -512,8 +600,6 @@ function plugin_basename($file) {
  * @subpackage Plugin
  * @since 2.0
  *
- * @access private
- *
  * @param string $file The filename of the plugin including the path.
  * @param callback $function the function hooked to the 'activate_PLUGIN' action.
  */
@@ -539,8 +625,6 @@ function register_activation_hook($file, $function) {
  * @subpackage Plugin
  * @since 2.0
  *
- * @access private
- *
  * @param string $file The filename of the plugin including the path.
  * @param callback $function the function hooked to the 'activate_PLUGIN' action.
  */
@@ -572,9 +656,14 @@ function register_deactivation_hook($file, $function) {
  * @since 2.7
  *
  * @param string $file
- * @param callback $callback The callback to run when the hook is called.
+ * @param callback $callback The callback to run when the hook is called. Must be a static method or function.
  */
-function register_uninstall_hook($file, $callback) {
+function register_uninstall_hook( $file, $callback ) {
+       if ( is_array( $callback ) && is_object( $callback[0] ) ) {
+               _doing_it_wrong( __FUNCTION__, __( 'Only a static class method or function can be used in an uninstall hook.' ), '3.1' );
+               return;
+       }
+
        // The option should not be autoloaded, because it is not needed in most
        // cases. Emphasis should be put on using the 'uninstall.php' way of
        // uninstalling the plugin.
@@ -641,34 +730,46 @@ function _wp_call_all_hook($args) {
  *
  * @global array $wp_filter Storage for all of the filters and actions
  * @param string $tag Used in counting how many hooks were applied
- * @param string|array $function Used for creating unique id
+ * @param callback $function Used for creating unique id
  * @param int|bool $priority Used in counting how many hooks were applied.  If === false and $function is an object reference, we return the unique id only if it already has one, false otherwise.
- * @param string $type filter or action
- * @return string Unique ID for usage as array key
+ * @return string|bool Unique ID for usage as array key or false if $priority === false and $function is an object reference, and it does not already have a uniqe id.
  */
 function _wp_filter_build_unique_id($tag, $function, $priority) {
        global $wp_filter;
+       static $filter_id_count = 0;
 
-       // If function then just skip all of the tests and not overwrite the following.
        if ( is_string($function) )
                return $function;
-       // Object Class Calling
-       else if (is_object($function[0]) ) {
-               $obj_idx = get_class($function[0]).$function[1];
-               if ( !isset($function[0]->wp_filter_id) ) {
-                       if ( false === $priority )
-                               return false;
-                       $count = isset($wp_filter[$tag][$priority]) ? count((array)$wp_filter[$tag][$priority]) : 0;
-                       $function[0]->wp_filter_id = $count;
-                       $obj_idx .= $count;
-                       unset($count);
-               } else
-                       $obj_idx .= $function[0]->wp_filter_id;
-               return $obj_idx;
+
+       if ( is_object($function) ) {
+               // Closures are currently implemented as objects
+               $function = array( $function, '' );
+       } else {
+               $function = (array) $function;
        }
-       // Static Calling
-       else if ( is_string($function[0]) )
+
+       if (is_object($function[0]) ) {
+               // Object Class Calling
+               if ( function_exists('spl_object_hash') ) {
+                       return spl_object_hash($function[0]) . $function[1];
+               } else {
+                       $obj_idx = get_class($function[0]).$function[1];
+                       if ( !isset($function[0]->wp_filter_id) ) {
+                               if ( false === $priority )
+                                       return false;
+                               $obj_idx .= isset($wp_filter[$tag][$priority]) ? count((array)$wp_filter[$tag][$priority]) : $filter_id_count;
+                               $function[0]->wp_filter_id = $filter_id_count;
+                               ++$filter_id_count;
+                       } else {
+                               $obj_idx .= $function[0]->wp_filter_id;
+                       }
+
+                       return $obj_idx;
+               }
+       } else if ( is_string($function[0]) ) {
+               // Static Calling
                return $function[0].$function[1];
+       }
 }
 
 ?>