{"id":4465,"date":"2018-04-03T13:18:28","date_gmt":"2018-04-03T13:18:28","guid":{"rendered":"https:\/\/ampforwp.com\/tutorials\/?post_type=ht_kb&p=4465"},"modified":"2021-08-11T11:15:38","modified_gmt":"2021-08-11T11:15:38","slug":"hooks-in-ampforwp","status":"publish","type":"ht_kb","link":"https:\/\/ampforwp.com\/tutorials\/article\/hooks-in-ampforwp\/","title":{"rendered":"Hooks in AMPforWP"},"content":{"rendered":"\n

Here is the complete list of all our hooks including their functionalities:<\/strong><\/p>\n\n\n\n

  1. Sitewide<\/a><\/strong><\/li>
  2. HomePage<\/a><\/strong><\/li>
  3. single.php<\/a><\/strong><\/li>
  4. archive.php<\/a><\/strong><\/li>
  5. search.php<\/a><\/strong><\/li>
  6. AMP Option Panel Settings<\/a><\/strong><\/li>
  7. Hooks in Facebook Instant Articles<\/strong><\/a><\/li><\/ol>\n\n\n\n

    Sitewide – These hooks will run throughout the AMP website <\/strong><\/mark><\/h3>\n\n\n\n
    Actions Hooks<\/strong> <\/td> Description<\/strong> <\/td><\/tr>
    amp_post_template_head <\/strong><\/td>
    It is used to add extra things in Head section of AMP which will come in handy if you want to add extra metas, JS of AMP components, etc..,

    <\/td><\/tr>
    amp_post_template_css <\/strong><\/td>
    It is used to add extra CSS to your AMP pages

    <\/td><\/tr>
    ampforwp_body_beginning <\/strong><\/td>
    It is executed right after the beginning of Body tag which can be very useful to add things like Analytics.

    <\/td><\/tr>

    ampforwp_after_header <\/strong>

    <\/td>    		 It is executed right after the header section of AMP <\/td><\/tr>

    below_the_header_design_1 [ Design-1 only ] <\/strong>

    <\/td>    		 It is executed right after the header section of AMP <\/td><\/tr>

    amp_post_template_above_footer <\/strong>

    <\/td>    		It executes right before the footer.php <\/td><\/tr>

    amp_post_template_footer <\/strong>

    <\/td>    		 It executes after the footer and just before the end of the body tag. <\/td><\/tr>

    pre_amp_render_post <\/strong>

    <\/td>    		 This hook will only work in the AMP environment. <\/td><\/tr>

    amp_experiment_meta <\/strong>

    <\/td>    		With the help of this hook, you can add additional meta tags<\/td><\/tr>

    amp_meta <\/strong>

    <\/td>    		With the help of this hook, you can add meta tags<\/td><\/tr>
    ampforwp_after_amp_menu<\/strong>

    <\/td>
    With the help of this hook, you can add additional meta tags in the header section

    <\/td><\/tr>

    amp_before_footer <\/strong>

    <\/td>
    With the help of this hook, you can add additional meta tags in the footer section


    <\/td><\/tr>

    amp_footer_link<\/strong>
    <\/strong>
    <\/td>
    With the help of this hook, you can add a link in the footer section

    <\/td><\/tr>

    amp_sidebar_start <\/strong>

    <\/td>
    With the help of this hook, you can add additional information at the beginning of the sidebar

    <\/td><\/tr>

    amp_sidebar_end <\/strong>

    <\/td>
    With the help of this hook, you can add additional information at the end of the sidebar

    <\/td><\/tr>

    ampforwp_before_meta_info_hook [ Design 1,2,3 ]<\/strong>
    <\/td>
    With the help of this hook, you can add additional meta tags in the beginning [Only in Design 1,2,3]

    <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    HomePage – These hooks will run only on the homepage<\/strong><\/mark><\/h3>\n\n\n\n
    Actions Hooks<\/strong>
    <\/td>    		Description<\/strong> <\/td>Location<\/strong><\/td><\/tr>

    ampforwp_home_above_loop<\/strong> <\/td>
    This hook is used to add the things above the Homepage loop.

    <\/td>
    index.php<\/strong> <\/td><\/tr>

    amp_before_loop [ Swift ] <\/strong><\/td>
    This hook executes before the loop (Home and Archive). It can be used to add anything just above the loop.

    <\/td>
    index.php<\/strong> <\/td><\/tr>

    ampforwp_post_before_loop <\/strong><\/td>
    This hook executes before the loop (Home and Archive). It can be used to add anything just above the loop.

    <\/td>
    index.php<\/strong> <\/td><\/tr>

    ampforwp_between_loop <\/strong><\/td>
    This hook executes in between the loop (Home and Archive). It can be used to add anything in between the loop. It has $count variable as a parameter which can be used to count the number of posts which can help greatly to decide where exactly you want to use this hook in the loop.

    <\/td>
    index.php<\/strong> <\/td><\/tr>

    ampforwp_post_after_loop <\/strong><\/td>
    This hook executes after the loop (Home and Archive). It can be used to add anything just below the loop.

    <\/td>
    index.php<\/strong> <\/td><\/tr>
    amp_after_loop [ Swift ]<\/strong><\/td>
    This hook executes after the loop (Home and Archive). It can be used to add anything just below the loop.

    <\/td>
    index.php<\/strong> <\/td><\/tr>

    ampforwp_home_below_loop <\/strong><\/td>
    This hook is used to add the things below the Homepage loop.

    <\/td>
    index.php<\/strong> <\/td><\/tr>

    ampforwp_area_above_loop [ Design 3] <\/strong> <\/td>
    With the help of this hook, you can add additional information above the loop [only in Design 1,2,3]


    <\/td>
    index.php<\/strong> <\/td><\/tr>

    ampforwp_frontpage_above_loop \ufeff<\/strong> <\/td>
    This hook executes before the content of Frontpage.
    (These hooks will run on Custom FrontPage of Design 1,2 and 3 only)

    <\/td>
    frontpage.php<\/strong> <\/td><\/tr>

    ampforwp_frontpage_below_loop \ufeff<\/strong> <\/td>
    This hook executes after the content of Frontpage.
    ( These hooks will run on Custom FrontPage of Design 1,2 and 3 only )

    <\/td>
    frontpage.php<\/strong> <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    single.php – <\/strong> These hooks will execute on<\/strong> Posts and Pages <\/strong><\/mark><\/h3>\n\n\n\n
    Actions Hooks<\/strong>
    <\/td>    		Description<\/strong> <\/td>Location<\/strong><\/td><\/tr>

    ampforwp_post_before_design_elements <\/strong>

    <\/td>
    This hook runs before the elements like breadcrumb, title, content meta-info etc which are present in elements folder of each design.

    <\/td>
    single.php <\/strong> <\/td><\/tr>

    ampforwp_post_after_design_elements <\/strong>

    <\/td>
    This hook runs after the elements like breadcrumb, title, content meta-info etc which are present in elements folder of each design.

    <\/td>
    single.php <\/strong> <\/td><\/tr>

    ampforwp_single_design_type_handle_d1 <\/strong>

    <\/td>    		 This hook executes after the Next-Previous Links. <\/td>
    single.php <\/strong> <\/td><\/tr>

    ampforwp_below_author_box <\/strong>

    <\/td>
    With the help of this hook, you can add additional information below the author box

    <\/td>
    single.php <\/strong> <\/td><\/tr>

    ampforwp_push_notification_widget <\/strong>

    <\/td>    		This hook is used to add web push widget markup in amp<\/td>
    single.php <\/strong> <\/td><\/tr>

    ampforwp_global_after_footer <\/strong>
    <\/td>
    This hook executes at the end of the footer i.e., footer.php
    <\/td>
    footer.php<\/strong> <\/td><\/tr>

    ampforwp_header_top_design{designno} <\/strong>
    <\/td>    		 This hook executes at the beginning of Header <\/td>
    header-bar.php<\/strong> <\/td><\/tr>

    ampforwp_header_search [ Design 1,2,3 ] <\/strong> <\/td>    		 It executes the search button present in the header. You can use it to add your own search button as well. <\/td>
    header-bar.php<\/strong> <\/td><\/tr>

    ampforwp_call_button [ Design 1,2,3 ] <\/strong> <\/td>
    It executes the call button present in the header. You can use it to add your own call button as well. <\/td>
    header-bar.php<\/strong> <\/td><\/tr>

    ampforwp_header_bottom_design{designno} <\/strong> <\/td>
    This hook executes at the end of the Header. <\/td>
    header-bar.php<\/strong> <\/td><\/tr>


    ampforwp_before_comment_hook<\/strong>
    <\/td>
    This hook executes right before the Comments.

    <\/td>

    comments.php<\/strong> <\/td><\/tr>

    ampforwp_reply_comment_form<\/strong>
    <\/td>
    This hook executes right after the content of each comment.
    <\/td>
    comments.php<\/strong> <\/td><\/tr>

    ampforwp_after_comment_hook<\/strong> <\/td>
    This hook executes right after the Comments.
    <\/td>
    comments.php<\/strong> <\/td><\/tr>

    ampforwp_inside_post_content_before [Design-1]<\/strong>

    <\/td>
    This hook executes before the content. It works in Design-1 only. <\/td>
    content.php<\/strong> <\/td><\/tr>

    ampforwp_before_post_content<\/strong>
    <\/td>
    This hook executes before the content. <\/td>
    content.php<\/strong> <\/td><\/tr>


    ampforwp_after_post_content
    <\/strong> <\/td>
    This hook executes after the content. <\/td>
    content.php<\/strong> <\/td><\/tr>


    ampforwp_before_content_hook<\/strong>
    <\/td>
    This hook executes before the content.

    <\/td>
    content.php<\/strong>
    <\/td><\/tr>

    ampforwp_before_featured_image_hook<\/strong> <\/td>
    It executes right before the featured image in Single and Custom FrontPage. <\/td>
    featured-image.php<\/strong> <\/td><\/tr>

    ampforwp_after_featured_image_hook<\/strong> <\/td>
    It executes right after the featured image in Single and Custom FrontPage. <\/td>
    featured-image.php<\/strong> <\/td><\/tr>

    ampforwp_above_related_post<\/strong> <\/td>
    This hook executes right above the Related Posts in Single.
    <\/td>
    related-posts.php<\/strong> <\/td><\/tr>

    ampforwp_between_related_post<\/strong> <\/td>
    This hook executes between the Related Posts in Single. It can be used to add things like Ads in between the related posts of single.
    <\/td>
    related-posts.php<\/strong> <\/td><\/tr>

    ampforwp_below_related_post
    <\/strong> <\/td>
    This hook executes right below the Related Posts in Single.
    <\/td>
    related-posts.php<\/strong> <\/td><\/tr>

    ampforwp_before_social_icons_hook<\/strong> <\/td>
    It runs before the Social icons in Single. <\/td>
    social-icons.php<\/strong> <\/td><\/tr>

    ampforwp_after_social_icons_hook<\/strong> <\/td>
    It runs after the Social icons in Single.
    <\/td>
    social-icons.php<\/strong> <\/td><\/tr>

    ampforwp_above_the_title<\/strong>

    <\/td>
    This hook runs before the Title in Single.
    <\/td>
    title.php<\/strong> <\/td><\/tr>

    ampforwp_below_the_title<\/strong>
    <\/td>
    This hook runs after the Title in Single.
    <\/td>
    title.php<\/strong> <\/td><\/tr>
    <\/td><\/td><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    Note:<\/strong> In Swift pages are served through page.php 
    <\/p><\/p>\n\n\n\n

    archive.php – These hooks will execute on Archive Pages <\/strong><\/mark><\/h3>\n\n\n\n
    Actions Hooks<\/strong>
    <\/td>    		Description<\/strong> <\/td>Location<\/strong><\/td><\/tr>

    ampforwp_post_before_loop<\/strong> <\/td>
    This hook executes before the loop (Home and Archive). It can be used to add anything just above the loop.
    <\/td>
    archive.php<\/strong> <\/td><\/tr>

    amp_before_loop [ Swift ]<\/strong> <\/td>
    This hook executes before the loop (Home and Archive). It can be used to add anything just above the loop. <\/td>
    archive.php<\/strong> <\/td><\/tr>

    ampforwp_between_loop<\/strong> <\/td>
    This hook executes in between the loop (Home and Archive). It can be used to add anything in between the loop. It has $count variable as a parameter which can be used to count the number of posts which can help greatly to decide where exactly you want to use this hook in the loop.
    <\/td>
    archive.php<\/strong> <\/td><\/tr>

    ampforwp_post_after_loop<\/strong> <\/td>
    This hook executes after the loop (Home and Archive). It can be used to add anything just below the loop. <\/td>
    archive.php<\/strong> <\/td><\/tr>

    amp_after_loop [ Swift ]<\/strong> <\/td>
    This hook executes after the loop (Home and Archive). It can be used to add anything just below the loop. <\/td>
    archive.php<\/strong> <\/td><\/tr>

    ampforwp_loop_before_pagination<\/strong>
    <\/td>    		This hook is used to add the things above the pagination<\/td>
    archive.php<\/strong> <\/td><\/tr>

    ampforwp_before_meta_taxonomy_hook [ Design 1,2,3 ]
    <\/strong> <\/td>
    It executes right before the Meta taxonomy in Single. <\/td>
    meta-taxonomy.php<\/strong> <\/td><\/tr>

    ampforwp_after_meta_taxonomy_hook [ Design 1,2,3 ]<\/strong> <\/td>
    It executes right after the Meta taxonomy in Single. <\/td>
    meta-taxonomy.php<\/strong> <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    search.php – These hooks will run on Search Pages <\/strong><\/mark><\/h3>\n\n\n\n
    Actions Hooks<\/strong>
    <\/td>    		Description<\/strong> <\/td>Location<\/strong><\/td><\/tr>

    ampforwp_post_before_loop<\/strong> <\/td>
    This hook executes before the loop (Home and Archive). It can be used to add anything just above the loop.

    <\/td>
    search.php<\/strong> <\/td><\/tr>

    amp_before_loop [ Swift ] <\/strong><\/td>
    This hook executes before the loop (Home and Archive). It can be used to add anything just above the loop.

    <\/td>
    search.php<\/strong> <\/td><\/tr>

    ampforwp_between_loop <\/strong><\/td>
    This hook executes in between the loop (Home and Archive). It can be used to add anything in between the loop. It has $count variable as a parameter which can be used to count the number of posts which can help greatly to decide where exactly you want to use this hook in the loop.

    <\/td>
    search.php<\/strong> <\/td><\/tr>

    ampforwp_post_after_loop  <\/strong><\/td>
    This hook executes after the loop (Home and Archive). It can be used to add anything just below the loop.

    <\/td>
    search.php<\/strong> <\/td><\/tr>

    amp_after_loop [ Swift ] <\/strong><\/td>
    This hook executes after the loop (Home and Archive). It can be used to add anything just below the loop.

    <\/td>
    search.php<\/strong> <\/td><\/tr>

    ampforwp_search_form_data <\/strong>

    <\/a><\/td>    		With the help of this filter, you can change the URL structure of the search query<\/td>
    search.php<\/strong>

    <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    AMP Option Panel Settings – These hooks will run throughout the AMP option Panel\u00a0 <\/strong><\/mark><\/h4>\n\n\n\n
    Actions Hooks<\/strong>
    <\/td>    		 Description<\/strong> <\/td><\/tr>

    ampforwp_remove_unused_options<\/strong>


    <\/td>
    If you want to remove unused sections from AMP options panel then use this hook.

    <\/td><\/tr>

    ampforwp_options_enabler<\/strong>


    <\/td>
    By using this hook you can enable the required options in the AMP Options Panel when AMP Theme Framework is activated.

    <\/td><\/tr>

    ampforwp_options_remover <\/strong><\/td>
    By using this hook you can remove the required options in the AMP Options Panel when AMP Theme Framework is activated.

    <\/td><\/tr>

    amp_template_mode_hide_opt_array<\/strong>


    <\/td>
    By using this hook you can hide option in Template- mode

    <\/td><\/tr>

    amp_template_mode_show_opt_array
    <\/strong>
    <\/td>
    By using this hook you can show option in Template- mode

    <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    Hooks in Facebook Instant Articles<\/mark><\/h3>\n\n\n\n
    Actions Hooks<\/strong>
    <\/td>    		 Description<\/strong> <\/td><\/tr>
    ampforwp_fbia_head<\/strong><\/td>
    It is used to add extra things in Head section of FBIA which will come in handy if you want to add extra things in Head section
    <\/td><\/tr>
    ampforwp_fbia_body<\/strong><\/td>
    It is used to add extra things in the Body section of FBIA which will come in handy if you want to add extra things in Body section
    <\/td><\/tr>
    ampforwp_fbia_footer<\/strong><\/td>
    It is used to add extra things in the Footer section of FBIA which will come in handy if you want to add extra things in Footer section
    <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    Here is an example showing how to use a hook by creating a custom plugin for AMP for WP and the below code will add a banner after the content in the AMP pages<\/strong><\/p>\n\n\n\n