How can I fix [civicrm.root] variable on an addon domain?

Question

I believe [civicrm.root] is being computed incorrectly. Entering the absolute URLs in Settings > Resource URLs has been sufficient to fix most problems, but some problems persist.

For example, when i encounter an error like crm.ckeditor.js getting an error, the console tells me it can't find it at https://mysite.org/mysite.org/wp-content/plugins/civicrm/civicrm/js/wysiwyg/crm.ckeditor.js.

You'll notice that mysite.org is repeated.

I'm running (CiviCRM 4.7.22) on an "Addon Domain" on my host. When you manage files for your addon domains, they show up as a folder on in your file manager. So my Civi files are installed at:

• /home/username/public_html/mysite.org/wp-content/plugins/civicrm/civicrm/

I assume that when Civi is computing the [civicrm.root] variable, it just assumes it can replace /home/username/public_html with the base url defined by CIVICRM_UF_BASEURL, which would explain why I'm getting this https://mysite.org/mysite.org/wp-content....

So how do I fix this permanently? Clearly using absolute URLs in Settings > Resource URLs isn't sufficient for every case. To clarify the values frrom settings.civicrm.php:

• define( 'CIVICRM_UF_BASEURL' , 'https://mysite.org/');
• $civicrm_root = '/home/user/public_html/mysite.org/wp-content/plugins/civicrm/civicrm/';

Answer 1

tl;dr: Uncomment and fill in the define('CIVICRM_CMSDIR', '/path/to/install/root/'); in civicrm.settings.php.

I traced through the functions that go toward building the URL for loadins crm.ckeditor.js. It seems there's a problem with the logic of the WordPress cmsRootPath function.

I can't tell you what the specific issue you're having that's causing that function to fail; I know it struggles with symlinks, and I'd guess there's other edge cases as well.

If I understand this line of code correctly, in addition to $civicrm_root, there's also a lesser-known cousin CIVICRM_CMSDIR, which is actually the relevant data here. In my 4.7.22 WordPress instance's civicrm.settings.php, that constant is present but commented out.

See also: CRM-18221 for what appears to be a similar issue on earlier versions of Civi 4.7.