WordPress智库主题开发教程手册

https://www.wpzhiku.com/document/
Admin
This manual is a comprehensive guide for WordPress theme development, suitable for beginners and...
Tokens:36,072
Snippets:248
Trust Score:4
Update:1 year ago
Show doc for...
Tokens:
Raw
### WordPress 主题 setup() 函数示例 (PHP)

Source: https://www.wpzhiku.com/document/theme-functions

此代码片段展示了如何在 WordPress 主题的 functions.php 文件中创建一个 setup() 函数，用于设置主题默认值并注册 WordPress 功能。它强调了使用命名空间的重要性，并解释了在 init 钩子之前设置这些函数的重要性，以确保功能的正常运行。

```php
if ( ! function_exists( 'myfirsttheme_setup' ) ) : 
/**
* 设置主题默认值，并注册一些 WordPress 功能
* 在 init 钩子之前设置这些函数非常重要，以确保这些功能不会失效
*  @since MyFirstTheme 1.0
*/
function myfirsttheme_setup() {
// 函数体内容
}
```

--------------------------------

### Example Cron Job Syntax

Source: https://www.wpzhiku.com/document/plugins-cron

This illustrates the basic syntax for a cron job entry. The numbers represent minute, hour, day of the month, month, and day of the week, respectively. An asterisk (*) is used as a wildcard for any value. This example shows how to run a command every 15 minutes, irrespective of the hour, day, or month.

```cron
15 * * * * command
```

--------------------------------

### Object-Oriented Meta Box Implementation (PHP)

Source: https://www.wpzhiku.com/document/plugins-metadata

This example demonstrates adding and managing meta boxes using an object-oriented approach with an abstract class. It encapsulates the logic for adding the meta box, rendering its HTML, and saving its data into static methods, reducing the risk of naming conflicts in the global scope.

```php
abstract class WPOrg_Meta_Box {
   public static function add() {
      $screens = ['post', 'wporg_cpt'];
      foreach ($screens as $screen) {
         add_meta_box(
            'wporg_box_id',          // Unique ID
            'Custom Meta Box Title', // Box title
            [self::class, 'html'],   // Content callback, must be of type callable
            $screen                  // Post type
         );
      }
   }

   public static function save($post_id) {
      if (array_key_exists('wporg_field', $_POST)) {
         update_post_meta(
            $post_id,
            '_wporg_meta_key',
            $_POST['wporg_field']
         );
      }
   }

   public static function html($post) {
      $value = get_post_meta($post->ID, '_wporg_meta_key', true);
      ?>
      <label for=wporg_field>Description for this field</label>
      <select name=wporg_field id=wporg_field class=postbox>
         <option value=>Select something...</option>
         <option value=something <?php selected($value, 'something'); ?>>Something</option>
         <option value=else <?php selected($value, 'else'); ?>>Else</option>
      </select>
      <?php
   }
}

add_action('add_meta_boxes', ['WPOrg_Meta_Box', 'add']);
add_action('save_post', ['WPOrg_Meta_Box', 'save']);
```

--------------------------------

### WordPress Form Submission Example

Source: https://www.wpzhiku.com/document/plugins-settings-options

This snippet demonstrates a basic WordPress form submission, likely for saving settings. It uses the submit_button function, common in WordPress for creating submit buttons within forms. It is enclosed within PHP tags, indicating server-side processing.

```php
submit_button( 'Save Settings' );
?>
</form>
</div>
<?php
}
```

--------------------------------

### WordPress Theme Setup and Defaults (_functions.php_)

Source: https://www.wpzhiku.com/document/theme-functions

This PHP code snippet configures the default settings and functionalities for a WordPress theme. It loads theme text domain for translations, enables automatic feed links, supports post thumbnails and various post formats, and registers custom navigation menus. It is crucial to hook these functions early in the theme's initialization process.

```php
/**
 * 主题功能和定义
 *
 * @package MyFirstTheme
 * @since MyFirstTheme 1.0
 */

/**
 * 首先，工具主题设计和样式设置最大宽度，这将限制上传的文件大小和嵌入内容的宽度
 */
if ( ! isset( $content_width ) )
 $content_width = 800; /* pixels */

if ( ! function_exists( 'myfirsttheme_setup' ) ) :
/**
 * 设置主题默认值，并注册一些 WordPress 功能
 * 在 init 钩子之前设置这些函数非常重要，以确保这些功能不会失效
 */
function myfirsttheme_setup() {

 /**
  * 使主题可翻译，翻译文件在 /languages/ 目录中
  */
 load_theme_textdomain( 'myfirsttheme', get_template_directory() . '/languages' );

 /**
  * 添加默认的文章和评论订阅源到 <head> 中
  */
 add_theme_support( 'automatic-feed-links' );

 /**
  * 添加缩略图和特色图像支持
  */
 add_theme_support( 'post-thumbnails' );

 /**
  * 添加两个自定义菜单
  */
 register_nav_menus( array(
 'primary'   => __( 'Primary Menu', 'myfirsttheme' ),
 'secondary' => __('Secondary Menu', 'myfirsttheme' )
 ) );

 /**
  * 启用下面的文章格式支持：aside, gallery, quote, image, and video
  */
 add_theme_support( 'post-formats', array ( 'aside', 'gallery', 'quote', 'image', 'video' ) );
}
endif; // myfirsttheme_setup
add_action( 'after_setup_theme', 'myfirsttheme_setup' );
```

--------------------------------

### JavaScript Example: Sending Ajax POST Request in WordPress

Source: https://www.wpzhiku.com/document/plugins-javascript-ajax-jquery

This snippet demonstrates a complete jQuery Ajax POST request within a WordPress context. It shows how to use `wp_localize_script` variables for the AJAX URL and nonce, sends data including an action and a dynamic title, and includes a callback function to process the server response. It's wrapped in `jQuery(document).ready()` to ensure the DOM is fully loaded before execution.

```javascript
jQuery(document).ready(function($) {
   $(".pref").change(function() {
      var this2 = this;
      $.post(my_ajax_obj.ajax_url, {
           _ajax_nonce: my_ajax_obj.nonce,
            action: "my_tag_count",
            title: this.value
        }, function(data) {
         this2.nextSibling.remove();
         $(this2).after(data);
      });
    });
});
```

--------------------------------

### Retrieve Specific Header using wp_remote_retrieve_header (PHP)

Source: https://www.wpzhiku.com/document/plugins-http-api

This example illustrates how to get a specific HTTP header value from a response using wp_remote_retrieve_header. It requires the response object and the header name (e.g., 'last-modified'). This is useful for checking metadata like modification times.

```php
$response = wp_remote_get( 'https://api.github.com/users/blobaugh' );
$last_modified = wp_remote_retrieve_header( $response, 'last-modified' );
```

--------------------------------

### WordPress 设置 API：获取选项值（PHP）

Source: https://www.wpzhiku.com/document/plugins-settings-options

使用 `get_option()` 函数从 WordPress 数据库中检索插件设置的值。该函数接受选项名作为参数，并可选择提供一个默认值。

```php
// 获取我们上面使用 register_setting() 注册的选项值
$setting = get_option('wporg_setting_name');

```

--------------------------------

### Caching API Responses with WordPress Transients

Source: https://www.wpzhiku.com/document/plugins-http-api

This section illustrates how to cache external API responses using WordPress's transient API. Caching reduces server load, improves response times, and helps manage API rate limits by storing fetched data locally for a specified duration. The examples show setting, getting, and deleting transient data.

```php
copy($response = wp_remote_get( 'https://api.github.com/users/blobaugh' ));

set_transient( 'blobaugh_github_userinfo', $response, 60*60 );
```

```php
copy($github_userinfo = get_transient( 'blobaugh_github_userinfo' ));

if( false === $github_userinfo ) {
   // 缓存已过期，刷新缓存
   $response = wp_remote_get( 'https://api.github.com/users/blobaugh' );
   set_transient( 'blobaugh_github_userinfo', $response, 60*60 );
}
// Use $github_userinfo as you will
```

```php
copy(delete_transient( 'blobaugh_github_userinfo' ));
```

--------------------------------

### WordPress 选项 API：添加和获取单个选项值（PHP）

Source: https://www.wpzhiku.com/document/plugins-settings-options

使用 WordPress 选项 API 管理插件的键/值对数据。`add_option()` 用于添加新的选项，`get_option()` 用于检索现有选项的值。选项存储在 `{$wpdb->prefix}_options` 数据表中。

```php
<?php
// add a new option
add_option('wporg_custom_option', 'hello world!');
// get an option
$option = get_option('wporg_custom_option');

```

--------------------------------

### WordPress 注册插件简码

Source: https://www.wpzhiku.com/document/plugins-shortcodes

在 WordPress 插件中注册简码，需要推迟到 WordPress 初始化完成后执行。通过 `add_action('init', ...)` 挂载一个函数，该函数负责注册简码。这确保了简码在 WordPress 加载的早期阶段可用，避免了潜在的冲突。

```php
<?php
function wporg_shortcodes_init() {
   function wporg_shortcode($atts = [], $content = null) {
      // do something to $content

      // always return
      return $content;
   }
   add_shortcode('wporg', 'wporg_shortcode');
}
add_action('init', 'wporg_shortcodes_init');
```

--------------------------------

### WordPress 页面分页判断

Source: https://www.wpzhiku.com/document/conditional-tags

提供了两种方法来判断当前页面是否为分页页面。第一种方法通过 $wp_query->get('page') 属性，第二种方法使用 get_query_var('page') 获取 'page' 参数。

```php
<?php
  $paged = $wp_query->get( 'page' );
  if ( ! $paged || $paged < 2 ) {
    // 这不是一个有分页的页面，或是有分页页面中的第一页
   } else {
    // 这是一个有分页的页面
}
?>
```

```php
<?php
    $paged = get_query_var( 'page' ) ? get_query_var( 'page' ) : false;
    if ( $paged == false )  {
    // 这不是一个有分页的页面，或是有分页页面中的第一页
    }  else  {
    // 这是一个有分页的页面
    }
?>
```

--------------------------------

### WordPress 设置 API：注册设置、分节和字段（PHP）

Source: https://www.wpzhiku.com/document/plugins-settings-options

使用 WordPress 设置 API 在管理后台添加自定义设置页面。`register_setting()` 用于注册新设置，`add_settings_section()` 用于创建设置分节，`add_settings_field()` 用于添加表单字段。这些函数应挂载到 `admin_init` 钩子。

```php
<?php
function wporg_settings_init(){
   // 为 阅读 页面注册新设置
   register_setting('reading', 'wporg_setting_name');

   // 在阅读页面上注册新分节
   add_settings_section(
      'wporg_settings_section',
      'WPOrg Settings Section',
      'wporg_settings_section_cb',
      'reading'
   );

   // 阅读页面中，在 the wporg_settings_section 分节上注册新设置
   add_settings_field(
      'wporg_settings_field',
      'WPOrg Setting',
      'wporg_settings_field_cb',
      'reading',
      'wporg_settings_section'
   );
}
 
/**
 * 注册 wporg_settings_init 到 admin_init Action 钩子
 */
add_action('admin_init', 'wporg_settings_init');
 

/**
 * 回调函数
 */
// 分节内容回调
function wporg_settings_section_cb() {
   echo '<p>WPOrg Section Introduction.</p>';
}
 
// 字段内容回调
function wporg_settings_field_cb() {
   // 获取我们使用 register_setting() 注册的字段的值
   $setting = get_option('wporg_setting_name');
   // 输出字段
   ?>
   <input type=text name=wporg_setting_name value=<?php echo isset( $setting ) ? esc_attr( $setting ) : ''; ?>>
   <?php
}

```

--------------------------------

### Get Role Object - PHP

Source: https://www.wpzhiku.com/document/plugins-users-roles-capabilities

This PHP snippet shows the usage of the `get_role()` function in WordPress. This function retrieves a role object based on its slug, allowing access to all its associated capabilities.

```php
get_role(
   string $role
);
```

--------------------------------

### 检查本地文件状态

Source: https://www.wpzhiku.com/document/plugins-publish-to-wordpress-org

查看本地 SVN 副本中文件的状态，识别哪些文件已被修改、添加或删除，与中央仓库进行对比。

```bash
svn stat
```

--------------------------------

### Get All Post Custom Data (PHP)

Source: https://www.wpzhiku.com/document/plugins-metadata

This PHP code shows how to retrieve all metadata associated with a specific post using the `get_post_custom()` function. It takes the post ID as an argument and returns an associative array of all meta keys and their values for that post.

```php
get_post_custom(
   int $post_id
);
```

```php
$meta_array = get_post_custom(get_the_ID());
```

--------------------------------

### 远程复制标记新版本

Source: https://www.wpzhiku.com/document/plugins-publish-to-wordpress-org

使用远程 URL 来复制 `trunk` 到 `tags` 目录，以节省带宽和时间，尤其适用于大型插件。

```bash
svn cp https://plugins.svn.wordpress.org/your-plugin-name/trunk https://plugins.svn.wordpress.org/your-plugin-name/tags/2.0
```

--------------------------------

### Complete Echo Ajax Handler in WordPress

Source: https://www.wpzhiku.com/document/plugins-javascript-ajax-jquery

An example of a WordPress Ajax handler that performs nonce verification, updates user meta, queries posts by tag, and then echoes a string response. It manually calls `wp_die()` to terminate the script after sending the response.

```php
<?php
function my_ajax_handler() {
   check_ajax_referer( 'title_example' );
   update_user_meta( get_current_user_id(), 'title_preference', $_POST['title'] );
   $args = array(
      'tag' => $_POST['title'],
   );
   $the_query = new WP_Query( $args );
   echo $_POST['title'].' ('.$the_query->post_count.') ';
   wp_die(); // All ajax handlers should die when finished
}
?>
```

--------------------------------

### 注册插件激活钩子

Source: https://www.wpzhiku.com/document/wordpress-plugin-basics

此代码片段演示了如何使用 `register_activation_hook()` 函数将一个函数挂载到插件激活事件。当插件被激活时，指定的函数 `pluginprefix_function_to_run` 将被调用。

```php
register_activation_hook( __FILE__, 'pluginprefix_function_to_run' );
```

--------------------------------

### WordPress 插件基础类注册

Source: https://www.wpzhiku.com/document/wordpress-plugin-basics

这是一个基础的 WordPress 插件类示例，展示了如何使用 `register_setting` 注册设置以及 `get_option` 获取选项。它包含了插件的初始化和数据获取方法。

```php
<?php
if ( !class_exists( 'WPOrg_Plugin' ) ) {
    class WPOrg_Plugin
    {
        public static function init() {
            register_setting( 'wporg_settings', 'wporg_option_foo' );
        }
 
        public static function get_foo() {
            return get_option( 'wporg_option_foo' );
        }
    }
 
    WPOrg_Plugin::init();
    WPOrg_Plugin::get_foo();
}

```

--------------------------------

### Complete JSON Ajax Handler in WordPress

Source: https://www.wpzhiku.com/document/plugins-javascript-ajax-jquery

A comprehensive example of a WordPress Ajax handler that verifies the nonce, updates user meta, performs a post query by tag, and sends a JSON response back to the client. It utilizes `wp_send_json` for structured JSON output.

```php
<?php
function my_ajax_handler() {
   check_ajax_referer( 'title_example' );
   update_user_meta( get_current_user_id(), 'title_preference', $_POST['title'] );
   $args = array(
      'tag' => $_POST['title'],
   );
   $the_query = new WP_Query( $args );
   wp_send_json( $_POST['title'] . ' (' . $the_query->post_count . ') ' );
}
?>
```

--------------------------------

### Sending Custom HTTP Requests with wp_remote_request

Source: https://www.wpzhiku.com/document/plugins-http-api

This function allows for sending HTTP requests with custom methods, such as DELETE. It takes arguments similar to wp_remote_get, providing flexibility for various API interactions. The example shows how to send a DELETE request to a specified API endpoint.

```php
copy($args = array(
   'method' => 'DELETE'
));
$response = wp_remote_request( 'http://some-api.com/object/to/delete', $args );
```

--------------------------------

### WordPress 插件创建和基础注释 - Bash

Source: https://www.wpzhiku.com/document/wordpress-plugin-basics

演示了在类 Unix 系统上，使用命令行创建WordPress插件目录和PHP文件，并展示了插件头注释的基本格式。需要用户根据实际情况替换'plugin-name'和'YOUR PLUGIN NAME'。

```bash
cd wp-content/plugins
mkdir plugin-name
cd plugin-name
vi plugin-name.php
```

--------------------------------

### 使用get_template_part()调用WordPress模板片段

Source: https://www.wpzhiku.com/document/linking-theme-files-directories

使用get_template_part()函数在WordPress主题的任何位置调用模板文件片段。您可以指定一个基础模板文件（如content.php）和一个自定义的后缀（如product）来加载特定的模板部分（如content-product.php）。

```php
get_template_part( 'content', 'product' );
```

--------------------------------

### 提交插件代码到 SVN 仓库

Source: https://www.wpzhiku.com/document/plugins-publish-to-wordpress-org

将本地的更改（新添加的文件或修改的文件）提交到 SVN 中央仓库。提交时需要提供一个清晰的提交信息。

```bash
svn ci -m 'Adding first version of my plugin'
```

--------------------------------

### Checking Resource Status with HEAD Request

Source: https://www.wpzhiku.com/document/plugins-http-api

This snippet demonstrates how to use wp_remote_head to check the status of a resource before making a full GET request. This is crucial for managing bandwidth and respecting API rate limits, especially on high-traffic APIs. It helps determine if data has been updated and if caching is appropriate.

```php
copy($response = wp_remote_head( 'https://api.github.com/users/blobaugh' ));
```

--------------------------------

### 添加插件文件到 SVN

Source: https://www.wpzhiku.com/document/plugins-publish-to-wordpress-org

将本地插件文件添加到 SVN 仓库的 trunk 目录中，并使用 `svn add` 命令让 SVN 跟踪这些新文件。

```bash
svn add trunk/*
```

--------------------------------

### Get Specific Post Meta Value (PHP)

Source: https://www.wpzhiku.com/document/plugins-metadata

This PHP code demonstrates how to retrieve a specific meta value for a given post using the `get_post_meta()` function. It requires the post ID and the meta key as arguments. The `single` parameter controls whether to return a single value or an array of values.

```php
get_post_meta(
   int $post_id,
   string $key = '',
   bool $single = false
);
```

```php
$wporg_meta_value = get_post_meta(get_the_ID(), 'wporg_meta_key');
```

--------------------------------

### 生成 WordPress 插件 POT 文件 (CLI)

Source: https://www.wpzhiku.com/document/plugins-internationalization-localization

使用 `makepot.php` 脚本在命令行中为 WordPress 插件生成 POT 文件。此方法适用于插件未托管在 WordPress.org 插件目录的情况，需要 PHP 和 gettext 工具。

```shell
cd plugin-name/languages
php path/to/makepot.php wp-plugin path/to/your-plugin-directory
```

--------------------------------

### 查看本地文件更改差异

Source: https://www.wpzhiku.com/document/plugins-publish-to-wordpress-org

显示本地副本与中央 SVN 仓库之间所有未提交的更改内容，方便开发者审查修改。

```bash
svn diff
```

--------------------------------

### PHP: Custom HTML Sanitization with wp_kses

Source: https://www.wpzhiku.com/document/plugins-security

This PHP example illustrates custom HTML sanitization using the WordPress wp_kses() function. It defines an array of allowed HTML elements and their attributes ('a', 'br', 'em', 'strong') to control the structure and safety of user-generated content before it's displayed, preventing malicious HTML or script injection.

```php
$allowed_html = [
    'a'      => [
        'href'  => [],
        'title' => [],
    ],
    'br'     => [],
    'em'     => [],
    'strong' => [],
];
echo wp_kses( $custom_content, $allowed_html );
```

--------------------------------

### WordPress Action 钩子基础用法 (PHP)

Source: https://www.wpzhiku.com/document/plugins-hooks

演示如何使用 `add_action` 函数将自定义回调函数挂载到 WordPress 的 'init' 钩子。这允许在 WordPress 初始化时执行特定操作。默认优先级为 10，接受的参数数量为 0。

```PHP
function wporg_custom() {
    // 执行某些操作
}
```

```PHP
add_action('init', 'wporg_custom');
```

--------------------------------

### JavaScript: Example Ajax Data Structure for WordPress

Source: https://www.wpzhiku.com/document/plugins-javascript-ajax-jquery

This JavaScript object illustrates the data structure expected by WordPress Ajax handlers. It includes `_ajax_nonce` for security verification, `action` to identify the specific Ajax hook to trigger on the server-side, and other custom data fields like `title` which are specific to the operation being performed.

```javascript
{
  _ajax_nonce: my_ajax_obj.nonce,
  action: "my_tag_count",
  title: this.value
}
```

--------------------------------

### Send Data via POST Request using wp_remote_post (PHP)

Source: https://www.wpzhiku.com/document/plugins-http-api

This example shows how to send data to an API endpoint using wp_remote_post. It involves constructing an associative array for the 'body' parameter and an optional arguments array for settings like timeout and headers. The data in the 'body' will be available in the $_POST superglobal on the server.

```php
$body = array(
   'name' => 'Jane Smith',
   'email' => 'some@email.com',
   'subject' => 'Checkout this API stuff',
   'comment' => 'I just read a great tutorial by this Ben Lobaugh. It taught me amazing things about interacting with APIs in WordPress! You gotta check it out!'
);

$args = array(
   'body' => $body,
   'timeout' => '5',
   'redirection' => '5',
   'httpversion' => '1.0',
   'blocking' => true,
   'headers' => array(),
   'cookies' => array()
);

$response = wp_remote_post( 'http://your-contact-form.com', $args );
```

--------------------------------

### 标记插件的新版本

Source: https://www.wpzhiku.com/document/plugins-publish-to-wordpress-org

在 SVN 仓库的 `tags` 目录中为插件的发布版本创建一个新的标签。这通常通过 `svn cp` 命令完成，以版本号命名子目录。

```bash
svn cp trunk tags/2.0
```

--------------------------------

### PHP: Sanitize Text Input with sanitize_text_field

Source: https://www.wpzhiku.com/document/plugins-security

This example shows how to sanitize text input from a form field named 'title' using the WordPress sanitize_text_field() function. This function cleans invalid UTF-8 characters, converts special characters to entities, removes HTML tags, whitespace, and 8-byte characters, making the data safe for database storage.

```php
$title = sanitize_text_field($_POST['title']);
update_post_meta($post->ID, 'title', $title);
```

--------------------------------

### WordPress 插件开发：添加顶级管理菜单

Source: https://www.wpzhiku.com/document/plugins-administration-menus

使用 `add_menu_page()` 函数在 WordPress 后台添加一个自定义的顶级管理菜单。此函数允许指定菜单标题、用户权限、菜单标识符、回调函数、图标和位置。通常与 `admin_menu` 动作钩子一起使用。

```php
<?php
add_menu_page(
   'WPOrg',
   'WPOrg Options',
   'manage_options',
   'wporg',
   'wporg_options_page_html',
   plugin_dir_url(__FILE__) . 'images/icon_wporg.png',
   20
);
add_action('admin_menu', 'wporg_options_page');

function wporg_options_page_html() {
   // check user capabilities
   if (!current_user_can('manage_options')) {
      return;
   }
   ?>
    <div class=wrap>
        <h1><?= esc_html(get_admin_page_title()); ?></h1>
        <form action=options.php method=post>
         <?php
         // output security fields for the registered setting wporg_options
         settings_fields('wporg_options');
         // output setting sections and their fields
         // (sections are registered for wporg, each field is registered to a specific section)
         do_settings_sections('wporg');
         // output save settings button
         submit_button('Save Settings');
         ?>
        </form>
    </div>
   <?php
}

```

--------------------------------

### 创建新的 SVN 仓库副本

Source: https://www.wpzhiku.com/document/plugins-publish-to-wordpress-org

在本地机器上创建 SVN 仓库的副本，为开始新的插件开发做准备。这会检出 WordPress.org SVN 仓库中的标准目录结构。

```bash
mkdir my-local-dir
svn co https://plugins.svn.wordpress.org/your-plugin-name my-local-dir
cd my-local-dir
```

--------------------------------

### 调用WordPress模板片段（包含子目录）

Source: https://www.wpzhiku.com/document/linking-theme-files-directories

当模板文件片段被组织在子目录中时，使用get_template_part()函数调用它们。通过在'slug'参数中包含子目录路径，您可以加载位于特定文件夹内的模板文件。

```php
get_template_part( 'content-templates/content', 'location' );
get_template_part( 'content-templates/content', 'product' );
get_template_part( 'content-templates/content', 'profile' );
```

--------------------------------

### 创建可扩展的 Action：在设置表单中添加自定义选项

Source: https://www.wpzhiku.com/document/plugins-hooks

演示如何创建一个自定义 Action（'wporg_after_settings_page_html'），允许其他插件开发者在主插件的设置表单后添加自定义的设置字段。

```php
function wporg_settings_page_html()
{
   ?>
    Foo: <input id=foo name=foo type=text>
    Bar: <input id=bar name=bar type=text>
   <?php
   do_action('wporg_after_settings_page_html');
}
```

```php
function myprefix_add_settings()
{
   ?>
    New 1: <input id=new_setting name=new_settings type=text>
   <?php
}
add_action('wporg_after_settings_page_html', 'myprefix_add_settings');
```

--------------------------------

### 使用 'all' 钩子进行调试

Source: https://www.wpzhiku.com/document/plugins-hooks

通过将回调函数挂载到 'all' 钩子，可以使其在每一个 Action 钩子触发时都被调用。这个技巧在调试 WordPress 插件和主题时非常有用，可以帮助开发者追踪事件的发生顺序和定位问题。

```php
function debug_all_actions() {
    // Log or inspect the current action
    error_log('Action triggered: ' . current_action());
}
add_action('all', 'debug_all_actions');
```

--------------------------------

### 更新本地 SVN 副本

Source: https://www.wpzhiku.com/document/plugins-publish-to-wordpress-org

从 SVN 中央仓库获取最新的代码更改并合并到本地副本中，确保本地代码与远程仓库同步。

```bash
svn up
```

--------------------------------

### WordPress 插件开发：添加子管理菜单

Source: https://www.wpzhiku.com/document/plugins-administration-menus

使用 `add_submenu_page()` 函数在 WordPress 后台添加一个自定义的子管理菜单。此函数允许指定父菜单的标识符、页面标题、菜单标题、用户权限、菜单标识符和回调函数。常用于将插件设置页面添加到现有菜单项下。

```php
<?php
add_submenu_page(
   string $parent_slug,
    string $page_title,
    string $menu_title,
    string $capability,
    string $menu_slug,
    callable $function = ''
);

```

--------------------------------

### 创建 WordPress 用户 (PHP)

Source: https://www.wpzhiku.com/document/plugins-users-roles-capabilities

使用 `wp_create_user()` 函数创建新用户。此函数接受用户名、密码和电子邮件地址作为参数。它会自动处理参数转义和用户数据插入到数据库。适用于快速创建单个用户。

```php
/**
 * Creates a new WordPress user.
 *
 * @param string $username The username for the new user.
 * @param string $password The password for the new user.
 * @param string $email    The email address for the new user.
 * @return int|WP_Error The new user's ID on success, or a WP_Error object on failure.
 */
function create_wordpress_user(string $username, string $password, string $email = ''):
 int|WP_Error
{
    return wp_create_user($username, $password, $email);
}

```

--------------------------------

### WordPress 处理带参数的简码

Source: https://www.wpzhiku.com/document/plugins-shortcodes

简码可以接受属性（参数）来定制其行为和输出。简码回调函数可以接收三个参数：`$atts`（属性数组）、`$content`（包含的内容）和 `$tag`（简码标签名）。开发者可以解析 `$atts` 数组来获取和使用用户提供的参数。

```php
<?php
function wporg_shortcode($atts = [], $content = null, $tag = '') {
   // Process attributes from $atts
   // Process content from $content
   // Process tag name from $tag
}
```

--------------------------------

### WordPress Action 钩子优先级与参数 (PHP)

Source: https://www.wpzhiku.com/document/plugins-hooks

展示了如何使用 `add_action` 函数指定回调函数的执行优先级（$priority）和接受的参数数量（$accepted_args）。优先级数字越小，执行越早。参数数量决定了回调函数可以接收多少由钩子传递的数据。

```PHP
add_action('init', 'run_me_early', 9);
add_action('init', 'run_me_normal'); // 默认优先级为 10
add_action('init', 'run_me_late', 11);
```

```PHP
function wporg_custom($post_id, $post){
    // 执行某些操作，接收文章 ID 和文章对象
}
```

```PHP
add_action('save_post', 'wporg_custom', 10, 2);
```

--------------------------------

### 调用自定义WordPress页眉、页脚、侧边栏

Source: https://www.wpzhiku.com/document/linking-theme-files-directories

使用自定义模板名称调用WordPress主题的页眉、页脚和侧边栏的自定义版本。这允许您为特定模板提供不同的头部、底部或侧边栏内容。

```php
get_header( 'your_custom_template' );
get_footer( 'your_custom_template' );
get_sidebar( 'your_custom_template' );
```

--------------------------------

### 示例：插件激活时注册自定义文章类型和刷新固定链接

Source: https://www.wpzhiku.com/document/wordpress-plugin-basics

这个示例展示了在插件激活时执行的常见操作：注册一个自定义文章类型（'book'）并刷新 WordPress 的固定链接缓存，以防止激活后出现 404 错误。它结合了 `init` 动作和 `register_activation_hook`。

```php
function pluginprefix_setup_post_type() {
    // 注册 book 自定义文章类型
    register_post_type( 'book', ['public' => 'true'] );
}
add_action( 'init', 'pluginprefix_setup_post_type' );
 
function pluginprefix_install() {
    // 触发注册自定义文章类型操作
    pluginprefix_setup_post_type();

    // 注册文章类型之后，刷新固定链接缓存
    flush_rewrite_rules();
}
register_activation_hook( __FILE__, 'pluginprefix_install' );
```

--------------------------------

### 创建 WPOrg 设置页面 HTML

Source: https://www.wpzhiku.com/document/plugins-administration-menus

此函数生成用于 'WPOrg 设置' 页面的 HTML。它包含安全检查，并使用 WordPress 设置 API 显示注册的选项。建议将内容包裹在 DIV 中。

```php
<?php
function wporg_options_page_html() {
   // check user capabilities
   if (!current_user_can('manage_options')) {
      return;
   }
   ?>
    <div class=wrap>
        <h1><?= esc_html(get_admin_page_title()); ?></h1>
        <form action=options.php method=post>
         <?php
         // output security fields for the registered setting wporg_options
         settings_fields('wporg_options');
         // output setting sections and their fields
         // (sections are registered for wporg, each field is registered to a specific section)
         do_settings_sections('wporg');
         // output save settings button
         submit_button('Save Settings');
         ?>
        </form>
    </div>
   <?php
}

```

--------------------------------

### WordPress 插件按需加载管理代码

Source: https://www.wpzhiku.com/document/wordpress-plugin-basics

该代码片段演示了如何使用 WordPress 的 `is_admin()` 条件函数来按需加载插件的特定文件，例如管理后台的插件文件。这有助于优化插件性能，只在需要时加载相关代码。

```php
<?php
if ( is_admin() ) {
    // we are in admin mode
    require_once( dirname( __FILE__ ) . '/admin/plugin-name-admin.php' );
}

```

--------------------------------

### 将 WPOrg 设置页面挂载到 Admin Menu

Source: https://www.wpzhiku.com/document/plugins-administration-menus

此函数将 'WPOrg 设置' 子菜单添加到 WordPress 管理菜单中。它使用 `add_submenu_page` 函数，并将其挂载到 'admin_menu' 动作钩子上。

```php
<?php
function wporg_options_page() {
   add_submenu_page(
      'tools.php',
      'WPOrg Options',
      'WPOrg Options',
      'manage_options',
      'wporg',
      'wporg_options_page_html'
   );
}
add_action('admin_menu', 'wporg_options_page');

```

--------------------------------

### WordPress 插件头注释与许可证结合

Source: https://www.wpzhiku.com/document/wordpress-plugin-basics

此示例展示了如何将标准的 WordPress 插件头注释与许可证信息结合起来。它包含了插件元数据（如名称、URI、描述、版本、作者等）以及 GPL 许可证的详细说明。

```php
<?php
/*
Plugin Name: WordPress.org Plugin
Plugin URI:  https://developer.wordpress.org/plugins/the-basics/
Description: Basic WordPress Plugin Header Comment
Version:     20160911
Author:      WordPress.org
Author URI:  https://developer.wordpress.org/
Text Domain: wporg
Domain Path: /languages
License:     GPL2
 
{Plugin Name} is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
any later version.
 
{Plugin Name} is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with {Plugin Name}. If not, see {License URI}.
*/
```

--------------------------------

### WordPress主题文件夹和文件结构示例

Source: https://www.wpzhiku.com/document/basics

展示了WordPress主题中推荐的文件夹和文件组织方式，包括assets（CSS, images, JS）、inc、template-parts（footer, header, navigation, page, post）等目录的划分，以及根目录下的核心模板文件（404.php, archive.php, footer.php, header.php, index.php, page.php, single.php, style.css等）。

```php
assets (dir)
      - css (dir)
      - images (dir)
      - js (dir)
inc (dir)
template-parts (dir)
      - footer (dir)
      - header (dir)
      - navigation (dir)
      - page (dir)
      - post (dir)
404.php
archive.php
comments.php
footer.php
front-page.php
functions.php
header.php
index.php
page.php
README.txt
rtl.css
screenshot.png
search.php
searchform.php
sidebar.php
single.php
style.css
```

--------------------------------

### 插入 WordPress 用户 (PHP)

Source: https://www.wpzhiku.com/document/plugins-users-roles-capabilities

使用 `wp_insert_user()` 函数插入用户数据。此函数接受一个包含用户属性的数组或对象。它提供了钩子（如 `user_register` 和 `profile_update`）用于在用户创建或更新时执行自定义逻辑。适用于需要更精细控制用户数据的场景。

```php
/**
 * Inserts a WordPress user.
 *
 * @param array|object|WP_User $userdata An array or object containing user data.
 * @return int|WP_Error The new user's ID on success, or a WP_Error object on failure.
 */
function insert_wordpress_user(array|object|WP_User $userdata):
 int|WP_Error
{
    return wp_insert_user($userdata);
}

```

--------------------------------

### 使用 register_uninstall_hook 注册卸载函数

Source: https://www.wpzhiku.com/document/wordpress-plugin-basics

此代码片段展示了如何使用 `register_uninstall_hook()` 函数来指定一个在用户卸载插件时运行的函数。这对于清理插件创建的数据库设置或缓存文件非常有用。

```php
register_uninstall_hook(__FILE__, 'pluginprefix_function_to_run');
```

--------------------------------

### 获取父WordPress主题目录中文件的路径

Source: https://www.wpzhiku.com/document/linking-theme-files-directories

在子主题中，使用get_parent_theme_file_path()函数获取父主题目录中文件的文件系统路径。这对于在子主题中操作父主题中的文件非常有用。

```php
echo get_parent_theme_file_path( 'images/logo.png' );
```

--------------------------------

### WordPress 自定义 Action 钩子创建与使用 (PHP)

Source: https://www.wpzhiku.com/document/plugins-hooks

展示了如何使用 `do_action()` 创建一个自定义 Action 钩子，并使用 `add_action()` 将回调函数挂载到这个自定义钩子上。这使得插件的功能可以被其他开发者扩展。

```PHP
// 在插件代码中创建自定义钩子
do_action('my_custom_action');
```

```PHP
// 其他开发者挂载回调函数
function my_callback_function() {
    // 我的自定义操作
}
add_action('my_custom_action', 'my_callback_function');
```

--------------------------------

### 注册插件禁用钩子

Source: https://www.wpzhiku.com/document/wordpress-plugin-basics

此代码片段展示了如何使用 `register_deactivation_hook()` 函数将一个函数挂载到插件禁用事件。当插件被禁用时，指定的函数 `pluginprefix_function_to_run` 将被调用。

```php
register_deactivation_hook( __FILE__, 'pluginprefix_function_to_run' );
```

--------------------------------

### 使用上下文消除字符串歧义 (PHP)

Source: https://www.wpzhiku.com/document/plugins-internationalization-localization

当同一个字符串在不同语境下有不同含义时，使用 `_x()` 或 `_ex()` 函数，并提供一个上下文参数。这有助于翻译人员理解并提供准确的翻译。

```php
// 使用 _x() 函数，并提供 'noun' 和 'verb' 作为上下文
_x( 'Post', 'noun', 'my-plugin' );
_x( 'Post', 'verb', 'my-plugin' );

// 使用 _ex() 函数直接输出，效果同上
_ex( 'Post', 'noun', 'my-plugin' );
_ex( 'Post', 'verb', 'my-plugin' );
```

--------------------------------

### 避免命名冲突：检查函数是否存在

Source: https://www.wpzhiku.com/document/wordpress-plugin-basics

这段 PHP 代码演示了如何通过检查函数是否已存在来避免命名冲突。在定义新函数（如 `wporg_init` 和 `wporg_get_foo`）之前，使用 `!function_exists()` 确保不会覆盖其他插件或主题中已有的同名函数。

```php
<?php
//Create a function called wporg_init if it doesn't already exist
if ( !function_exists( 'wporg_init' ) ) {
    function wporg_init() {
        register_setting( 'wporg_settings', 'wporg_option_foo' );
    }
}
 
//Create a function called wporg_get_foo if it doesn't already exist
if ( !function_exists( 'wporg_get_foo' ) ) {
    function wporg_get_foo() {
        return get_option( 'wporg_option_foo' );
    }
}
```

--------------------------------

### WordPress 注册自定义分类法 (PHP)

Source: https://www.wpzhiku.com/document/plugins-taxonomies

此代码片段演示了如何使用 `register_taxonomy()` 函数在WordPress中创建一个自定义分类法。它定义了分类法的标签和参数，并将其附加到'post'文章类型。该代码通过`init`动作钩子执行。

```php
/*
* Plugin Name: Course Taxonomy
* Description: A short example showing how to add a taxonomy called Course.
* Version: 1.0
* Author: developer.wordpress.org
* Author URI: https://codex.wordpress.org/User:Aternus
*/

function wporg_register_taxonomy_course() {
   $labels = [
      'name'              => _x( 'Courses', 'taxonomy general name' ),
      'singular_name'     => _x( 'Course', 'taxonomy singular name' ),
      'search_items'      => __( 'Search Courses' ),
      'all_items'         => __( 'All Courses' ),
      'parent_item'       => __( 'Parent Course' ),
      'parent_item_colon' => __( 'Parent Course:' ),
      'edit_item'         => __( 'Edit Course' ),
      'update_item'       => __( 'Update Course' ),
      'add_new_item'      => __( 'Add New Course' ),
      'new_item_name'     => __( 'New Course Name' ),
      'menu_name'         => __( 'Course' ),
   ];
   $args   = [
      'hierarchical'      => true, // make it hierarchical (like categories)
      'labels'            => $labels,
      'show_ui'           => true,
      'show_admin_column' => true,
      'query_var'         => true,
      'rewrite'           => [ 'slug' => 'course' ],
   ];
   register_taxonomy( 'course', [ 'post' ], $args );
}

add_action( 'init', 'wporg_register_taxonomy_course' );
```

--------------------------------

### WordPress 模板中集成文章循环

Source: https://www.wpzhiku.com/document/theme-loop

此代码示例展示了如何在WordPress模板文件（如`index.php`）中正确集成文章循环。它包含了`get_header()`调用，并在循环前后添加了必要的条件判断和结束标签，确保在显示文章内容前正确加载页眉。

```php
<?php 
get_header();

// 循环代码从这里开始
if ( have_posts() ) : 
    while ( have_posts() ) : the_post(); 
        // 显示文章内容
    endwhile;
endif; 
?>
```

--------------------------------

### 获取WordPress主题目录中文件的路径

Source: https://www.wpzhiku.com/document/linking-theme-files-directories

使用get_theme_file_path()函数获取WordPress主题目录中文件的文件系统路径。此函数适用于WordPress 4.7及更高版本，并优先返回子主题中的文件路径，如果不存在则返回父主题中的路径。

```php
echo get_theme_file_path( 'images/logo.png' );
```

--------------------------------

### WordPress旧版本主题文件URI和路径函数

Source: https://www.wpzhiku.com/document/linking-theme-files-directories

对于WordPress 4.7之前的版本，使用get_template_directory_uri()和get_template_directory()获取主题目录的URI和路径。get_stylesheet_directory_uri()和get_stylesheet_directory()用于获取当前活动主题（包括子主题）的URI和路径。

```php
// For older versions of WordPress
get_template_directory_uri();
get_template_directory();
get_stylesheet_directory_uri();
get_stylesheet_directory();
```

--------------------------------

### 创建 WordPress 用户示例 (PHP)

Source: https://www.wpzhiku.com/document/plugins-users-roles-capabilities

此示例演示了如何使用 `username_exists()` 和 `email_exists()` 检查用户名和电子邮件的可用性，然后使用 `wp_generate_password()` 生成一个随机密码，最后通过 `wp_create_user()` 创建新用户。这是一个更健壮的用户创建方法。

```php
// check if the username is taken
$user_id = username_exists($user_name);

// check that the email address does not belong to a registered user
if (!$user_id && email_exists($user_email) === false) {
   // create a random password
   $random_password = wp_generate_password(
      $length = 12,
      $include_standard_special_chars = false
   );
   // create the user
   $user_id = wp_create_user(
      $user_name,
      $random_password,
      $user_email
   );
}

```
Tokens:
Raw
WordPress智库 主题开发教程手册

WordPress智库主题开发教程手册
