In: , , ,
On: 2008 / 07 / 02 Viewed: 90456 times
Shorter URL for this post: http://ozh.in/ip

A WordPress install is a bunch of directories and files, but two of them are particular: the file wp-config.php and the directory wp-content/ are personal and don't get overwritten when you upgrade your blog. In WordPress 2.6, they get so personal that you can even move them out of the WordPress root. This must bring a major change to your coding habits.

Plugin coders sometimes need their script to guess the location of their own directory (for example to require() files), or to include wp-config.php to make a file live alone in a WordPressized environment.

Guessing the path of wp-content

WordPress 2.6 allows advanced users to specify the location (physical and URL) of this directory with a constant define, so the directory might not be where it used to be.

What you used to do:

  1. $plugin_path = ABSPATH . '/wp-content/plugins/' . plugin_basename(dirname(__FILE__));
  2. $plugin_url = get_option('siteurl') . '/wp-content/plugins/' . plugin_basename(dirname(__FILE__));

What you will have to do, now that this directory can hide anywhere:

  1. // Pre-2.6 compatibility
  2. if ( !defined('WP_CONTENT_URL') )
  3.     define( 'WP_CONTENT_URL', get_option('siteurl') . '/wp-content');
  4. if ( !defined('WP_CONTENT_DIR') )
  5.     define( 'WP_CONTENT_DIR', ABSPATH . 'wp-content' );
  6.  
  7. // Guess the location
  8. $plugin_path = WP_CONTENT_DIR.'/plugins/'.plugin_basename(dirname(__FILE__));
  9. $plugin_url = WP_CONTENT_URL.'/plugins/'.plugin_basename(dirname(__FILE__));

In WordPress 2.6, constants WP_CONTENT_DIR and WP_CONTENT_URL are either user defined or set in wp-settings.php

Including wp-config.php

In WordPress 2.6 you can either leave wp-config.php in the blog root directory, or move it to the parent folder (which makes sense if this takes this critical file off of the webserver's document root)

What you used to do:

  1. require_once('../../../wp-config.php');

What you must do now:

  1. $root = dirname(dirname(dirname(dirname(__FILE__))));
  2. if (file_exists($root.'/wp-load.php')) {
  3.     // WP 2.6
  4.     require_once($root.'/wp-load.php');
  5. } else {
  6.     // Before 2.6
  7.     require_once($root.'/wp-config.php');
  8. }

Basically in WordPress 2.6 the file responsible for loading the environment is, in first instance, wp-load.php in place of the good old wp-config.php.

However, as pointed out by GamerZ in the comments, this still may not work. Why? Because not only the config file may not be there anymore, but the relative path to it may have changed since wp-content might have been moved too.

At this point though, there is no way I can think of to guess the locations of both wp-config and wp-content. To be 100% foolproof, such a "standalone" file needing to include wp-config should be editable so that advanced users moving their wp-content directory could manually edit a location path (the $root variable in the previous example)

Summary

Coders, revisit your old plugins to make sure they won't eventually break on WordPress 2.6 :)

Shorter URL

Want to share or tweet this post? Please use this short URL: http://ozh.in/ip

Metastuff

This entry "What Plugin Coders Must Know About WordPress 2.6" was posted on 02/07/2008 at 12:10 am and is tagged with , , ,
Watch this discussion : Comments RSS 2.0.

106 Blablas

    Pages: « 1 2 [3] Show All

  1. 101
    Marco Cimmino Italy »
    replied, on 16/Dec/08 at 9:32 pm # :

    Unluckily for people that changed wp-content location all code mentioned (both site and comments) doesn't work to find wp-config.php

  2. 102
    Organize Series 2.0.8 released United States »
    pingback on 24/Dec/08 at 8:22 am # :

    [...] wp-config.php to allow for users customizing the location of their wp-config.php file (see http://planetozh.com/blog/2008/07/what-plugin-coders-must-know-about-wordpress-26/ for reference [...]

  3. 103
    Scott Allen United States »
    commented, on 12/Feb/09 at 12:41 pm # :

    Ozh,

    This is a great post. All WP plugin developers really do need to read this. Thanks for sharing.

  4. 104
    primer dí­a con wordpress 2.6 : apirro... United States »
    pingback on 24/Apr/09 at 5:23 pm # :

    [...] tengo que acomodar varias cosas. algunos plugin dejaron de funcionar, habrá que esperar a que los desarrolladores de plugin los [...]

  5. 105
    An email from wordpress! | PROSS.ORG.UK United Kingdom »
    pingback on 26/May/09 at 10:31 pm # :

    [...] The code itself works with a default install of wordpress, but a few people out there might define a different folder for wp-content/themes.. so after som hefty google-fu I found this http://planetozh.com/blog/2008/07/what-plugin-coders-must-know-about-wordpress-26/ [...]

  6. 106
    DLE United States »
    thought, on 18/Oct/09 at 5:47 am # :

    Thank you! By adding the code you posted, I was able to fix a much needed older plugin that failed after I moved my config file.

Pages: « 1 2 [3] Show All

Leave a Reply

Comment Guidelines or Die

  • HTML: You can use these tags: <a href=""> <em> <i> <b> <strong> <blockquote>
  • Posting code: Post raw code (no <> &lt; etc) within appropriate tags : [php][/php], [css][/css], [html][/html], [js][/js], [sql][/sql], [xml][/xml], or generic [code][code]
  • Gravatars: Curious about the little images next to each commenter's name ? Go to Gravatar.
  • Spam: Various spam plugins on patrol. I'll put pins in a Voodoo doll if you spam me.
  • I will mark as Spam test comments, all comments with SEO names (ie "My Cool Online Shop" instead of "Joe") or containing forum-like signatures.

Read more ?