You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* For bug reports, please [open an issue on GitHub](https://github.com/rollbar/rollbar-php-wordpress/issues/new).
36
33
37
34
= You like it? =
@@ -46,62 +43,110 @@ This plugin is a community-driven contribution. All rights reserved to [Rollbar]
46
43
47
44
The installation and configuration of the plugin are as simple as it can be.
48
45
49
-
= Through [WordPress Plugin directory](https://wordpress.org/plugins/rollbar/) =
46
+
= Through WordPress Plugin directory =
50
47
51
-
The easiest way to install the plugin is from the WordPress Plugin directory. If you have an existing WordPress installation and you want to add Rollbar:
48
+
The easiest way to install the plugin is from the WordPress Plugin directory. If you have an existing WordPress
49
+
installation, and you want to add Rollbar:
52
50
53
51
1. In your WordPress administration panel go to `Plugins` → `Add New`.
54
52
2. Search for "Rollbar" and find `Rollbar` by Rollbar in the search results.
55
53
3. Click `Install Now` next to the `Rollbar` plugin.
56
-
4. In `Plugins` → `Installed plugins` find `Rollbar` and click `activate` underneath.
57
-
5. Log into your [Rollbar account dashboard](https://rollbar.com/login/).
58
-
6. Go to `Settings` → `Project Access Tokens`.
59
-
7. Copy the token value under `post_client_item` and `post_server_item`.
60
-
8. Navigate to `Tools` → `Rollbar`.
61
-
9. Enable `PHP error logging` and/or `Javascript error logging` depending on your needs.
62
-
10. Paste the tokens you copied in step 7 in `Access Token` section.
63
-
11. Provide the name of your environment in `Environment`. By default, the environment will be taken from `WP_ENV` environment variable if it's set otherwise it's blank. We recommend to fill this out either with `development` or `production`.
64
-
12. Pick a minimum logging level. Only errors at that or higher level will be reported. For reference: [PHP Manual: Predefined Error Constants](http://php.net/manual/en/errorfunc.constants.php).
65
-
13. Click `Save Changes`.
54
+
4. In `Plugins` → `Installed plugins` find `Rollbar` and click `Activate` underneath.
55
+
56
+
**Warning**: This installation method might not be suitable for complex WordPress projects. The plugin installed this
57
+
way will be self-contained and include all of the required dependencies for itself and the `rollbar/rollbar-php`
58
+
library. In complex projects, this might lead to version conflicts between dependencies and other plugins/packages. If
59
+
this is an issue in your project, we recommend the "Packagist" installation method.
66
60
67
-
**Warning**: This installation method might not be suitable for complex WordPress projects. The plugin installed this way will be self-contained and include all of the required dependencies for itself and `rollbar/rollbar-php` library. In complex projects, this might lead to version conflicts between dependencies and other plugins/packages. If this is an issue in your project, we recommend the "Advanced" installation method. For more information why this might be important for you, read [Using Composer with WordPress]().
61
+
= Through Packagist =
68
62
69
-
= Through [wpackagist](https://wpackagist.org/) (if you manage your project with Composer) *recommended* =
63
+
*Note: this only works if your WordPress project is managed with Composer.
64
+
Read [Using Composer with WordPress](https://roots.io/using-composer-with-wordpress/) for more details.*
70
65
71
-
This is a recommended way to install Rollbar plugin for advanced projects. This way ensures the plugin and all of its' dependencies are managed by Composer.
66
+
This is a recommended way to install the Rollbar plugin for advanced projects. This way ensures the plugin and all of
67
+
its dependencies are managed by Composer.
72
68
73
-
1. If your WordPress project is not managed with Composer yet, we suggest looking into upgrading your WordPress: [Using Composer with WordPress]().
74
-
2. In your `composer.json` add `wpackagist-plugin/rollbar` to your `require` section, i.e.:
69
+
You can install the plugin by running the following command in the root directory of your WordPress project:
// Optional: disable the admin settings page so the plugin is configured only programmatically.
135
+
define( 'ROLLBAR_DISABLE_ADMIN', true );
81
136
```
82
-
3. Issue command `composer install` in the root directory of your WordPress project.
83
-
4. In `Plugins` → `Installed plugins` find `Rollbar` and click `Activate` underneath.
84
-
5. Log into your [Rollbar account dashboard](https://rollbar.com/login/).
85
-
6. Go to `Settings` → `Project Access Tokens`.
86
-
7. Copy the token value under `post_client_item` and `post_server_item`.
87
-
8. Navigate to `Tools` → `Rollbar`.
88
-
9. Enable `PHP error logging` and/or `Javascript error logging` depending on your needs.
89
-
10. Paste the tokens you copied in step 7 in `Access Token` section.
90
-
11. Provide the name of your environment in `Environment`. By default, the environment will be taken from `WP_ENV` environment variable if it's set otherwise it's blank.
91
-
12. Pick a minimum logging level. Only errors at that or higher level will be reported. For reference: [PHP Manual: Predefined Error Constants](http://php.net/manual/en/errorfunc.constants.php).
92
-
13. Click `Save Changes`.
93
137
94
138
== Frequently Asked Questions ==
95
139
96
140
= Multisite supported? =
97
-
Yes of course. Additionally, you can assign different environments to each of your blogs.
141
+
Yes, of course. Additionally, you can assign different environments to each of your blogs.
98
142
99
143
= I have a complex WordPress project and use composer for managing dependencies. Is your plugin composer friendly? =
100
-
Yes. It's actually the recommended method of installation.
144
+
Yes. It's actually the recommended method of installation. You can install the `rollbar/rollbar-php-wordpress` package
145
+
using composer.
101
146
102
147
== Screenshots ==
103
148
104
-
1. Settings page
149
+
1. Settings page.
105
150
106
151
== Changelog ==
107
152
@@ -110,6 +155,7 @@ Yes. It's actually the recommended method of installation.
110
155
* Removed support for PHP 8.0 and below.
111
156
* Updated and improved the settings page.
112
157
* Updated the Rollbar core PHP SDK to v4.1.
158
+
* Updated the Rollbar core JavaScript SDK to v2.26.
113
159
* Added support for telemetry and added auto-instrumentation.
114
160
* Added support for `ROLLBAR_DISABLE_ADMIN` to remove the plugin settings page from the admin.
115
161
* Added support for `ROLLBAR_SETTINGS` to configure the plugin without the admin page.
@@ -188,7 +234,7 @@ Yes. It's actually the recommended method of installation.
188
234
* Updated rollbar-php dependency to v1.5.1
189
235
190
236
= Version 2.4.0 (17th May 2018) =
191
-
* Added capture_ip, capture_email and capture_username to the config options.
237
+
* Added capture_ip, capture_email, and capture_username to the config options.
192
238
* Fixed populating config options from the database to the plugin for boolean values.
193
239
* Updated rollbar-php dependency to v1.5.0
194
240
@@ -307,7 +353,7 @@ Updated admin test results to show a skipped test as a success. Fixed new sessio
307
353
* Updated rollbar-php dependency to v1.5.1
308
354
309
355
= Version 2.4.0 (5th April 2018) =
310
-
* Added capture_ip, capture_email and capture_username to the config options.
356
+
* Added capture_ip, capture_email, and capture_username to the config options.
311
357
* Fixed populating config options from the database to the plugin for boolean values.
0 commit comments