Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pereirinha committed Nov 4, 2024
1 parent ad0b78c commit 228a306
Show file tree
Hide file tree
Showing 136 changed files with 931 additions and 1,850 deletions.
4 changes: 2 additions & 2 deletions docs/cloudinary_admin_image_settings.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_admin_pages.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/cloudinary_admin_video_settings.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_allowed_extensions.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_api_rest_endpoints.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_apply_breakpoints.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_apply_default_transformations.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/cloudinary_asset_payload.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_asset_state.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_autosync_threads.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_build_queue_query.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_bypass_cache.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_bypass_seo_url.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_can_sync_asset.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_connected.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_content_url.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/cloudinary_context_options.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_contextualized_post_id.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_convert_media_types.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_converted_url.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_cron_frequency.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_cron_start_offset.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_current_post_id.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_default_transformations.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_delete_asset.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_delivery_get_id.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_delivery_searchable_url.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_doing_upload.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/cloudinary_download_asset.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_edit_asset_permalink.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/cloudinary_enable_crop_and_gravity_control.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/cloudinary_filter_out_local.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_flush_cache.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_gallery_config.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_gallery_html_container.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_get_signature.html

Large diffs are not rendered by default.

52 changes: 49 additions & 3 deletions docs/cloudinary_home_url.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/cloudinary_id.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_ignored_class_keywords.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_ignored_data_keywords.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_init_delivery.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_init_settings.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_is_%7B$class_name%7D_active.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_is_content_dir.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_is_deliverable.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/cloudinary_is_folder_synced.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_is_media.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_is_uploadable_media.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_lazy_load_bypass.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_lazy_load_bypass_classes.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_lazy_load_bypass_formats.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/cloudinary_local_url.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/cloudinary_max_files_import.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_media_context.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_media_context_query.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_media_context_things.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_media_filters.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_media_status.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_media_types.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_meta_boxes.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/cloudinary_migrate_legacy_meta.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_on_demand_sync_limit.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_parse_element.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_plugin_asset_cache_filters.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_plugin_asset_cache_inline_types.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/cloudinary_prepare_size.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_preview_types.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_queue_action.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_queue_threads.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/cloudinary_raw_url.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_ready.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_register_extensions.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_register_sync_types.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_registered_sizes.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_resource_type.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cloudinary_responsive_images_bypass_formats.html

Large diffs are not rendered by default.

266 changes: 266 additions & 0 deletions docs/cloudinary_rest_url.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,266 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Filter: cloudinary_rest_url - Cloudinary Docs</title>

<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">

<link
href="https://fonts.googleapis.com/css?family=IBM+Plex+Mono|IBM+Plex+Sans:300,400|Playfair+Display:900&display=swap"
rel="stylesheet">
</head>

<body>

<div id="main">


<h1 class="page-title">Filter: cloudinary_rest_url</h1>







<section>

<header>
<h2></h2>

</header>

<article>
<div class="container-overview">





<h4 class="name" id="cloudinary_rest_url">apply_filters( 'cloudinary_rest_url', <span class="signature">$rest_url, $path, $scheme )</span><span class="type-signature"> &rarr; {string}</span></h4>





<div class="description">
Filter the rest url.
</div>







<h5>Parameters:</h5>


<table class="params">
<thead>
<tr>

<th>Name</th>


<th>Type</th>





<th class="last">Description</th>
</tr>
</thead>

<tbody>


<tr>

<td class="name"><code>$rest_url</code></td>


<td class="type">


<span class="param-type">string</span>



</td>





<td class="description last">The rest url.</td>
</tr>



<tr>

<td class="name"><code>$path</code></td>


<td class="type">


<span class="param-type">string</span>



</td>





<td class="description last">The path to be appended to the rest URL.</td>
</tr>



<tr>

<td class="name"><code>$scheme</code></td>


<td class="type">


<span class="param-type">string</span>



</td>





<td class="description last">The scheme to give the rest URL context. Accepts 'http', 'https', or 'relative'.</td>
</tr>


</tbody>
</table>






<dl class="details">




<dt class="tag-since">Since:</dt>
<dd class="tag-since"><ul class="dummy"><li>3.2.2</li></ul></dd>























<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#line1256">line 1256</a>
</li></ul></dd>







</dl>













<h5>Returns:</h5>




<dl>
<dt>
Type
</dt>
<dd>

<span class="param-type">string</span>


</dd>
</dl>






</div>


</article>

</section>




</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Actions</h3><ul><li><a href="cloudinary_connected.html">cloudinary_connected</a></li><li><a href="cloudinary_delete_asset.html">cloudinary_delete_asset</a></li><li><a href="cloudinary_download_asset.html">cloudinary_download_asset</a></li><li><a href="cloudinary_enable_crop_and_gravity_control.html">cloudinary_enable_crop_and_gravity_control</a></li><li><a href="cloudinary_flush_cache.html">cloudinary_flush_cache</a></li><li><a href="cloudinary_id.html">cloudinary_id</a></li><li><a href="cloudinary_init_delivery.html">cloudinary_init_delivery</a></li><li><a href="cloudinary_init_settings.html">cloudinary_init_settings</a></li><li><a href="cloudinary_is_%257B$class_name%257D_active.html">cloudinary_is_{$class_name}_active</a></li><li><a href="cloudinary_lazy_load_bypass.html">cloudinary_lazy_load_bypass</a></li><li><a href="cloudinary_queue_action.html">cloudinary_queue_action</a></li><li><a href="cloudinary_ready.html">cloudinary_ready</a></li><li><a href="cloudinary_register_sync_types.html">cloudinary_register_sync_types</a></li><li><a href="cloudinary_registered_sizes.html">cloudinary_registered_sizes</a></li><li><a href="cloudinary_responsive_images_bypass_formats.html">cloudinary_responsive_images_bypass_formats</a></li><li><a href="cloudinary_string_replace.html">cloudinary_string_replace</a></li><li><a href="cloudinary_unsync_asset.html">cloudinary_unsync_asset</a></li><li><a href="cloudinary_upgrade_asset.html">cloudinary_upgrade_asset</a></li><li><a href="cloudinary_upload_args.html">cloudinary_upload_args</a></li><li><a href="cloudinary_uploaded_asset.html">cloudinary_uploaded_asset</a></li><li><a href="cloudinary_version_upgrade.html">cloudinary_version_upgrade</a></li></ul><h3>Filters</h3><ul><li><a href="cloudinary_admin_image_settings.html">cloudinary_admin_image_settings</a></li><li><a href="cloudinary_admin_pages.html">cloudinary_admin_pages</a></li><li><a href="cloudinary_admin_video_settings.html">cloudinary_admin_video_settings</a></li><li><a href="cloudinary_allowed_extensions.html">cloudinary_allowed_extensions</a></li><li><a href="cloudinary_api_rest_endpoints.html">cloudinary_api_rest_endpoints</a></li><li><a href="cloudinary_apply_breakpoints.html">cloudinary_apply_breakpoints</a></li><li><a href="cloudinary_apply_default_transformations.html">cloudinary_apply_default_transformations</a></li><li><a href="cloudinary_asset_payload.html">cloudinary_asset_payload</a></li><li><a href="cloudinary_asset_state.html">cloudinary_asset_state</a></li><li><a href="cloudinary_autosync_threads.html">cloudinary_autosync_threads</a></li><li><a href="cloudinary_build_queue_query.html">cloudinary_build_queue_query</a></li><li><a href="cloudinary_bypass_cache.html">cloudinary_bypass_cache</a></li><li><a href="cloudinary_bypass_seo_url.html">cloudinary_bypass_seo_url</a></li><li><a href="cloudinary_can_sync_asset.html">cloudinary_can_sync_asset</a></li><li><a href="cloudinary_content_url.html">cloudinary_content_url</a></li><li><a href="cloudinary_context_options.html">cloudinary_context_options</a></li><li><a href="cloudinary_contextualized_post_id.html">cloudinary_contextualized_post_id</a></li><li><a href="cloudinary_convert_media_types.html">cloudinary_convert_media_types</a></li><li><a href="cloudinary_converted_url.html">cloudinary_converted_url</a></li><li><a href="cloudinary_cron_frequency.html">cloudinary_cron_frequency</a></li><li><a href="cloudinary_cron_start_offset.html">cloudinary_cron_start_offset</a></li><li><a href="cloudinary_current_post_id.html">cloudinary_current_post_id</a></li><li><a href="cloudinary_default_freeform_transformations_%257B$type%257D.html">cloudinary_default_freeform_transformations_{$type}</a></li><li><a href="cloudinary_default_qf_transformations_%257B$type%257D.html">cloudinary_default_qf_transformations_{$type}</a></li><li><a href="cloudinary_default_transformations.html">cloudinary_default_transformations</a></li><li><a href="cloudinary_delivery_get_id.html">cloudinary_delivery_get_id</a></li><li><a href="cloudinary_delivery_searchable_url.html">cloudinary_delivery_searchable_url</a></li><li><a href="cloudinary_doing_upload.html">cloudinary_doing_upload</a></li><li><a href="cloudinary_edit_asset_permalink.html">cloudinary_edit_asset_permalink</a></li><li><a href="cloudinary_filter_out_local.html">cloudinary_filter_out_local</a></li><li><a href="cloudinary_gallery_config.html">cloudinary_gallery_config</a></li><li><a href="cloudinary_gallery_html_container.html">cloudinary_gallery_html_container</a></li><li><a href="cloudinary_get_signature.html">cloudinary_get_signature</a></li><li><a href="cloudinary_home_url.html">cloudinary_home_url</a></li><li><a href="cloudinary_ignored_class_keywords.html">cloudinary_ignored_class_keywords</a></li><li><a href="cloudinary_ignored_data_keywords.html">cloudinary_ignored_data_keywords</a></li><li><a href="cloudinary_is_content_dir.html">cloudinary_is_content_dir</a></li><li><a href="cloudinary_is_deliverable.html">cloudinary_is_deliverable</a></li><li><a href="cloudinary_is_folder_synced.html">cloudinary_is_folder_synced</a></li><li><a href="cloudinary_is_media.html">cloudinary_is_media</a></li><li><a href="cloudinary_is_uploadable_media.html">cloudinary_is_uploadable_media</a></li><li><a href="cloudinary_lazy_load_bypass_classes.html">cloudinary_lazy_load_bypass_classes</a></li><li><a href="cloudinary_lazy_load_bypass_formats.html">cloudinary_lazy_load_bypass_formats</a></li><li><a href="cloudinary_local_url.html">cloudinary_local_url</a></li><li><a href="cloudinary_max_files_import.html">cloudinary_max_files_import</a></li><li><a href="cloudinary_media_context.html">cloudinary_media_context</a></li><li><a href="cloudinary_media_context_query.html">cloudinary_media_context_query</a></li><li><a href="cloudinary_media_context_things.html">cloudinary_media_context_things</a></li><li><a href="cloudinary_media_filters.html">cloudinary_media_filters</a></li><li><a href="cloudinary_media_status.html">cloudinary_media_status</a></li><li><a href="cloudinary_media_types.html">cloudinary_media_types</a></li><li><a href="cloudinary_meta_boxes.html">cloudinary_meta_boxes</a></li><li><a href="cloudinary_migrate_legacy_meta.html">cloudinary_migrate_legacy_meta</a></li><li><a href="cloudinary_on_demand_sync_limit.html">cloudinary_on_demand_sync_limit</a></li><li><a href="cloudinary_parse_element.html">cloudinary_parse_element</a></li><li><a href="cloudinary_plugin_asset_cache_filters.html">cloudinary_plugin_asset_cache_filters</a></li><li><a href="cloudinary_plugin_asset_cache_inline_types.html">cloudinary_plugin_asset_cache_inline_types</a></li><li><a href="cloudinary_prepare_size.html">cloudinary_prepare_size</a></li><li><a href="cloudinary_preview_types.html">cloudinary_preview_types</a></li><li><a href="cloudinary_queue_threads.html">cloudinary_queue_threads</a></li><li><a href="cloudinary_raw_url.html">cloudinary_raw_url</a></li><li><a href="cloudinary_register_extensions.html">cloudinary_register_extensions</a></li><li><a href="cloudinary_resource_type.html">cloudinary_resource_type</a></li><li><a href="cloudinary_rest_url.html">cloudinary_rest_url</a></li><li><a href="cloudinary_seo_public_id.html">cloudinary_seo_public_id</a></li><li><a href="cloudinary_set_usable_asset.html">cloudinary_set_usable_asset</a></li><li><a href="cloudinary_setting_get_value.html">cloudinary_setting_get_value</a></li><li><a href="cloudinary_settings_save_setting.html">cloudinary_settings_save_setting</a></li><li><a href="cloudinary_setup_component_parts.html">cloudinary_setup_component_parts</a></li><li><a href="cloudinary_site_url.html">cloudinary_site_url</a></li><li><a href="cloudinary_sync_base.html">cloudinary_sync_base</a></li><li><a href="cloudinary_sync_base_struct.html">cloudinary_sync_base_struct</a></li><li><a href="cloudinary_syncable_delivery_types.html">cloudinary_syncable_delivery_types</a></li><li><a href="cloudinary_task_capability.html">cloudinary_task_capability</a></li><li><a href="cloudinary_task_capability_%257Btask%257D.html">cloudinary_task_capability_{task}</a></li><li><a href="cloudinary_thread_queue_details_query.html">cloudinary_thread_queue_details_query</a></li><li><a href="cloudinary_transformations.html">cloudinary_transformations</a></li><li><a href="cloudinary_upgrade_sequence.html">cloudinary_upgrade_sequence</a></li><li><a href="cloudinary_upload_eager_formats.html">cloudinary_upload_eager_formats</a></li><li><a href="cloudinary_upload_options.html">cloudinary_upload_options</a></li><li><a href="cloudinary_use_original_image.html">cloudinary_use_original_image</a></li><li><a href="cloudinary_validate_cloudinary_id.html">cloudinary_validate_cloudinary_id</a></li></ul>
</nav>

<br class="clear">

<footer>
<a href="https://cloudinary.com/" target="_blank" rel="noopener noreferrer">Cloudinary</a> |
<a href="https://github.com/cloudinary/cloudinary_wordpress/" target="_blank" rel="noopener noreferrer">Cloudinary
on GitHub</a>
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"></script>
</body>
</html>
Loading

0 comments on commit 228a306

Please sign in to comment.