Changeset 12976

Timestamp:

02/05/2010 09:33:53 PM (15 years ago)

Author:

ryan

Message:

Use get_plugin_data() to fetch Network header for is_network_only_plugin(). Props nacin. fixes #12139

Location:

trunk/wp-admin

Files:

• includes/plugin.php (modified) (5 diffs)
• plugins.php (modified) (1 diff)

trunk/wp-admin/includes/plugin.php

@@ -30 +30 @@
  *      must have the first slash. Defaults to the base folder the plugin is
  *      located in.
+ * Network: Optional. Specify "Network: true" to require that a plugin is activated
+ *      across all sites in an installation. This will prevent a plugin from being
+ *      activated on a single site when Multisite is enabled.
  *  * / # Remove the space to close comment
  * </code>
@@ -44 +47 @@
  *      'TextDomain' - Plugin's text domain for localization.
  *      'DomainPath' - Plugin's relative directory path to .mo files.
+ *      'Network' - Boolean. Whether the plugin can only be activated network wide.
  *
  * Some users have issues with opening large files and manipulating the contents
@@ -76 +80 @@
         'AuthorURI' => 'Author URI',
         'TextDomain' => 'Text Domain',
-        'DomainPath' => 'Domain Path'
-        );
+        'DomainPath' => 'Domain Path',
+        'Network' => 'Network',
+        // Site Wide Only is deprecated in favor of Network.
+        '_sitewide' => 'Site Wide Only',
+    );
 
     $plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' );
+
+    // Site Wide Only is the old header for Network
+    if ( empty( $plugin_data['Network'] ) && ! empty( $plugin_data['_sitewide'] ) ) {
+        _deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The <code>%1$s</code> plugin header is deprecated. Use <code>%2$s</code> instead.' ), 'Site Wide Only: true', 'Network: true' ) );
+        $plugin_data['Network'] = $plugin_data['_sitewide'];
+    }
+    $plugin_data['Network'] = ( 'true' == strtolower( $plugin_data['Network'] ) ) ? true : false;
+    unset( $plugin_data['_sitewide'] );
 
     //For backward compatibility by default Title is the same as Name.
@@ -92 +107 @@
 function _get_plugin_data_markup_translate($plugin_file, $plugin_data, $markup = true, $translate = true) {
 
-    //Translate fields
+    //Translate fields30
     if ( $translate && ! empty($plugin_data['TextDomain']) ) {
         if ( ! empty( $plugin_data['DomainPath'] ) )
@@ -283 +298 @@
 
 /**
- * Checks for "Site Wide Only: true" in the plugin header to see if this should
- * be activated as a network wide MU plugin.
+ * Checks for "Network: true" in the plugin header to see if this should
+ * be activated only as a network wide plugin. The plugin would also work
+ * when Multisite is not enabled.
+ *
+ * Checks for "Site Wide Only: true" for backwards compatibility.
  *
  * @since 3.0.0
- *
- * @todo Use API for getting arbitrary plugin headers.
  *
  * @param $file Plugin to check
  * $return bool True if plugin is network only, false otherwise.
  */
-function is_network_only_plugin( $file ) {
-    /* Open the plugin file for reading to check if this is a ms-plugin. */
-    $fp = @fopen( WP_PLUGIN_DIR . '/' . $file, 'r' );
-
-    /* Pull only the first 8kiB of the file in. */
-    $plugin_data = @fread( $fp, 8192 );
-
-    /* PHP will close file handle, but we are good citizens. */
-    @fclose($fp);
-
-    if ( preg_match( '/(Network|Site Wide Only):(.*)true$/mi', $plugin_data ) )
-        return true;
-
+function is_network_only_plugin( $plugin ) {
+    $plugin_data = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin );
+    if ( $plugin_data )
+        return $plugin_data['Network'];
     return false;
 }

trunk/wp-admin/plugins.php

@@ -492 +492 @@
             }
         } else {
-            $actions[] = '<a href="' . wp_nonce_url('plugins.php?action=activate&amp;plugin=' . $plugin_file . '&amp;plugin_status=' . $context . '&amp;paged=' . $page, 'activate-plugin_' . $plugin_file) . '" title="' . __('Activate this plugin') . '" class="edit">' . __('Activate') . '</a>';
+            if ( is_network_only_plugin( $plugin_file ) )
+                $actions[] = '<span title="' . __('This plugin can only be activated for all sites in a network') . '">' . __('Network Only') . '</span>';
+            else
+                $actions[] = '<a href="' . wp_nonce_url('plugins.php?action=activate&amp;plugin=' . $plugin_file . '&amp;plugin_status=' . $context . '&amp;paged=' . $page, 'activate-plugin_' . $plugin_file) . '" title="' . __('Activate this plugin') . '" class="edit">' . __('Activate') . '</a>';
             if ( is_multisite() && is_super_admin() )
                 $actions[] = '<a href="' . wp_nonce_url('plugins.php?action=activate&amp;networkwide=1&amp;plugin=' . $plugin_file . '&amp;plugin_status=' . $context . '&amp;paged=' . $page, 'activate-plugin_' . $plugin_file) . '" title="' . __('Activate this plugin for all sites in this network') . '" class="edit">' . __('Network Activate') . '</a>';