{"id":37004586,"url":"https://github.com/yardinternet/wp-data","last_synced_at":"2026-01-14T00:38:33.024Z","repository":{"id":327411296,"uuid":"786767316","full_name":"yardinternet/wp-data","owner":"yardinternet","description":null,"archived":false,"fork":false,"pushed_at":"2025-12-05T10:20:17.000Z","size":270,"stargazers_count":0,"open_issues_count":8,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-12-06T17:30:35.297Z","etag":null,"topics":["wordpress"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yardinternet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-04-15T09:08:33.000Z","updated_at":"2025-12-05T10:20:22.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/yardinternet/wp-data","commit_stats":null,"previous_names":["yardinternet/wp-data"],"tags_count":15,"template":false,"template_full_name":"roots/acorn-example-package","purl":"pkg:github/yardinternet/wp-data","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yardinternet%2Fwp-data","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yardinternet%2Fwp-data/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yardinternet%2Fwp-data/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yardinternet%2Fwp-data/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yardinternet","download_url":"https://codeload.github.com/yardinternet/wp-data/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yardinternet%2Fwp-data/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28406520,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-13T21:51:37.118Z","status":"ssl_error","status_checked_at":"2026-01-13T21:45:14.585Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["wordpress"],"created_at":"2026-01-14T00:38:32.251Z","updated_at":"2026-01-14T00:38:32.996Z","avatar_url":"https://github.com/yardinternet.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WP Data Objects\n\n[![Code Style](https://github.com/yardinternet/wp-data/actions/workflows/format-php.yml/badge.svg?no-cache)](https://github.com/yardinternet/wp-data/actions/workflows/format-php.yml)\n[![PHPStan](https://github.com/yardinternet/wp-data/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/wp-data/actions/workflows/phpstan.yml)\n[![Tests](https://github.com/yardinternet/wp-data/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/wp-data/actions/workflows/run-tests.yml)\n[![Code Coverage Badge](https://github.com/yardinternet/wp-data/blob/badges/coverage.svg)](https://github.com/yardinternet/wp-data/actions/workflows/badges.yml)\n[![Lines of Code Badge](https://github.com/yardinternet/wp-data/blob/badges/lines-of-code.svg)](https://github.com/yardinternet/wp-data/actions/workflows/badges.yml)\n\nPowerful data objects for WordPress.\n\n## Requirements\n\n- [Sage](https://github.com/roots/sage) \u003e= 10.0\n- [Acorn](https://github.com/roots/acorn) \u003e= 3.0\n\n## Installation\n\nYou can install this package with Composer:\n\n```bash\ncomposer require yard/data\n```\n\nYou can publish the config file with:\n\n```shell\nwp acorn vendor:publish --provider=\"Yard\\Data\\Providers\\DataServiceProvider\"\n```\n\n## Usage\n\n### PostData\n\n#### Creating PostData\n\nPostData can be created from the global `\\WP_Post` object:\n\n```php\nglobal $post;\n$postData = \\Yard\\Data\\PostData::from($post);\n```\n\nFrom an array:\n\n```php\n$postData = \\Yard\\Data\\PostData::from(\n    [\n        'id' =\u003e 42,\n        'author' =\u003e 1,\n        'title' =\u003e 'Hello, World!',\n        'content' =\u003e 'This is a test post.',\n        'excerpt' =\u003e 'This is a test post.',\n        'status' =\u003e 'publish',\n        'date' =\u003e '2021-01-01 00:00:00',\n        'modified' =\u003e '2021-01-01 00:00:00',\n        'postType' =\u003e 'post',\n        'slug'=\u003e 'hello-world',\n    ]\n);\n```\n\nOr from an Eloquent Model using Corcel:\n\n```php\n$model = \\Corcel\\Model\\Post::find(get_the_ID());\n$postData = \\Yard\\Data\\PostData::from($model);\n```\n\n### Custom PostData\n\nCreating a VacancyData object by extending PostData:\n\n```php\nnamespace App\\Data;\n\nuse Yard\\Data\\PostData;\n\nclass VacancyData extends PostData\n{\n}\n```\n\nEnables you to create VacancyData object in the same way as PostData:\n\n```php\nglobal $post;\n$postData = \\App\\Data\\VacancyData::from($post);\n```\n\n#### Configuring the returning Instance\n\nEvery time you call `Yard\\Data\\PostData::from($post)` you receive an instance of `Yard\\Data\\PostData`.\n\nIf you choose to create a new data class for your custom post type, you can have this class be returned for all instances of that post type.\n\nTo do this, you need to add the Fully Qualified Class Name (FQCN) of your custom data class to the `supports` array when registering your custom post type:\n\n```php\nregister_post_type('vacancy', [\n    'supports' =\u003e [\n        'data-class' =\u003e ['classFQN' =\u003e App\\Data\\KnowledgebaseData::class],\n    ],\n]);\n````\n\nAnother option is to create a mapping in the `config/yard-data.php` file. The mapping in the project config takes precedence over the register_post_type `supports` args.\n\n```php\n'post_types' =\u003e [\n  'vacancy' =\u003e App\\Data\\VacancyData::class,\n  'employee' =\u003e App\\Data\\EmployeeData::class,\n```\n\nNow every time you call `Yard\\Data\\PostData::from($post)` on a custom post type the mapped instance will be returned.\n\n### Meta Fields\n\n#### Using the Meta Attribute\n\nAdding a meta field with a meta_key of `vacancy_email` to your VacancyData looks like this:\n\n```php\nnamespace App\\Data;\n\nuse Yard\\Data\\Attributes\\Meta;\nuse Yard\\Data\\PostData;\n\nclass VacancyData extends PostData\n{\n    #[Meta(metaKey: 'vacancy_email')]\n    public string $email;\n}\n```\n\nThis approach is functionally equivalent to using:\n\n```php\n#[Meta]\npublic string $vacancyEmail;\n```\n\nYou can also specify any available Data Object, and the meta value will be cast to that Data Object:\n\n```php\n#[Meta]\npublic EmployeeData $vacancyEmployee;\n```\n\n#### The MetaPrefix Class Attribute\n\nIf all of your meta fields are prefixed with the same prefix you can use the MetaPrefix attribute:\n\n```php\nnamespace App\\Data;\n\nuse Yard\\Data\\Attributes\\MetaPrefix;\nuse Yard\\Data\\Attributes\\Meta;\nuse Yard\\Data\\PostData;\n\n#[MetaPrefix(prefix: 'vacancy')]\nclass VacancyData extends PostData\n{\n    #[Meta]\n    public string $email;\n}\n```\n\nIt doesn’t matter if your meta keys are in snake_case and your attributes are in camelCase. For instance, let’s say your meta key is `vacancy_members_only`:\n\n```php\n#[MetaPrefix(prefix: 'vacancy')]\nclass VacancyData extends PostData\n{\n    #[Meta]\n    public bool $membersOnly;\n}\n```\n\n### Taxonomy Terms\n\n#### Adding terms to your Data Object\n\nFor every taxonomy that has been registered with your custom post type you can add a Collection of TermData like this:\n\n```php\nnamespace App\\Data;\n\nuse Illuminate\\Support\\Collection;\nuse Yard\\Data\\Attributes\\Terms;\nuse Yard\\Data\\PostData;\n\nclass VacancyData extends PostData\n{\n    #[Terms(taxonomy: 'vacancy_location')]\n    /** @var Collection\u003cint, TermData\u003e */\n    public Collection $locations;\n}\n```\n\nThis approach is functionally equivalent to using:\n\n```php\n#[Terms]\n/** @var Collection\u003cint, TermData\u003e */\npublic Collection $vacancyLocation;\n```\n\nor:\n\n```php\n#[Terms]\n/** @var Collection\u003cint, TermData\u003e */\npublic Collection $vacancyLocations;\n```\n\n#### The TaxonomyPrefix Class Attribute\n\nIf all of your taxonomies are prefixed with the same prefix you can use the TaxonomyPrefix attribute:\n\n```php\nnamespace App\\Data;\n\nuse Illuminate\\Support\\Collection;\nuse Yard\\Data\\Attributes\\TaxonomyPrefix;\nuse Yard\\Data\\Attributes\\Terms;\nuse Yard\\Data\\PostData;\n\n#[TaxonomyPrefix(prefix: 'vacancy')]\nclass VacancyData extends PostData\n{\n    #[Terms]\n    /** @var Collection\u003cint, TermData\u003e */\n    public Collection $locations;\n}\n```\n\n#### Reading Terms from your Data Object\n\nBecause Terms are a [Collection](https://laravel.com/docs/collections) you can use any of the available collection methods to read the terms from your data object. Here are some common examples:\n\n```php\n$vacancyData-\u003elocations-\u003econtains('slug',  'amsterdam'); // true\n$postData-\u003elocations-\u003efirstWhere('slug', 'utrecht')-\u003ename; // Utrecht\n$vacancyData-\u003elocations-\u003eimplode('name', ', '), // Almere, Amsterdam, Utrecht\n```\n\n#### Extending TermData\n\nYou can add extra meta fields to taxonomies by extending the default TermData object\n\n```php\nnamespace App\\Data;\n\nuse Yard\\Data\\TermData;\n\nclass TypeTermData extends TermData {\n\n  #[Meta()]\n  public string $icon;\n}\n\n```\n\nIn your PostData object you have to specify the data class used for a specific taxonomy:\n\n```php\nnamespace App\\Data;\n\nuse Illuminate\\Support\\Collection;\nuse Yard\\Data\\Attributes\\TaxonomyPrefix;\nuse Yard\\Data\\Attributes\\Terms;\nuse Yard\\Data\\PostData;\n\nclass VacancyData extends PostData\n{\n    #[Terms(dataClass: TypeTermData::class)]\n    /** @var Collection\u003cint, TypeTermData\u003e */\n    public Collection $type;\n}\n```\n\n```php\n$vacancyTypeIcon = $vacancyData-\u003etype-\u003efirst()?-\u003eicon;\n```\n\n### UserData\n\nCreate UserData from current user:\n\n```php\n$userData = UserData::from(wp_get_current_user());\n```\n\n## About us\n\n[![banner](https://raw.githubusercontent.com/yardinternet/.github/refs/heads/main/profile/assets/small-banner-github.svg)](https://www.yard.nl/werken-bij/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyardinternet%2Fwp-data","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyardinternet%2Fwp-data","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyardinternet%2Fwp-data/lists"}