Hideokamoto Wordpress Org Knowledges Wordpress Code Reference

WordPress Code Reference Search Skill

This skill enables searching and retrieving information from the WordPress Code Reference.

Available Scripts

search

Search code references by keywords.

python3 search.py "register_post_type" "wp-parser-function" 5

Arguments:

• query (required): Search keywords
• subtypes (optional): Comma-separated list of reference types
• per_page (optional): Number of results (default: 5)

get_content

Retrieve details of a specific code reference entry.

python3 get_content.py wp-parser-function 12345

Arguments:

• subtype (required): Reference type from search results
• id (required): Document ID from search results

Available Code Reference Types

Important Constraint

Code references do not have full content. The get_content script returns:

• excerpt: Description/summary of the function/hook/class/method
• since: WordPress version when this API was introduced
• source_file: Source file path (e.g., wp-includes/post.php)

For full source code, direct the user to the returned URL.

Usage Workflow

Step 1: Search for Code Reference

Run the search script:

python3 search.py "add_action" "wp-parser-function,wp-parser-hook" 5

Output:

[
  {
    "id": 12345,
    "title": "add_action()",
    "url": "https://developer.wordpress.org/reference/functions/add_action/",
    "subtype": "wp-parser-function"
  }
]

Step 2: Get Details

Use the ID and subtype from search results:

python3 get_content.py wp-parser-function 12345

Output:

{
  "id": 12345,
  "title": "add_action()",
  "url": "https://developer.wordpress.org/reference/functions/add_action/",
  "excerpt": "Adds a callback function to an action hook.",
  "since": "1.2.0",
  "source_file": "wp-includes/plugin.php"
}

Search Tips

• Find functions: Use wp-parser-function subtype
• Find hooks (actions/filters): Use wp-parser-hook subtype
• Find classes: Use wp-parser-class subtype
• Find methods: Use wp-parser-method subtype
• Combined search: Specify multiple subtypes (comma-separated)

Example Queries

1. "wp_insert_post function" -> Search wp-parser-function
2. "init action hook" -> Search wp-parser-hook
3. "the_content filter" -> Search wp-parser-hook
4. "WP_Query class" -> Search wp-parser-class
5. "query method" -> Search wp-parser-method

When to Direct Users to URL

Always provide the URL when:

• User needs full parameter documentation
• User wants to see usage examples from core
• User needs return value details
• User wants to see the actual source code

Converted and distributed by TomeVault — claim your Tome and manage your conversions.