plugin development - Where to write custom logs in WordPress

admin管理员组

文章数量:1130349

I am creating a plugin in WordPress, the plugin creates logs for some events, my question is where should I write custom logs, so that no explicit file read/write permission required. I am looking to put logs at one of below two locations-
1. wp-content/plugins/pluginName/logs
2. wp-content/logs

I am creating a plugin in WordPress, the plugin creates logs for some events, my question is where should I write custom logs, so that no explicit file read/write permission required. I am looking to put logs at one of below two locations-
1. wp-content/plugins/pluginName/logs
2. wp-content/logs

• plugin-development
• wp-filesystem

Share Improve this question edited Dec 6, 2018 at 15:33 Nathan Johnson 6,53866 gold badges3030 silver badges4949 bronze badges asked Dec 6, 2018 at 15:13 Surjan RaghuwanshiSurjan Raghuwanshi 16311 silver badge66 bronze badges

Add a comment  | 

1 Answer 1

Sorted by: Reset to default 0

Any files you want to create, such as logs, should be created in the wp-content/uploads/ directory. Probably in your own subdirectory. This is because this is directory will be the most reliably writable, since it needs to be writable for everyday usage (for uploading media).

You can use wp_upload_dir() to get the path to the uploads directory, and mkdir() to create a directory there:

$uploads  = wp_upload_dir( null, false );
$logs_dir = $uploads['basedir'] . '/pluginName-logs';

if ( ! is_dir( $logs_dir ) ) {
    mkdir( $logs_dir, 0755, true );
}

$file = fopen( $logs_dir . '/' . 'log.log', 'w' );

wp-content would be the next option, but I don't see any reason to prefer it over the uploads directory. Definitely don't put it inside your plugin directory. If you did you would lose any logs whenever the plugin is updated.

I am creating a plugin in WordPress, the plugin creates logs for some events, my question is where should I write custom logs, so that no explicit file read/write permission required. I am looking to put logs at one of below two locations-
1. wp-content/plugins/pluginName/logs
2. wp-content/logs

I am creating a plugin in WordPress, the plugin creates logs for some events, my question is where should I write custom logs, so that no explicit file read/write permission required. I am looking to put logs at one of below two locations-
1. wp-content/plugins/pluginName/logs
2. wp-content/logs

• plugin-development
• wp-filesystem

Share Improve this question edited Dec 6, 2018 at 15:33 Nathan Johnson 6,53866 gold badges3030 silver badges4949 bronze badges asked Dec 6, 2018 at 15:13 Surjan RaghuwanshiSurjan Raghuwanshi 16311 silver badge66 bronze badges

Add a comment  | 

1 Answer 1

Sorted by: Reset to default 0

Any files you want to create, such as logs, should be created in the wp-content/uploads/ directory. Probably in your own subdirectory. This is because this is directory will be the most reliably writable, since it needs to be writable for everyday usage (for uploading media).

You can use wp_upload_dir() to get the path to the uploads directory, and mkdir() to create a directory there:

$uploads  = wp_upload_dir( null, false );
$logs_dir = $uploads['basedir'] . '/pluginName-logs';

if ( ! is_dir( $logs_dir ) ) {
    mkdir( $logs_dir, 0755, true );
}

$file = fopen( $logs_dir . '/' . 'log.log', 'w' );

wp-content would be the next option, but I don't see any reason to prefer it over the uploads directory. Definitely don't put it inside your plugin directory. If you did you would lose any logs whenever the plugin is updated.

本文标签： plugin developmentWhere to write custom logs in WordPress