Changeset 30648 for trunk/src/wp-admin/includes/revision.php

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.

File:

• trunk/src/wp-admin/includes/revision.php (modified) (2 diffs)

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

@@ -59 +59 @@
          * Contextually filter a post revision field.
          *
-         * The dynamic portion of the hook name, $field, corresponds to each of the post
+         * The dynamic portion of the hook name, `$field`, corresponds to each of the post
          * fields of the revision object being iterated over in a foreach statement.
          *
@@ -67 +67 @@
          * @param string  $field                The current revision field.
          * @param WP_Post $compare_from         The revision post object to compare to or from.
-         * @param string  null                  The context of whether the current revision is the old or the new one. Values are 'to' or 'from'.
+         * @param string  null                  The context of whether the current revision is the old
+         *                                      or the new one. Values are 'to' or 'from'.
          */
         $content_from = $compare_from ? apply_filters( "_wp_post_revision_field_$field", $compare_from->$field, $field, $compare_from, 'from' ) : '';