云策 WordPress 开发者社区

钩子文档

pre_{$field}

查看官方原文 ↗
💡 云策文档标注

概述

pre_{$field} 是一个 WordPress 过滤器钩子，用于在保存前修改特定文章字段的值。它仅适用于以 post_ 为前缀的字段名，动态部分 $field 代表字段名称。

关键要点

  • 过滤器名称格式为 pre_{$field}，其中 $field 是文章字段名，例如 pre_post_title、pre_post_content 等。
  • 仅应用于以 post_ 为前缀的字段，如 post_author、post_date 等。
  • 参数 $value 是文章字段的原始值，过滤器可以修改并返回新值。
  • 在 WordPress 2.3.0 版本中引入。

代码示例

$value = apply_filters( "pre_{$field}", $value );

注意事项

  • 相关函数包括 sanitize_post_field()、sanitize_user_field() 和 sanitize_bookmark_field()，用于基于上下文清理字段。
📄 原文内容

Filters the value of a specific post field before saving.

Description

Only applied to post fields with a name which is prefixed with post_.

The dynamic portion of the hook name, $field, refers to the post field name. Possible filter names include:

  • pre_post_author
  • pre_post_date
  • pre_post_date_gmt
  • pre_post_content
  • pre_post_title
  • pre_post_excerpt
  • pre_post_status
  • pre_post_password
  • pre_post_name
  • pre_post_modified
  • pre_post_modified_gmt
  • pre_post_content_filtered
  • pre_post_parent
  • pre_post_type
  • pre_post_mime_type

Parameters

$valuemixed
Value of the post field.

Source

$value = apply_filters( "pre_{$field}", $value );

View all references View on Trac View on GitHub

Used by Description
sanitize_user_field()wp-includes/user.php

Sanitizes user field based on context.
sanitize_post_field()wp-includes/post.php

Sanitizes a post field based on context.
sanitize_bookmark_field()wp-includes/bookmark.php

Sanitizes a bookmark field.

Changelog

Version Description
2.3.0 Introduced.