How to use do_robotstxt action in WordPress

do_robotstxt action

Fires when displaying the robots.txt file.

To use the do_robotstxt action, first you have to register it using add_action. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function weplugins_execute_on_do_robotstxt_event and we registered it using add_action. The first parameter do_robotstxt is the name of the hook, the second parameter weplugins_execute_on_do_robotstxt_event is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times, and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_action to remove the do_robotstxt action.

Parameters

• No parameters

Live Example

do_action( 'do_robotstxt' )

Below is an example of how you can use this hook.

Example 1: Basic Hook Usage

This example shows how to execute a function when the do_robotstxt action is triggered.

    function weplugins_execute_on_do_robotstxt_event(){
        // You can write code here to be executed when this action occurs in WordPress website according to your requirements.
        
    }
    // Add the action
    add_action( "do_robotstxt", "weplugins_execute_on_do_robotstxt_event");
    

Example 2: Removing a Hook Callback

To remove a hook callback, use the example below.

    // Remove the action
    remove_action( "do_robotstxt", "weplugins_execute_on_do_robotstxt_event");
    

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Example 3: Custom Functionality

This example demonstrates adding custom functionality when the do_robotstxt action is fired.

    function weplugins_custom_do_robotstxt(){
        echo "User-agent: *n";
        echo "Disallow: /wp-admin/n";
    }
    // Add the custom action
    add_action( "do_robotstxt", "weplugins_custom_do_robotstxt");
    

Contact Us

If you need customization or assistance with this hook, feel free to contact us.