WordPress.org
Get WordPress

Make WordPress Core

Changeset 30648


Ignore:
Timestamp:
11/30/2014 11:27:19 AM (10 years ago)
Author:
DrewAPicture
Message:

Docs Formatting: Backtick-escape inline code for all dynamic hook docs in wp-admin/includes/*.

Also adds a few inline @see cross-references as they apply.

Affects DocBlocks for the following hooks:

  • views_{$this->screen->id}
  • bulk_actions-{$this->screen->id}
  • manage_{$this->screen->id}_sortable_columns
  • theme_action_links_$stylesheet
  • after_theme_row_$stylesheet
  • install_plugins_table_api_args_$tab
  • $prefix . plugin_action_links
  • after_plugin_row_$plugin_file
  • manage_taxonomies_for_{$post_type}_columns
  • manage_{$post_type}_posts_columns
  • manage_{$post->post_type}_posts_custom_column
  • {$taxonomy}_row_actions
  • manage_{$this->screen->taxonomy}_custom_column
  • install_themes_table_api_args_' . $tab
  • auto_update_ . $type
  • {$action}_prefilter
  • admin_head_{$content_func}
  • nav_menu_items_{$post_type_name}
  • activate_ . $plugin
  • deactivate_ . $plugin
  • edit_{$post_type}_per_page
  • postbox_classes_{$page}_{$id}
  • _wp_post_revision_field_$field
  • manage_{$screen->id}_columns
  • in_plugin_update_message-{$file}
  • in_theme_update_message-{$theme_key}

See #30552.

Location:
trunk/src/wp-admin/includes
Files:
16 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/includes/class-wp-list-table.php

    r30610 r30648  
    343343         * Filter the list of available list table views.
    344344         *
    345          * The dynamic portion of the hook name, $this->screen->id, refers
     345         * The dynamic portion of the hook name, `$this->screen->id`, refers
    346346         * to the ID of the current screen, usually a string.
    347347         *
    … …  
    391391             * Filter the list table Bulk Actions drop-down.
    392392             *
    393              * The dynamic portion of the hook name, $this->screen->id, refers
     393             * The dynamic portion of the hook name, `$this->screen->id`, refers
    394394             * to the ID of the current screen, usually a string.
    395395             *
    … …  
    767767         * Filter the list table sortable columns for a specific screen.
    768768         *
    769          * The dynamic portion of the hook name, $this->screen->id, refers
     769         * The dynamic portion of the hook name, `$this->screen->id`, refers
    770770         * to the ID of the current screen, usually a string.
    771771         *

  • trunk/src/wp-admin/includes/class-wp-ms-themes-list-table.php

    r29460 r30648  
    332332         * list table.
    333333         *
    334          * The dynamic portion of the hook name, $stylesheet, refers to the
     334         * The dynamic portion of the hook name, `$stylesheet`, refers to the
    335335         * directory name of the theme, which in most cases is synonymous
    336336         * with the template name.
    … …  
    445445         * Fires after each specific row in the Multisite themes list table.
    446446         *
    447          * The dynamic portion of the hook name, $stylesheet, refers to the
     447         * The dynamic portion of the hook name, `$stylesheet`, refers to the
    448448         * directory name of the theme, most often synonymous with the template
    449449         * name of the theme.

  • trunk/src/wp-admin/includes/class-wp-plugin-install-list-table.php

    r29829 r30648  
    157157         * Filter API request arguments for each Plugin Install screen tab.
    158158         *
    159          * The dynamic portion of the hook name, $tab, refers to the plugin install tabs.
     159         * The dynamic portion of the hook name, `$tab`, refers to the plugin install tabs.
    160160         * Default tabs are 'dashboard', 'search', 'upload', 'featured', 'popular', 'new',
    161161         * and 'favorites'.

  • trunk/src/wp-admin/includes/class-wp-plugins-list-table.php

    r29707 r30648  
    425425         * Filter the action links displayed for each plugin in the Plugins list table.
    426426         *
    427          * The dynamic portion of the hook name, $prefix, refers to the context the
     427         * The dynamic portion of the hook name, `$prefix`, refers to the context the
    428428         * action links are displayed in. The 'network_admin_' prefix is used if the
    429429         * current screen is the Network plugins list table. The prefix is empty ('')
    … …  
    590590         * Fires after each specific row in the Plugins list table.
    591591         *
    592          * The dynamic portion of the hook name, $plugin_file, refers to the path
     592         * The dynamic portion of the hook name, `$plugin_file`, refers to the path
    593593         * to the plugin file, relative to the plugins directory.
    594594         *

  • trunk/src/wp-admin/includes/class-wp-posts-list-table.php

    r30360 r30648  
    302302         * Filter the taxonomy columns in the Posts list table.
    303303         *
    304          * The dynamic portion of the hook name, $post_type, refers to the post
     304         * The dynamic portion of the hook name, `$post_type`, refers to the post
    305305         * type slug.
    306306         *
    … …  
    356356         * Filter the columns displayed in the Posts list table for a specific post type.
    357357         *
    358          * The dynamic portion of the hook name, $post_type, refers to the post type slug.
     358         * The dynamic portion of the hook name, `$post_type`, refers to the post type slug.
    359359         *
    360360         * @since 3.0.0
    … …  
    878878                 * Fires for each custom column of a specific post type in the Posts list table.
    879879                 *
    880                  * The dynamic portion of the hook name, $post->post_type, refers to the post type.
     880                 * The dynamic portion of the hook name, `$post->post_type`, refers to the post type.
    881881                 *
    882882                 * @since 3.1.0

  • trunk/src/wp-admin/includes/class-wp-terms-list-table.php

    r29707 r30648  
    328328         * Filter the action links displayed for each term in the terms list table.
    329329         *
    330          * The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug.
     330         * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
    331331         *
    332332         * @since 3.0.0
    … …  
    393393         * Filter the displayed columns in the terms list table.
    394394         *
    395          * The dynamic portion of the hook name, $this->screen->taxonomy,
     395         * The dynamic portion of the hook name, `$this->screen->taxonomy`,
    396396         * refers to the slug of the current taxonomy.
    397397         *

  • trunk/src/wp-admin/includes/class-wp-theme-install-list-table.php

    r29206 r30648  
    107107         * Filter API request arguments for each Install Themes screen tab.
    108108         *
    109          * The dynamic portion of the hook name, $tab, refers to the theme install
     109         * The dynamic portion of the hook name, `$tab`, refers to the theme install
    110110         * tabs. Default tabs are 'dashboard', 'search', 'upload', 'featured',
    111111         * 'new', and 'updated'.

  • trunk/src/wp-admin/includes/class-wp-upgrader.php

    r30554 r30648  
    19351935         * Filter whether to automatically update core, a plugin, a theme, or a language.
    19361936         *
    1937          * The dynamic portion of the hook name, $type, refers to the type of update
     1937         * The dynamic portion of the hook name, `$type`, refers to the type of update
    19381938         * being checked. Can be 'core', 'theme', 'plugin', or 'translation'.
    19391939         *
    … …  
    19421942         * are updated by default.
    19431943         *
    1944          * See the allow_dev_auto_core_updates, allow_minor_auto_core_updates, and
    1945          * allow_major_auto_core_updates filters for a more straightforward way to
     1944         * See the {@see 'allow_dev_auto_core_updates', {@see 'allow_minor_auto_core_updates'},
     1945         * and {@see 'allow_major_auto_core_updates'} filters for a more straightforward way to
    19461946         * adjust core updates.
    19471947         *

  • trunk/src/wp-admin/includes/file.php

    r30538 r30648  
    209209
    210210    /**
    211      * The dynamic portion of the hook name, $action, refers to the post action.
    212      *
    213      * @since 2.9.0 as 'wp_handle_upload_prefilter'
    214      * @since 4.0.0 Converted to a dynamic hook with $action
     211     * Filter the data for a file before it is uploaded to WordPress.
     212     *
     213     * The dynamic portion of the hook name, `$action`, refers to the post action.
     214     *
     215     * @since 2.9.0 as 'wp_handle_upload_prefilter'.
     216     * @since 4.0.0 Converted to a dynamic hook with `$action`.
    215217     *
    216218     * @param array $file An array of data for a single file.

  • trunk/src/wp-admin/includes/media.php

    r30600 r30648  
    495495     * (pre-3.5.0) media upload popup.
    496496     *
    497      * The dynamic portion of the hook, $content_func, refers to the form
     497     * The dynamic portion of the hook, `$content_func`, refers to the form
    498498     * callback for the media upload type. Possible values include
    499499     * 'media_upload_type_form', 'media_upload_type_url_form', and
    … …  
    596596     * Filter the upload iframe source URL for a specific media type.
    597597     *
    598      * The dynamic portion of the hook name, $type, refers to the type
     598     * The dynamic portion of the hook name, `$type`, refers to the type
    599599     * of media uploaded.
    600600     *
    … …  
    764764             * Filter the URL sent to the editor for a specific media type.
    765765             *
    766              * The dynamic portion of the hook name, $type, refers to the type
     766             * The dynamic portion of the hook name, `$type`, refers to the type
    767767             * of media being sent.
    768768             *

  • trunk/src/wp-admin/includes/nav-menu.php

    r30627 r30648  
    793793                 * post type's menu items meta box.
    794794                 *
    795                  * The dynamic portion of the hook name, $post_type_name,
    796                  * refers to the slug of the current post type.
     795                 * The dynamic portion of the hook name, `$post_type_name`, refers
     796                 * to the slug of the current post type.
    797797                 *
    798798                 * @since 3.2.0

  • trunk/src/wp-admin/includes/plugin.php

    r30544 r30648  
    562562             *
    563563             * This hook is the "activation" hook used internally by
    564              * register_activation_hook(). The dynamic portion of the
    565              * hook name, $plugin, refers to the plugin basename.
     564             * {@see register_activation_hook()}. The dynamic portion of the
     565             * hook name, `$plugin`, refers to the plugin basename.
    566566             *
    567567             * If a plugin is silently activated (such as during an update),
    … …  
    675675             *
    676676             * This hook is the "deactivation" hook used internally by
    677              * register_deactivation_hook(). The dynamic portion of the
    678              * hook name, $plugin, refers to the plugin basename.
     677             * {@see register_deactivation_hook()}. The dynamic portion of the
     678             * hook name, `$plugin`, refers to the plugin basename.
    679679             *
    680680             * If a plugin is silently deactivated (such as during an update),

  • trunk/src/wp-admin/includes/post.php

    r30645 r30648  
    966966     * Filter the number of items per page to show for a specific 'per_page' type.
    967967     *
    968      * The dynamic portion of the hook name, $post_type, refers to the post type.
     968     * The dynamic portion of the hook name, `$post_type`, refers to the post type.
    969969     *
    970970     * Some examples of filter hooks generated here include: 'edit_attachment_per_page',
    … …  
    11051105     * Filter the postbox classes for a specific screen and screen ID combo.
    11061106     *
    1107      * The dynamic portions of the hook name, $page, and $id, refer to
    1108      * the screen, and screen ID, respectively.
     1107     * The dynamic portions of the hook name, `$page` and `$id`, refer to
     1108     * the screen and screen ID, respectively.
    11091109     *
    11101110     * @since 3.2.0

  • trunk/src/wp-admin/includes/revision.php

    r30602 r30648  
    5959         * Contextually filter a post revision field.
    6060         *
    61          * The dynamic portion of the hook name, $field, corresponds to each of the post
     61         * The dynamic portion of the hook name, `$field`, corresponds to each of the post
    6262         * fields of the revision object being iterated over in a foreach statement.
    6363         *
    … …  
    6767         * @param string  $field                The current revision field.
    6868         * @param WP_Post $compare_from         The revision post object to compare to or from.
    69          * @param string  null                  The context of whether the current revision is the old or the new one. Values are 'to' or 'from'.
     69         * @param string  null                  The context of whether the current revision is the old
     70         *                                      or the new one. Values are 'to' or 'from'.
    7071         */
    7172        $content_from = $compare_from ? apply_filters( "_wp_post_revision_field_$field", $compare_from->$field, $field, $compare_from, 'from' ) : '';

  • trunk/src/wp-admin/includes/screen.php

    r30369 r30648  
    2626         * Filter the column headers for a list table on a specific screen.
    2727         *
    28          * The dynamic portion of the hook name, $screen->id, refers to the
     28         * The dynamic portion of the hook name, `$screen->id`, refers to the
    2929         * ID of a specific screen. For example, the screen ID for the Posts
    3030         * list table is edit-post, so the filter for that screen would be

  • trunk/src/wp-admin/includes/update.php

    r28500 r30648  
    290290         * row of the plugins list table.
    291291         *
    292          * The dynamic portion of the hook name, $file, refers to the path
     292         * The dynamic portion of the hook name, `$file`, refers to the path
    293293         * of the plugin's primary file relative to the plugins directory.
    294294         *
    … …  
    379379     * row of the themes list table.
    380380     *
    381      * The dynamic portion of the hook name, $theme_key, refers to
     381     * The dynamic portion of the hook name, `$theme_key`, refers to
    382382     * the theme slug as found in the WordPress.org themes repository.
    383383     *
Note: See TracChangeset for help on using the changeset viewer.