Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
12/09/2014 12:54:33 AM (9 years ago)
Author:
tw2113
Message:

Add hook documentation for the Blogs component

Fixes #5939

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-blogs/bp-blogs-screens.php

    r9157 r9218  
    1818        return false;
    1919
     20    /**
     21     * Fires right before the loading of the My Blogs screen template file.
     22     *
     23     * @since BuddyPress (1.0.0)
     24     */
    2025    do_action( 'bp_blogs_screen_my_blogs' );
    2126
     
    3439        return false;
    3540
     41    /**
     42     * Fires right before the loading of the Create A Blog screen template file.
     43     *
     44     * @since BuddyPress (1.0.0)
     45     */
    3646    do_action( 'bp_blogs_screen_create_a_blog' );
    3747
     
    4757        bp_update_is_directory( true, 'blogs' );
    4858
     59        /**
     60         * Fires right before the loading of the top-level Blogs screen template file.
     61         *
     62         * @since BuddyPress (1.0.0)
     63         */
    4964        do_action( 'bp_blogs_screen_index' );
    5065
     
    94109            bp_update_is_directory( true, 'blogs' );
    95110
     111            /**
     112             * Fires if in the blog directory and BuddyPress needs Blog theme compatibility,
     113             * before the actions and filters are added.
     114             *
     115             * @since BuddyPress (1.5.0)
     116             */
    96117            do_action( 'bp_blogs_screen_index' );
    97118
     
    123144     */
    124145    public function directory_template_hierarchy( $templates ) {
    125         // Setup our templates based on priority
     146
     147        /**
     148         * Filters the custom templates used for theme compat with the blog directory page.
     149         *
     150         * @since BuddyPress (1.8.0)
     151         *
     152         * @param array $value Array of template paths to add to template list to look for.
     153         */
    126154        $new_templates = apply_filters( 'bp_template_hierarchy_blogs_create', array(
    127155            'blogs/index-directory.php'
     
    179207     */
    180208    public function create_template_hierarchy( $templates ) {
    181         // Setup our templates based on priority
     209
     210        /**
     211         * Filters the custom templates used for theme compat with the blog create page.
     212         *
     213         * @since BuddyPress (1.8.0)
     214         *
     215         * @param array $value Array of template paths to add to template list to look for.
     216         */
    182217        $new_templates = apply_filters( 'bp_template_hierarchy_blogs_create', array(
    183218            'blogs/index-create.php'
Note: See TracChangeset for help on using the changeset viewer.