Getting Started
Getting Started
Introduction
Installing W3Speedster
Create a Directory for the Package
Navigate to the Project Root: Open your terminal and go to your Laravel project directory.
cd /path/to/your/project
Create a
packages
Directory: This directory will hold your custom packages.mkdir packages
Add the Package Code: Inside the
packages
directory, create the necessary folder structure for the w3speedster
package:mkdir -p packages/w3speedster/w3speedster
Configure the Package in Composer
Open the
composer.json
File: This file is located in the root directory of your Laravel project. You can open it in any code editor (e.g., VS Code, Sublime Text).Add the Repository Configuration: Add the following snippet to the
repositories
section of your composer.json
file. If the repositories
section does not exist, create it at the root level of the JSON structure:
"repositories":[
{
"type":"path",
"url":"packages/w3speedster/w3speedster"
}
]
- type: Indicates that this is a package located in your local filesystem.
- url: Specifies the path to the package directory.
Save the Changes: Once you've added the configuration, save the file.
Install the Package
Now, run the following commands in your terminal to install and set up the package:Require the Package:
composer require w3speedster/w3speedster:1.0.0
This command tells Composer to install the package from the specified path. It will handle dependencies and autoload the package into your project.
Run the Package Installer:
php artisan w3speedster:install
This Artisan command will set up the package within your Laravel application, performing tasks such as:
- Publishing configuration files.
- Running migrations (if applicable).
- Any other setup tasks defined by the package.
Verification and Final Steps
Confirm Installation:
- Check the composer.json file under the require section to ensure w3speedster/w3speedster is listed.
- Verify that the package files have been autoloaded by Composer (you may find them under vendor/composer/autoload_*).
- Ensure that the package's functionality is accessible.
- Refer to the package's documentation or run php artisan to see if the package's commands are registered.
- Clear the application cache to avoid conflicts:
php artisan cache:clear
- Refresh the Composer autoload files:
composer dump-autoload
Uninstalling W3Speedster
Remove the Package Reference
Open the composer.json File:
- Locate the require section in the composer.json file and remove the entry for the w3speedster/w3speedster package.
- Delete the above line, ensuring the JSON remains valid.
"require": {
"w3speedster/w3speedster": "1.0.0",
...
}
If the repositories section contains an entry for the w3speedster/w3speedster package, remove it as well:
"repositories": [
{
"type": "path",
"url": "packages/w3speedster/w3speedster"
}
]
Uninstall the Package
Run the following Composer command to remove the package from your project:
composer remove w3speedster/w3speedster
This command:
- Removes the package files from your project.
- Updates the composer.lock file to reflect the changes.
Clean Up Laravel Configuration
Remove Published Files:
If the package published configuration or assets files during installation, remove them manually. Check the config/ folder for a configuration file named w3speedster.php (or similar) and delete it:
rm config/w3speedster.php
Rollback Migrations (if applicable):
- If the package added database migrations, run the following command to roll them back
- If you're unsure which migrations belong to the package, check the database/migrations directory and remove any files that were added by the package.
php artisan migrate:rollback
php artisan cache:clear
php artisan config:clear
php artisan route:clear
php artisan view:clear
Remove Package Files
Delete the Package Directory:
Navigate to the packages folder and remove the w3speedster directory
rm -rf packages/w3speedster
Verify Autoload Files:
Refresh Composer’s autoload files to ensure the package is completely removed from the autoloader:
composer dump-autoload
Verify Uninstallation
Check for Artifacts:
Run the php artisan command to confirm that any Artisan commands related to the w3speedster package are no longer available.
Test the Application:
- Verify that your Laravel project runs without errors.
- Ensure no references to the w3speedster package remain in your codebase.
HTML Cache
Enable HTML Caching
Turning on HTML caching allows the W3Speedster Plugin to store and reuse static versions of your web pages. This reduces the need for generating pages dynamically each time they are requested, resulting in faster page load times and reduced server load. It is especially useful for improving performance and efficiency on high-traffic sites.
Enable Caching for Logged-in Users
Enabling this option allows caching of pages for users who are logged in. This can help improve performance for logged-in users by reducing the time it takes to generate pages dynamically. However, it’s important to ensure that the caching setup properly handles personalized content to avoid displaying incorrect or outdated information to users.
Serve HTML Cache File by
.htaccess: This option allows you to configure your server to serve HTML cache files directly using the .htaccess file. This method can improve page load times by delivering cached versions of your pages more efficiently. Advanced Cache File: The "Advanced Cache File" setting refers to additional configuration options for managing and optimizing cache files. This may include more granular control over caching rules, file expiration, or handling special cases to enhance performance and ensure proper cache management.
Enable Caching Page with GET Parameters
This option allows caching of pages that include GET parameters in their URLs. By enabling this, your server will cache and serve different versions of the page based on the parameters provided in the URL, such as example.com/page?param=value. This can improve performance by reusing cached versions for requests with the same parameters, but it’s important to ensure that caching is properly managed to handle dynamic content variations and avoid serving incorrect data.
Minify HTML
Enabling HTML minification reduces the size of your HTML files by removing unnecessary characters, such as whitespace, comments, and line breaks, without affecting the functionality or appearance of the content. This results in faster page load times and improved site performance by decreasing the amount of data that needs to be transferred between the server and the user's browser.
Cache Expiry Time
Set the time for cache expiry by entering a value in seconds. The default expiry time is 3600 seconds (1 hour). This determines how long cached content is stored before it is refreshed or cleared. Adjust this setting based on how frequently your content changes and your performance needs.
Separate Cache for Mobile
Enabling this option allows you to create and manage separate cache files for mobile users. This ensures that mobile-specific versions of your pages are cached and served separately from the desktop versions. This can improve performance and user experience by optimizing content and layout specifically for mobile devices.
Preload Caching
Preload caching involves generating and storing cached versions of your pages or resources before they are requested by users. This proactive approach ensures that cached content is available and served quickly when users access your site, improving page load times and overall performance. Preloading can be scheduled or triggered based on specific criteria, helping to optimize your site’s efficiency.
Preload Page Caching Per Minute
This feature allows you to automatically generate and update cached versions of your pages at regular intervals, such as every minute. By preloading page caching at these intervals, you ensure that the cached content remains fresh and up-to-date, providing users with the most current version of your site while maintaining fast load times. This approach helps balance performance with content accuracy.
Enable leverage browsing cache
The plugin also provides smart automatic functionality to enable leverage browser cache on your site, the plugin has an in-built response to the leverage cache, which it automatically implements in your site.
Enable Gzip compression
Our plugin offers an automatic feature to enable Gzip compression on your site. When activated, it compresses your site's files to reduce their size and improve load times. This functionality is implemented automatically but will only work on servers running Apache.
Remove query parameters
Our plugin also provides smart automatic functionality to remove Query Parameters from CSS & JS on your site, it automatically gets implemented in your site.
Cache Path
The cache of the W3Speedster Plugin is automatically generated inside the cache folder of the WP Content Folder and if you wish to change the path you can change it by putting the full path in this section.
General Settings
License Key
To use your licensed plugin, you must enter a license key. This key is unique for each product and is automatically generated when your plugin order is completed. You will find the key in the "Order Completed" email from W3Speedster. Activating the key ensures you receive updates and access to all plugin features.
Turn On Optimization
When you turn on this field, the W3Speedster Plugin will optimize your site by applying all the optimization settings. If this settings is turned off, no settings in w3speedster plugin will apply except html caching.
Optimize pages with Query parameters
This enables the optimization to be shown on the pages with query parameters when the optimization is live. For eg. https://www.example.com?nocache=1 will show optimized page if this setting is turned on. It is recommended only for servers with high performance.
Optimize pages when User Logged In
Enabling this option will optimize pages even when a user is logged in. Use this feature with caution, as it may affect the performance of dynamic or personalized content for logged-in users. Ensure that the optimization does not interfere with user-specific functionalities or content.
Separate javascript and CSS cache for mobile
This will create separate JavaScript and CSS cache for mobile. All css and javascript files will have mob.css at the end only for mobile(.css for desktop) and also separate Critical CSS will be created for Mobile and desktop.
Fix INP Issues
"Fix INP Issues" refers to addressing problems related to the "Interactive Next Paint" metric. By enabling this feature, you can resolve issues identified in Google PageSpeed Insights and/or Google Search Console related to the time it takes for your site to become fully interactive. This helps improve your website's performance and user experience.
CDN Settings
CDN URL
Enter the CDN (Content Delivery Network) URL that you have purchased for your site. This URL will be used to serve static assets like images, CSS, and JavaScript files, helping to improve your site's performance and load times by distributing content across multiple servers.
Exclude file extensions from cdn
During the implementation of the CDN, our plugin provides a section to exclude the specific extensions so that the functionality of site is not hampered, for instance, excluding ‘Font Extensions’ like (.woff, .ttf, .eot, .woff2) might be required because cross origin request for fonts are not allowed in many sites and allowing of fonts from external source has to done manually.
Exclude path from cdn
During the implementation of the CDN, our plugin provides a section to exclude the specific paths so that the work of the plugin is not hampered, for instance, excluding ‘/wp-includes/’.
Image Optimization
Optimize JPG/PNG Images
Enable image optimization by clicking the button. Once activated, images will be optimized in the background through wp-cron, provided the ‘Optimize Images via wp-cron’ option is enabled. This process helps improve your site’s performance by compressing images without losing quality.
JPG/PNG Image Quality
The W3Speedster Plugin maintains a standard image quality of 90% to preserve the clarity of your images. However, you can adjust this setting to meet your preferences, balancing image quality with file size according to your needs.
Convert to WebP
This feature will convert and render your images in the WebP format. To use it, make sure to start image optimization in the Image Optimization tab. The W3Speedster Plugin will handle the optimization for all JPG and PNG images, enhancing your site’s performance
WebP Image Quality
The W3Speedster Plugin uses a standard quality of 90% for WebP images to maintain their clarity. You can adjust this setting to suit your needs, balancing image quality with file size.
Enable Lazy Load
The W3Speedster Plugin allows you to lazy load four types of resources that can delay site loading time: Images, Iframes, Videos, and Audio. By enabling this feature, these resources will be loaded only when needed, improving your site's performance and load times.
Pixels to Load Resources Below the Viewport
The W3Speedster Plugin defaults to starting the loading of resources such as images, videos, iframes, background images, and audio when they are 200 pixels below the viewport. You can adjust this setting to start loading these resources earlier, so they appear more quickly as you scroll. For example, you can enter a value like 200 to set the distance from the viewport where loading begins.
Load SVG Inline Tag as URL
Load SVGs as URLs instead of inline tags to avoid creating large DOM elements. This approach helps improve performance by reducing the size of the DOM and simplifying your page structure.
Optimize Images via wp-cron
Enabling this option allows images to be optimized using wp-cron. The plugin will optimize one image attachment per minute to ensure that server performance remains unaffected. If you need faster optimization, click the "Start Optimization" button in the 'Image Optimization' tab to accelerate the process.
Optimize Images on the Go
This feature automatically optimizes images as site pages are crawled. The W3Speedster Plugin captures unconverted and unoptimized images when you visit a page and optimizes them in the background. This ensures that all images used on the site are prioritized for optimization. However, it is recommended to turn off this feature after the initial crawl and optimization to prevent unnecessary server load.
Automatically Optimize Images on Upload
This feature automatically optimizes and converts new images to WebP format as soon as they are uploaded. If you notice that image uploads are taking longer than expected, you may want to turn off this feature. Ensure that the settings for image optimization and WebP conversion are also enabled to use this feature effectively.
Responsive Images
The W3Speedster Plugin creates responsive images that adjust the background image of your webpage based on the user’s screen size, such as mobile, tablet, or desktop. This ensures that your images look optimal on all devices.
Insert Aspect Ratio in img Tag
This feature allows you to specify the aspect ratio for images directly within the img tag. By including the aspect ratio, you ensure that the space for the image is reserved on the page even before the image is fully loaded. This helps prevent layout shifts and improves the overall user experience by maintaining consistent image dimensions across different devices and screen sizes.
Start Image Optimization
By starting image optimization, the plugin will compress and optimize images on your site to enhance performance.
- Free Version: The first 500 images will be optimized.
- Pro Version: Unlimited images will be optimized.
CSS Optimization
Enable CSS Optimization
Enable this to start CSS optimiation. All css optimization like minification, critical css generation, custom css etc will show only when this option is turned on.
Combine Google fonts
The W3Speedster Plugin loads and combines all Google Fonts used on your site and loads it together preventing multiple requests. If critical css is generated, all required google fonts are loaded instantly and rest are lazyloaded ie. loads on user interaction. If you still want to load any font upfront and then you can write its css in custom css code section provided by the plugin.
Load Critical CSS
The W3Speedster Plugin generates Critical CSS which loads upfront and let all css files to load to user interaction enabling faster loading of the page.
Load Critical CSS in Style Tag
This option will load critical css in style tag instead of link tag. This option is not recommended for site with large page size. Implementing CDN will help a lot in speeding of site if this option is not enabled.
Create Critical CSS via wp-cron
Enabling this option allows the plugin to generate critical CSS for your WordPress pages using WP-Cron. By leveraging WP-Cron, the plugin can systematically process each page, creating critical CSS at a controlled pace. This method ensures that server performance remains unaffected, as the CSS generation process is spread out over time
Start generating critical CSS
This feature creates critical CSS for your website to improve page load performance. Just click on the button, it will automatically crawl almost all the pages and create critical css on its own. Critical css generation is pretty fast like 10-15 mins but may take more time with site with thousand of pages. In the Free Version, critical CSS will be generated only for the homepage. With the Pro Version (activated license key), unlimited critical CSS can be generated for your entire site.
Load Style Tag in Head to Avoid CLS
This feature allows style tags to load in the head section, fixing the Cumulative Layout Shift (CLS) of the page. To use it, simply add the ID of each style tag in the provided box and save your changes. Ensure that each style tag ID is entered on a new line.
Javascript Optimization
Enable Javascript Optimization
Enable this box to start JavaScript minification, a feature provided by the W3Speedster Plugin that optimizes your site's performance.
Lazyload Javascript
This option allows you to choose when to load JavaScript on your site. Enabling lazy loading for JavaScript can improve your site's initial loading speed by deferring the loading of JavaScript files until they are needed. Select "Yes" to enable lazy loading, or "No" to load JavaScript files immediately with the rest of your site's content. This helps balance performance and functionality based on your site's needs.
Load Javascript Inline Script as URL
Enter the matching text of the inline script URLs that you want to exclude from deferring JavaScript. Each exclusion should be entered on a new line. This allows you to specify which inline scripts should not be deferred, ensuring they load immediately to maintain essential functionality.
Exclusions
Preload Resources
If you want to preload resources such as images, CSS, JavaScript, or fonts, simply enter the complete URL of each resource in the 'Preload Resources' section. Each URL should be on a separate line. This ensures that the specified resources are loaded ahead of time, which can improve your site's performance.
Exclude Images from Lazy Loading
To prevent specific images from being lazy-loaded, you can exclude them by providing their URL, class name, ID, or alt attribute in the designated section. For example, you can enter "xyz.png" for a specific image or "nolazy" for images with a particular class name. This allows those images to load normally while others benefit from lazy loading.
Exclude Link Tag CSS from Optimization
With the W3Speedster Plugin, you can exclude specific CSS files from lazy loading and minification by entering their URLs in the relevant section. For example, if you have a CSS file like xyz.css that you do not want to optimize, simply provide its URL to ensure it is left out of the optimization process.
Force Lazy Load Link Tag CSS
To optimize files that consume excessive data, you can use the W3Speedster Plugin to force lazy loading for those CSS files. For example, you might want to lazy load files like FontAwesome.css or Icons.css. This helps improve performance by delaying the loading of these large CSS files until they are needed.
Force Lazy Load Javascript
To improve performance, you can force lazy loading for JavaScript which takes a long time to load. Enter specific words, IDs from inline script tags, or parts of script URLs in the provided section. For example, you might use identifiers like "Facebook" or "Instagram" to target and lazy load those scripts. This helps reduce loading times and improves your performance score.
Exclude Javascript Tags from Lazyload
With the W3Speedster Plugin, you can exclude specific JavaScript files from lazy loading and minification by entering their URLs in the relevant section. For example, if you have a JavaScript file like xyz.js that you do not want to lazy load or minify, simply provide its URL. This ensures those scripts are loaded normally while other scripts benefit from optimization.
Exclude Inline JavaScript from Lazy Load
This feature allows you to exclude specific inline JavaScript from being lazy-loaded. For example, you might want to exclude scripts like ‘Google Analytics’ to ensure they load immediately and function correctly without delay. This helps maintain essential functionalities while still benefiting from lazy loading for other scripts.
Exclude pages from HTML caching
Excluding specific pages from HTML caching ensures that these pages are always fetched directly from the server rather than from a cache. This approach is particularly useful for pages with dynamic content that changes frequently, user-specific pages, and sections of your site that must always display the most current data.
Exclude Pages From Optimization
To exclude specific pages from optimization, simply enter their URLs in the designated section. For example, you can list pages like /cart or /login that you do not wish to optimize. This ensures that these pages are left out of the optimization process while the rest of your site benefits from performance improvements.
Exclude Pages from CSS Optimization
To exclude specific pages from CSS optimization, enter the URL or a part of the URL where you do not want the CSS optimization to be applied. List each URL or URL fragment on a separate line to ensure those pages are excluded from the optimization process.
Exclude Page from JavaScript Optimization
With the W3Speedster Plugin, you can exclude specific pages from JavaScript minification and lazy loading by entering the script URLs or parts of the script URLs. Simply list each URL or URL fragment on a separate line. This allows you to ensure that certain pages or scripts are not affected by the optimization process.
Custom Code
Custom CSS to Load on Page Load
If you wish to preload any custom CSS that should be applied immediately when the page loads, add it in this section without including the <style>
tags. This CSS will only take effect when CSS optimization is enabled, ensuring that your custom styles are loaded efficiently along with the optimized CSS.
Custom JavaScript to Load on Page Load
If you wish to preload any JavaScript, add the code in this section without including the <script>
tags. Enter the JavaScript code that needs to be loaded before the page fully loads.
You have two options for loading:
- As File: Loads the script as a file.
- Defer: Defers loading of the script until after the initial page load.
Custom JavaScript to Load After Page Load
If you wish to load any JavaScript after the page has fully loaded or based on user interaction, add the code in this section without including the <script>
tags. This JavaScript will be executed after the page load, ensuring it does not interfere with the initial rendering of the page. Enter the JavaScript code that should run post-page load in this section.
Cache
Delete HTML Cache
Delete the HTML cache whenever you make changes to your site to ensure that the latest updates are reflected. This helps maintain accurate and up-to-date content for your visitors.
Delete JS/CSS Cache
The plugin lets you delete the combined and minified cache for JavaScript and CSS. This ensures that any changes made to your theme or plugin files are updated and reflected on your site.
Delete Critical CSS
The W3Speedster WordPress plugin allows you to delete Critical CSS. This should be done only when you make changes to the styles used in the upper part of your webpage. Deleting Critical CSS will clear the cache and require regeneration, which may take some time depending on the number of pages on your site.
Plugin Hooks
W3speedster Pre Start Optimization
Function: | w3SpeedsterPreStartOptimization |
---|---|
Description: | Modify page content pre optimization. |
Parameter: | $html = Content visible in pages view source. |
Return: | 1 – Reflect the changes done in html of the page. |
function w3SpeedsterPreStartOptimization($html){
$html = str_replace('Existing content','Changed content',$html);
return $html;
}
W3speedster Before Start Optimization
Function: | w3SpeedsterBeforeStartOptimization |
---|---|
Description: | W3Speedster allows you to make changes to the HTML on your site before actually starting the optimization. For instance replace or add in html. |
Parameter: | $html = $html – full html of the page. |
Return: | 1 – Reflect the changes done in html of the page. |
function w3SpeedsterBeforeStartOptimization($html){
$html = str_replace(array(""),array(""), $html);
return $html;
}
W3speedster After Optimization
Function: | w3SpeedsterAfterOptimization |
---|---|
Description: | W3Speedster allows you to make changes to the HTML on your site after the page is optimized by the plugin. For instance replace or add in html. |
Parameter: | $html – full html of the page. |
Return: | 1 – Reflect the changes done in html of the page. |
function w3SpeedsterAfterOptimization($html){
$html = str_replace(array('image.png'),array('image-100x100.png'), $html);
return $html;
}
W3speedster Inner JS Customize
Function: | w3SpeedsterInnerJsCustomize |
---|---|
Description: | If you want to make changes in your inline JavaScript, W3Speedster allows you to make changes in Inline JavaScript (for instance making changes in inline script you have to enter the unique text from the script to identify the script). |
Parameter: | $script_text- The content of the script. |
Return: | $script_text – Content of the script after changes. |
function w3SpeedsterInnerJsCustomize($script_text){
if(strpos($script_text'//unique word from script//') !== false){
$script_text = str_replace('jQuery(window)', 'jQuery(document)',$script_text);
}
return $script_text;
}
W3speedster Inner JS Exclude
Function: | w3SpeedsterInnerJsExclude |
---|---|
Description: | Exclude the script tag from lazy loading, which is present in the pages view source. |
Parameter: | $inner_js = The script tag s content is visible in the page s view source $exclude_js_bool = 0(default) || 1 |
Return: | 1 |
function w3SpeedsterInnerJsExclude($exclude_js_bool,$inner_js){
if(strpos($inner_js,'Script text') !== false){
$exclude_js_bool= 1;
}
return $exclude_js_bool;
}
W3speedster Internal JS Customize
Function: | w3SpeedsterInternalJsCustomize |
---|---|
Description: | If you wish to make changes in JavaScript files, W3Speedster allows you to make changes in JavaScript Files. |
Parameter: | $path- Path of the JS file. $string – javascript you want to make changes in. |
Return: | $string– make changes in the internal JS file. |
function w3SpeedsterInternalJsCustomize($string,$path){
if(strpos($path,'//js path//') !== false){
$string = str_replace("jQuery(windw)", "jQuery(window)",$string);
}
return $string;
}
W3speedster Internal Css Customize
Function: | w3SpeedsterInternalCssCustomize |
---|---|
Description: | If you want to make changes in your CSS file, W3Speedster allows you to make changes in stylesheet files. |
Parameter: | $css- Css content of the file. $path- path of css file. |
Return: | $css – make the required changes in CSS files. |
function w3SpeedsterInternalCssCustomize($css,$path){
if(strpos($path,' //cssPath // ') !== false){
$css = str_replace(' ',' ',$css);
}
return $css;
}
W3speedster Internal Css Minify
Function: | W3speedup_internal_css_minify |
---|---|
Description: | If you don’t want to minify, W3Speedster allows you to exclude stylesheet files from minify. |
Parameter: | $path- path of css file. $css- Css content of the file. $css_minify- 0 || 1 (default) |
Return: | 1 – it will exclude the entered css file from minification. 0 – it will not exclude the entered css file from minification. |
function w3SpeedsterInternalCssMinify($path,$css,$css_minify){
if(strpos($path,'//cssPath//') !== false){
$css_minify = 0;
}
return $css_minify ;
}
W3speedster No Critical Css
Function: | w3SpeedsterNoCriticalCss |
---|---|
Description: | W3Speedster allows you to exclude the pages from the Critical CSS (like search pages). |
Parameter: | $url- Stores the url of the page. $ignore_critical_css- 0 (default) || 1 |
Return: | 1 – it will exclude the page you do not wish to create critical CSS. |
function w3SpeedsterNoCriticalCss($url, $ignore_critical_css){
if(strpos($url,'/path/') !==false) {
$ignore_critical_css = 1;
}
return $ignore_critical_css;
}
W3speedster Customize Critical Css
Function: | w3SpeedsterCustomizeCriticalCss |
---|---|
Description: | If you wish to make any changes in Critical CSS, W3Speedster allows you to make changes in generated Critical CSS. For instance if you want to replace/ remove any string/URL from critical CSS (like @font-face { font-family:”Courgette”; to @font-face { ) |
Parameter: | $critical_css- Critical Css of the page. |
Return: | $critical_css – Reflect the changes made in critical css. |
function w3SpeedsterCustomizeCriticalCss($critical_css){
$critical_css = str_replace('@font-face { font-family:"Courgette";', ' ',$critical_css);
return $critical_css;
}
W3speedster Disable Htaccess Webp
Function: | w3SpeedsterDisableHtaccessWebp |
---|---|
Description: | Our plugin converts .jpg/.png format to WebP format without changing the URL. it disable webp to render from HTACCESS. |
Parameter: | $disable_htaccess_webp- 0(default) || 1 |
Return: | It will add w3.webp at the end of the url for instance (xyz.jpgw3.webp). |
function w3SpeedsterDisableHtaccessWebp($disable_htaccess_webp){
$disable_htaccess_webp = 1
return $disable_htaccess_webp;
}
W3speedster Customize Add Settings
Function: | w3SpeedsterCustomizeAddSettings |
---|---|
Description: | If you wish to change in variables and paths (URL), W3Speedster allows you to make changes in variables and paths with the help of this plugin function. |
Parameter: | $add_settings- settings of the plugin. |
Return: | :$add_settings – reflect the changes made in variable and path. |
function w3SpeedsterCustomizeAddSettings($add_settings){
$add_settings = str_replace(array(“mob.css”),array(“mobile.css”), $add_settings);
return $add_settings;
}
W3speedster Customize Main Settings
Function: | w3SpeedsterCustomizeMainSettings |
---|---|
Description: | Customize plugin main settings. |
Parameter: | $settings- Plugin main settings array (like: exclude css, cache path etc ) |
Return: | $settings |
function w3SpeedsterCustomizeMainSettings($settings){
$settings['setting_name'] = value;
return $settings;
}
W3speedster Seprate Critical Css For Post Type
Function: | w3SpeedsterCreateSeprateCssOfPostType |
---|---|
Description: | By default our plugin creates a single critical css for post but If you wish to generate separate critical CSS for post. W3Speedster allows you to create critical CSS separately post-wise. |
Parameter: | $separate_post_css- Array of post types. |
Return: | $separate_post_css – create separate critical css for each post and page. |
function w3SpeedsterCreateSeprateCssOfPostType($separate_post_css){
$separate_post_css = array('page','post','product');
return $separate_post_css;
}
W3speedster Seprate Critical Css For Category
Function: | W3speedsterCriticalCssOfCategory |
---|---|
Description: | W3Speedster Create seprate critical css for categories pages. |
Parameter: | $separate_cat_css- Array of Category. |
Return: | $separate_cat_css – create separate critical css for each category and tag. |
function W3speedsterCriticalCssOfCategory($separate_cat_css){
$separate_cat_css = array('category','tag','custom-category');
return $separate_cat_css;
}
W3speedster Change Video To Videolazy
Function: | w3SpeedsterVideoToVideoLazy |
---|---|
Description: | Change video tag to videolazy tag |
Parameter: | $videolazy- 0(default) || 1 |
Return: | 1 - Change video tag to videolazy tag. |
function w3SpeedsterVideoToVideoLazy($videolazy){
$videolazy= 1;
return $videolazy;
}
W3speedster Change Iframe To Iframlazy
Function: | w3SpeedsterIframetoIframelazy |
---|---|
Description: | Change iframe tag to iframlazy tag. |
Parameter: | $iframelazy- 0(default) || 1 |
Return: | 1 - Change iframe tag to iframlazy tag. |
function w3SpeedsterIframetoIframelazy($iframelazy){
$iframelazy = 1;
return $iframelazy;
}
W3speedster Exclude Image To Lazyload
Function: | w3SpeedsterExcludeImageToLazyload |
---|---|
Description: | W3Speedster allows you to exclude the images from optimization dynamically which you don’t want to lazyload. |
Parameter: | $exclude_image = 0(default) || 1 $img = Image tag with all attributes $imgnn_arr = Image tag |
Return: | 1 – it will lazy load the image. 0 – it will not lazy load the image. |
function w3SpeedsterExcludeImageToLazyload($exclude_image,$img, $imgnn_arr){
if(!empty($img) && strpos($img,'logo.png') !== false){
$exclude_image = 1
}
return $exclude_image;
}
W3speedster Customize Image
Function: | w3SpeedsterCustomizeImage |
---|---|
Description: | Customize image tags. |
Parameter: | $img = Image tag with all attributes $imgnn = Modified image tag by plugin $imgnn_arr = Image tag attributes array |
Return: | $imgnn- Customized image tags |
function w3SpeedsterCustomizeImage($imgnn,$img,$imgnn_arr){
if(strpos($imgnn,'alt') != false){
$imgnn = str_replace('alt=""','alt="value"',$imgnn);
}
return $imgnn;
}
W3speedster Prevent Htaccess Generation
Function: | w3SpeedsterPreventHtaccessGeneration. |
---|---|
Description: | Our plugin converts .jpg/.png format to WebP format without changing the URL. it disable webp to render from HTACCESS. |
Parameter: | $preventHtaccess = 0(default) || 1 |
Return: | 1 – It will add w3.webp at the end of the url for instance (xyz.jpgw3.webp). |
function w3SpeedsterPreventHtaccessGeneration($preventHtaccess){
$preventHtaccess = 1;
return $preventHtaccess;
}
W3speedster Exclude CSS Filter
Function: | W3SpeedsterExcludeCssFilter |
---|---|
Description: | If you want to dynamically exclude a CSS file from optimization, W3Speedster allows you to exclude it from optimization (like style.css). |
Parameter: | $exclude_css – 0(default) || 1 $css_obj – link tag in object format. $css – Content of the CSS file you want to make changes in. $html – content of the webpage. |
Return: | $exclude_css – exclude CSS from optimization. |
function W3SpeedsterExcludeCssFilter($exclude_css,$css_obj,$css,$html){
if(wp_is_mobile()){
if(strpos($css,'style.css') !== false){
$exclude_css = 1 ;
}
}
return $exclude_css;
}
W3speedster Customize Force Lazyload Css
Function: | w3SpeedsterCustomizeForceLazyCss. |
---|---|
Description: | If you wish to Force Lazyload CSS files dynamically for a specific page or pages, you can do so with the W3Speedster, it allows you to dynamically force lazyload stylesheet files (for instance font file like awesome, dashicons and css files). |
Parameter: | $force_lazyload_css – Array containing text to force lazyload which you have mentioned in the plugin configuration. |
Return: | $force_lazyload_css – Array containing text to force lazyload. |
function w3SpeedsterCustomizeForceLazyCss($force_lazyload_css){
array_push($force_lazyload_css ,'/fire-css');
return $force_lazyload_css;
}
W3speedster External Javascript Customize
Function: | W3SpeedsterExternalJavascriptCustomize |
---|---|
Description: | If you want to make changes in your external JavaScript tags, W3Speedster allows you to make changes in external JavaScript tags. |
Parameter: | $script_obj – Script in object format. $script – Content of the JS file you want to make changes in |
Return: | $script_obj – Make changes in Js files from an external source. |
function W3SpeedsterExternalJavascriptCustomize($script_obj, $script){
if(strpos($script,'//text//') !== false){
$script = str_replace(' ',' ',$script)
}
return $script_obj;
}
W3speedster External Javascript Filter
Function: | W3SpeedsterExternalJavascriptFilter |
---|---|
Description: | If you want to dynamically exclude a JavaScript file or inline script from optimization, W3Speedster allows you to exclude it from optimization (like revslider). |
Parameter: | $exclude_js – 0(default) || 1 $script_obj – Script in object format. $script – Content of the JS file you want to make changes in. $html – content of the webpage. |
Return: | $exclude_js – exclude JS from optimization. |
function W3SpeedsterExternalJavascriptFilter($exclude_js,$script_obj,$script,$html){
if(wp_is_mobile()){
if(strpos($script,'jquery-core-js') !== false || strpos($script,'/revslider/') !== false){
$exclude_js = 1 ;
}
}
return $exclude_js;
}
W3speedster Customize Script Object
Function: | W3SpeedsterCustomizeScriptObject |
---|---|
Description: | W3Speedster allows you to customize script objects while minifying and combining scripts. |
Parameter: | $script_obj- Script in object format. $script- Content of the JS file you want to make changes in |
Return: | $script_obj– Make changes in Js files. |
function W3SpeedsterCustomizeScriptObject($script_obj, $script){
// your code
return $script_obj;
}
W3speedster Exclude Internal Js W3 Changes
Function: | W3SpeedsterExcludeInternalJsW3Changes |
---|---|
Description: | Our plugin makes changes in JavaScript files for optimization, if you do not want to make any changes in JavaScript file, W3Speedster allows you to exclude JavaScript files from the plugin to make any changes. |
Parameter: | $path- path of your script tags url $string – JavaScript files content. $exclude_from_w3_changes = 0(default) || 1 |
Return: | 1 – Exclude the JS file from making any changes. 0 – It will not exclude the JS file from making any changes. |
function W3SpeedsterExcludeInternalJsW3Changes($exclude_from_w3_changes,$string,$path){
if(strpos($path,'//js path//') !== false){
$exclude_from_w3_changes = 1;
}
return $exclude_from_w3_changes;
}
W3speedster Exclude Page Optimization
Function: | W3SpeedsterExcludePageOptimization |
---|---|
Description: | W3Speedster allows you to exclude the pages from the Optimization. if you wish to exclude your pages from optimization. (like cart/login pages). |
Parameter: | $html = Page viewsources content. $exclude_page_optimization = 0(default) || 1 |
Return: | 1 – it will exclude the page from optimization. 0 – it will not exclude the page from optimization. |
function W3SpeedsterExcludePageOptimization($html,$exclude_page_optimization){
if(!empty($_REQUEST['//Path//'])){
$exclude_page_optimization = 1;
}
return $exclude_page_optimization;
}
W3speedster Customize Critical Css File Name
Function: | W3SpeedsterCustomizeCriticalCssFileName |
---|---|
Description: | If you wish to make any changes in Critical CSS filename, W3Speedster allows you to change in critical CSS file names. W3Speedster creates file names for critical CSS files but if you wish to change the name according to your preference this function will help. |
Parameter: | $file_name – File name of the critical css. |
Return: | $file_name – New name of the critical css file. |
function W3SpeedsterCustomizeCriticalCssFileName($file_name){
$file_name = str_replace(' ',' ',$file_name);
return $file_name;
}
Enable Core Web Vitals Logs
Enabling Core Web Vitals logs allows you to track and record data related to the Core Web Vitals metrics, which include Largest Contentful Paint (LCP), First Input Delay (FID), and Cumulative Layout Shift (CLS). These metrics are essential for assessing your site's performance and user experience. By logging this data, you can analyze performance issues, identify areas for improvement, and make informed optimizations to enhance overall site performance and user satisfaction.
Import / Export
Import Settings
To import settings into the W3Speedster Plugin, enter the exported JSON code from the plugin's import/export page. This allows you to apply previously saved configuration settings to your current setup, ensuring consistency and saving time when transferring settings between different sites or environments.
Export Settings
To export your settings, copy the code provided on the W3Speedster Plugin’s export page and save it in a file. This allows you to back up your configuration or transfer it to another site, ensuring that your settings can be easily restored or applied in the future.