Update docs

gabriel-detassigny · gabriel-detassigny · commit 91fcf19e714c · 2026-05-05T10:46:05.000+02:00
diff --git a/docs/cloudinary_allowed_extensions.html b/docs/cloudinary_allowed_extensions.html
@@ -145,7 +145,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1737">line 1737</a>
+        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1801">line 1801</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_allowed_svg_tags.html b/docs/cloudinary_allowed_svg_tags.html
@@ -145,7 +145,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-utils.php.html">php/class-utils.php</a>, <a href="php_class-utils.php.html#line1576">line 1576</a>
+        <a href="php_class-utils.php.html">php/class-utils.php</a>, <a href="php_class-utils.php.html#line1590">line 1590</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_apply_breakpoints.html b/docs/cloudinary_apply_breakpoints.html
@@ -150,7 +150,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1385">line 1385</a>
+        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1433">line 1433</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_bypass_seo_url.html b/docs/cloudinary_bypass_seo_url.html
@@ -145,7 +145,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1348">line 1348</a>
+        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1396">line 1396</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_content_url.html b/docs/cloudinary_content_url.html
@@ -145,7 +145,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1800">line 1800</a>
+        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1864">line 1864</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_delivery_get_id.html b/docs/cloudinary_delivery_get_id.html
@@ -168,7 +168,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1055">line 1055</a>
+        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1092">line 1092</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_delivery_searchable_url.html b/docs/cloudinary_delivery_searchable_url.html
@@ -191,7 +191,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1819">line 1819</a>
+        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1883">line 1883</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_edit_asset_permalink.html b/docs/cloudinary_edit_asset_permalink.html
@@ -145,7 +145,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1331">line 1331</a>
+        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1379">line 1379</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_enable_crop_and_gravity_control.html b/docs/cloudinary_enable_crop_and_gravity_control.html
@@ -150,7 +150,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1480">line 1480</a>
+        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1529">line 1529</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_filter_unknown_urls.html b/docs/cloudinary_filter_unknown_urls.html
@@ -176,7 +176,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line2033">line 2033</a>
+        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line2097">line 2097</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_home_url.html b/docs/cloudinary_home_url.html
@@ -191,7 +191,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-utils.php.html">php/class-utils.php</a>, <a href="php_class-utils.php.html#line1279">line 1279</a>
+        <a href="php_class-utils.php.html">php/class-utils.php</a>, <a href="php_class-utils.php.html#line1293">line 1293</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_is_content_dir.html b/docs/cloudinary_is_content_dir.html
@@ -168,7 +168,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1705">line 1705</a>
+        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1769">line 1769</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_media_context.html b/docs/cloudinary_media_context.html
@@ -179,7 +179,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-utils.php.html">php/class-utils.php</a>, <a href="php_class-utils.php.html#line1244">line 1244</a>
+        <a href="php_class-utils.php.html">php/class-utils.php</a>, <a href="php_class-utils.php.html#line1236">line 1236</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_media_context_things.html b/docs/cloudinary_media_context_things.html
@@ -145,7 +145,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-utils.php.html">php/class-utils.php</a>, <a href="php_class-utils.php.html#line1091">line 1091</a>
+        <a href="php_class-utils.php.html">php/class-utils.php</a>, <a href="php_class-utils.php.html#line1265">line 1265</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_parse_element.html b/docs/cloudinary_parse_element.html
@@ -145,7 +145,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1642">line 1642</a>
+        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1706">line 1706</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_rest_url.html b/docs/cloudinary_rest_url.html
@@ -191,7 +191,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-utils.php.html">php/class-utils.php</a>, <a href="php_class-utils.php.html#line1335">line 1335</a>
+        <a href="php_class-utils.php.html">php/class-utils.php</a>, <a href="php_class-utils.php.html#line1349">line 1349</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_set_usable_asset.html b/docs/cloudinary_set_usable_asset.html
@@ -145,7 +145,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1788">line 1788</a>
+        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1852">line 1852</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_site_url.html b/docs/cloudinary_site_url.html
@@ -191,7 +191,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-utils.php.html">php/class-utils.php</a>, <a href="php_class-utils.php.html#line1309">line 1309</a>
+        <a href="php_class-utils.php.html">php/class-utils.php</a>, <a href="php_class-utils.php.html#line1323">line 1323</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_skip_parse_element.html b/docs/cloudinary_skip_parse_element.html
@@ -173,7 +173,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1460">line 1460</a>
+        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1509">line 1509</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_tag_skip_classes.html b/docs/cloudinary_tag_skip_classes.html
@@ -173,7 +173,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1191">line 1191</a>
+        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1230">line 1230</a>
     </li></ul></dd>
     
 
diff --git a/docs/cloudinary_unset_attributes.html b/docs/cloudinary_unset_attributes.html
@@ -173,7 +173,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1280">line 1280</a>
+        <a href="php_class-delivery.php.html">php/class-delivery.php</a>, <a href="php_class-delivery.php.html#line1328">line 1328</a>
     </li></ul></dd>
     
 
diff --git a/docs/index.html b/docs/index.html
@@ -123,6 +123,118 @@ <h2>Support</h2>
 <p>Contact us <a href="https://cloudinary.com/contact">https://cloudinary.com/contact</a></p>
 <p>Stay tuned for updates, tips and tutorials: <a href="https://cloudinary.com/blog">Blog</a>, <a href="https://twitter.com/cloudinary">Twitter</a>, <a href="https://www.facebook.com/Cloudinary">Facebook</a>.</p>
 <h2>Development</h2>
+<h3>Prerequisites</h3>
+<ul>
+<li><a href="https://nodejs.org/">Node.js</a> v16+ (see <code>.nvmrc</code>)</li>
+<li><a href="https://www.npmjs.com/">npm</a> v6.9+</li>
+<li><a href="https://getcomposer.org/">Composer</a></li>
+<li><a href="https://www.docker.com/">Docker</a> (required for the WordPress local environment via <code>wp-env</code>)</li>
+</ul>
+<h3>Local Development Setup</h3>
+<ol>
+<li>
+<p><strong>Clone the repository:</strong></p>
+<pre class="prettyprint source lang-bash"><code>git clone https://github.com/cloudinary/cloudinary_wordpress.git
+cd cloudinary_wordpress
+</code></pre>
+</li>
+<li>
+<p><strong>Set the correct Node version</strong> (if using <a href="https://github.com/nvm-sh/nvm">nvm</a>):</p>
+<pre class="prettyprint source lang-bash"><code>nvm install
+nvm use
+</code></pre>
+</li>
+<li>
+<p><strong>Install dependencies:</strong></p>
+<pre class="prettyprint source lang-bash"><code>npm install
+</code></pre>
+<p>This will also run <code>composer install</code> automatically via the <code>postinstall</code> script, setting up PHP dependencies and linting tools.</p>
+</li>
+<li>
+<p><strong>Start the local WordPress environment:</strong></p>
+<p>Make sure Docker is running, then:</p>
+<pre class="prettyprint source lang-bash"><code>npm run env:start
+</code></pre>
+<p>This spins up a WordPress instance at <a href="http://localhost:8888">http://localhost:8888</a> with the plugin activated and <code>WP_DEBUG</code> enabled. A loopback fix is applied automatically so REST API self-requests work inside the container.</p>
+</li>
+<li>
+<p><strong>Build front-end assets:</strong></p>
+<pre class="prettyprint source lang-bash"><code>npm run build        # One-time production build
+npm run dev          # Watch mode for development
+</code></pre>
+</li>
+</ol>
+<h3>Useful Commands</h3>
+<table>
+<thead>
+<tr>
+<th>Command</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>npm run env:start</code></td>
+<td>Start the local WordPress environment</td>
+</tr>
+<tr>
+<td><code>npm run env:stop</code></td>
+<td>Stop the local WordPress environment</td>
+</tr>
+<tr>
+<td><code>npm run env:destroy</code></td>
+<td>Remove the local environment completely</td>
+</tr>
+<tr>
+<td><code>npm run env:logs</code></td>
+<td>View container logs</td>
+</tr>
+<tr>
+<td><code>npm run env:cli</code></td>
+<td>Run WP-CLI commands inside the container</td>
+</tr>
+<tr>
+<td><code>npm run env:clean</code></td>
+<td>Reset the environment (removes all data)</td>
+</tr>
+<tr>
+<td><code>npm run build</code></td>
+<td>Build front-end assets for production</td>
+</tr>
+<tr>
+<td><code>npm run dev</code></td>
+<td>Build front-end assets in watch mode</td>
+</tr>
+<tr>
+<td><code>npm run lint</code></td>
+<td>Run all linters (PHP, JS, CSS)</td>
+</tr>
+<tr>
+<td><code>npm run lint:php</code></td>
+<td>Run PHP CodeSniffer</td>
+</tr>
+<tr>
+<td><code>npm run lint:php:fix</code></td>
+<td>Auto-fix PHP linting issues</td>
+</tr>
+<tr>
+<td><code>npm run lint:js</code></td>
+<td>Run ESLint on JavaScript files</td>
+</tr>
+<tr>
+<td><code>npm run lint:js:fix</code></td>
+<td>Auto-fix JS linting issues</td>
+</tr>
+<tr>
+<td><code>npm run lint:style</code></td>
+<td>Run stylelint on SCSS files</td>
+</tr>
+<tr>
+<td><code>npm run i18n</code></td>
+<td>Generate translation files</td>
+</tr>
+</tbody>
+</table>
 <h3>Create a Plugin Release Package</h3>
 <p>Run <code>npm run package</code> to create the plugin release in the <code>/build</code> directory and package it as <code>cloudinary-image-management-and-manipulation-in-the-cloud-cdn.zip</code> in the root directory.</p>
 <p>Files included in the release package are defined in the <code>gruntfile.js</code> under the <code>copy</code> task. Be sure to update this list of files and directories when you add new files to the project.</p>
diff --git a/docs/php_class-delivery.php.html b/docs/php_class-delivery.php.html
diff --git a/docs/php_class-media.php.html b/docs/php_class-media.php.html
diff --git a/docs/php_class-utils.php.html b/docs/php_class-utils.php.html
diff --git a/docs/php_ui_component_class-crops.php.html b/docs/php_ui_component_class-crops.php.html
